class SAR extends Estimator[SARModel] with SARParams with DefaultParamsWritable with BasicLogging

Smart Adaptive Recommendations (SAR) Algorithm

https://aka.ms/reco-sar

SAR is a fast scalable adaptive algorithm for personalized recommendations based on user transactions history and items description. It produces easily explainable / interpretable recommendations

SAR has been show to provide higher ranking measurements when compared to ALS. https://github.com/Microsoft/Recommenders

Linear Supertypes
BasicLogging, DefaultParamsWritable, MLWritable, SARParams, RecommendationParams, ALSParams, HasSeed, HasCheckpointInterval, HasRegParam, HasMaxIter, ALSModelParams, HasBlockSize, HasPredictionCol, Wrappable, RWrappable, PythonWrappable, BaseWrappable, Estimator[SARModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SAR
  2. BasicLogging
  3. DefaultParamsWritable
  4. MLWritable
  5. SARParams
  6. RecommendationParams
  7. ALSParams
  8. HasSeed
  9. HasCheckpointInterval
  10. HasRegParam
  11. HasMaxIter
  12. ALSModelParams
  13. HasBlockSize
  14. HasPredictionCol
  15. Wrappable
  16. RWrappable
  17. PythonWrappable
  18. BaseWrappable
  19. Estimator
  20. PipelineStage
  21. Logging
  22. Params
  23. Serializable
  24. Serializable
  25. Identifiable
  26. AnyRef
  27. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SAR()
  2. new SAR(uid: String)

    uid

    The id of the module

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val activityTimeFormat: Param[String]
    Definition Classes
    SARParams
  6. val alpha: DoubleParam
    Definition Classes
    ALSParams
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final val blockSize: IntParam
    Definition Classes
    HasBlockSize
  9. val checkedCast: UserDefinedFunction
    Attributes
    protected[org.apache.spark.ml.recommendation]
    Definition Classes
    ALSModelParams
  10. final val checkpointInterval: IntParam
    Definition Classes
    HasCheckpointInterval
  11. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  12. final def clear(param: Param[_]): SAR.this.type
    Definition Classes
    Params
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. val coldStartStrategy: Param[String]
    Definition Classes
    ALSModelParams
  15. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  16. def copy(extra: ParamMap): SAR
    Definition Classes
    SAR → Estimator → PipelineStage → Params
  17. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  18. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  22. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  23. def explainParams(): String
    Definition Classes
    Params
  24. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  25. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  26. val finalStorageLevel: Param[String]
    Definition Classes
    ALSParams
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def fit(dataset: Dataset[_]): SARModel
    Definition Classes
    SAR → Estimator
  29. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[SARModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  30. def fit(dataset: Dataset[_], paramMap: ParamMap): SARModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  31. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SARModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  32. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  33. def getActivityTimeFormat: String

  34. def getAlpha: Double
    Definition Classes
    ALSParams
  35. final def getBlockSize: Int
    Definition Classes
    HasBlockSize
  36. final def getCheckpointInterval: Int
    Definition Classes
    HasCheckpointInterval
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. def getColdStartStrategy: String
    Definition Classes
    ALSModelParams
  39. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  40. def getFinalStorageLevel: String
    Definition Classes
    ALSParams
  41. def getImplicitPrefs: Boolean
    Definition Classes
    ALSParams
  42. def getIntermediateStorageLevel: String
    Definition Classes
    ALSParams
  43. def getItemCol: String
    Definition Classes
    ALSModelParams
  44. final def getMaxIter: Int
    Definition Classes
    HasMaxIter
  45. def getNonnegative: Boolean
    Definition Classes
    ALSParams
  46. def getNumItemBlocks: Int
    Definition Classes
    ALSParams
  47. def getNumUserBlocks: Int
    Definition Classes
    ALSParams
  48. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  49. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  50. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  51. def getRank: Int
    Definition Classes
    ALSParams
  52. def getRatingCol: String
    Definition Classes
    ALSParams
  53. final def getRegParam: Double
    Definition Classes
    HasRegParam
  54. final def getSeed: Long
    Definition Classes
    HasSeed
  55. def getSimilarityFunction: String

  56. def getStartTimeFormat: String

  57. def getSupportThreshold: Int

  58. def getTimeCol: String

  59. def getTimeDecayCoeff: Int

  60. def getUserCol: String
    Definition Classes
    ALSModelParams
  61. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  62. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  63. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  64. val implicitPrefs: BooleanParam
    Definition Classes
    ALSParams
  65. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  66. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. val intermediateStorageLevel: Param[String]
    Definition Classes
    ALSParams
  68. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  69. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  70. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  71. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  72. val itemCol: Param[String]
    Definition Classes
    ALSModelParams
  73. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  74. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  75. def logClass(): Unit
    Definition Classes
    BasicLogging
  76. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  81. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  82. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  85. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  86. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  89. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  90. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  91. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  94. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  95. final val maxIter: IntParam
    Definition Classes
    HasMaxIter
  96. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  97. val nonnegative: BooleanParam
    Definition Classes
    ALSParams
  98. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  99. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  100. val numItemBlocks: IntParam
    Definition Classes
    ALSParams
  101. val numUserBlocks: IntParam
    Definition Classes
    ALSParams
  102. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  103. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  104. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  105. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  106. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  107. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  108. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  109. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  110. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  111. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  112. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  113. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  114. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  115. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  116. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  117. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  118. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  119. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  120. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  121. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  122. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  123. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  124. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  125. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  126. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  127. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  128. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  129. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  130. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  131. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  132. val rank: IntParam
    Definition Classes
    ALSParams
  133. val ratingCol: Param[String]
    Definition Classes
    ALSParams
  134. final val regParam: DoubleParam
    Definition Classes
    HasRegParam
  135. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  136. final val seed: LongParam
    Definition Classes
    HasSeed
  137. final def set(paramPair: ParamPair[_]): SAR.this.type
    Attributes
    protected
    Definition Classes
    Params
  138. final def set(param: String, value: Any): SAR.this.type
    Attributes
    protected
    Definition Classes
    Params
  139. final def set[T](param: Param[T], value: T): SAR.this.type
    Definition Classes
    Params
  140. def setActivityTimeFormat(value: String): SAR.this.type
    Definition Classes
    SARParams
  141. final def setDefault(paramPairs: ParamPair[_]*): SAR.this.type
    Attributes
    protected
    Definition Classes
    Params
  142. final def setDefault[T](param: Param[T], value: T): SAR.this.type
    Attributes
    protected
    Definition Classes
    Params
  143. def setItemCol(value: String): SAR.this.type

    Definition Classes
    SARParams
  144. def setRatingCol(value: String): SAR.this.type

    Definition Classes
    SARParams
  145. def setSimilarityFunction(value: String): SAR.this.type

    Definition Classes
    SARParams
  146. def setStartTime(value: String): SAR.this.type
    Definition Classes
    SARParams
  147. def setStartTimeFormat(value: String): SAR.this.type
    Definition Classes
    SARParams
  148. def setSupportThreshold(value: Int): SAR.this.type
    Definition Classes
    SARParams
  149. def setTimeCol(value: String): SAR.this.type

    Definition Classes
    SARParams
  150. def setTimeDecayCoeff(value: Int): SAR.this.type
    Definition Classes
    SARParams
  151. def setUserCol(value: String): SAR.this.type

    Definition Classes
    SARParams
  152. val similarityFunction: Param[String]
    Definition Classes
    SARParams
  153. val startTime: Param[String]
    Definition Classes
    SARParams
  154. val startTimeFormat: Param[String]
    Definition Classes
    SARParams
  155. val supportThreshold: IntParam
    Definition Classes
    SARParams
  156. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  157. val timeCol: Param[String]
    Definition Classes
    SARParams
  158. val timeDecayCoeff: IntParam
    Definition Classes
    SARParams
  159. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  160. def transformSchema(schema: StructType): StructType
    Definition Classes
    SAR → PipelineStage
  161. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  162. val uid: String
    Definition Classes
    SAR → BasicLogging → Identifiable
  163. val userCol: Param[String]
    Definition Classes
    ALSModelParams
  164. def validateAndTransformSchema(schema: StructType): StructType
    Attributes
    protected
    Definition Classes
    ALSParams
  165. val ver: String
    Definition Classes
    BasicLogging
  166. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  167. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  168. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  169. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from BasicLogging

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from SARParams

Inherited from RecommendationParams

Inherited from ALSParams

Inherited from HasSeed

Inherited from HasCheckpointInterval

Inherited from HasRegParam

Inherited from HasMaxIter

Inherited from ALSModelParams

Inherited from HasBlockSize

Inherited from HasPredictionCol

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Estimator[SARModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

setParam

Ungrouped