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

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
SynapseMLLogging, DefaultParamsWritable, MLWritable, SARParams, RecommendationParams, ALSParams, HasSeed, HasCheckpointInterval, HasRegParam, HasMaxIter, ALSModelParams, HasBlockSize, HasPredictionCol, Wrappable, DotnetWrappable, RWrappable, PythonWrappable, BaseWrappable, Estimator[SARModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SAR
  2. SynapseMLLogging
  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. DotnetWrappable
  17. RWrappable
  18. PythonWrappable
  19. BaseWrappable
  20. Estimator
  21. PipelineStage
  22. Logging
  23. Params
  24. Serializable
  25. Serializable
  26. Identifiable
  27. AnyRef
  28. 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. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  21. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  31. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  32. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  33. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  34. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  35. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  36. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  39. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  40. def explainParams(): String
    Definition Classes
    Params
  41. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  42. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  43. val finalStorageLevel: Param[String]
    Definition Classes
    ALSParams
  44. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  45. def fit(dataset: Dataset[_]): SARModel
    Definition Classes
    SAR → Estimator
  46. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[SARModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  47. def fit(dataset: Dataset[_], paramMap: ParamMap): SARModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  48. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SARModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  49. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  50. def getActivityTimeFormat: String

  51. def getAlpha: Double
    Definition Classes
    ALSParams
  52. final def getBlockSize: Int
    Definition Classes
    HasBlockSize
  53. final def getCheckpointInterval: Int
    Definition Classes
    HasCheckpointInterval
  54. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  55. def getColdStartStrategy: String
    Definition Classes
    ALSModelParams
  56. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  57. def getFinalStorageLevel: String
    Definition Classes
    ALSParams
  58. def getImplicitPrefs: Boolean
    Definition Classes
    ALSParams
  59. def getIntermediateStorageLevel: String
    Definition Classes
    ALSParams
  60. def getItemCol: String
    Definition Classes
    ALSModelParams
  61. final def getMaxIter: Int
    Definition Classes
    HasMaxIter
  62. def getNonnegative: Boolean
    Definition Classes
    ALSParams
  63. def getNumItemBlocks: Int
    Definition Classes
    ALSParams
  64. def getNumUserBlocks: Int
    Definition Classes
    ALSParams
  65. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  66. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  67. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  68. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  69. def getRank: Int
    Definition Classes
    ALSParams
  70. def getRatingCol: String
    Definition Classes
    ALSParams
  71. final def getRegParam: Double
    Definition Classes
    HasRegParam
  72. final def getSeed: Long
    Definition Classes
    HasSeed
  73. def getSimilarityFunction: String

  74. def getStartTimeFormat: String

  75. def getSupportThreshold: Int

  76. def getTimeCol: String

  77. def getTimeDecayCoeff: Int

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

    Definition Classes
    RecommendationParams
  161. def setBlockSize(value: Int): SAR.this.type

    Definition Classes
    RecommendationParams
  162. def setCheckpointInterval(value: Int): SAR.this.type

    Definition Classes
    RecommendationParams
  163. def setColdStartStrategy(value: String): SAR.this.type

    Definition Classes
    RecommendationParams
  164. final def setDefault(paramPairs: ParamPair[_]*): SAR.this.type
    Attributes
    protected
    Definition Classes
    Params
  165. final def setDefault[T](param: Param[T], value: T): SAR.this.type
    Attributes
    protected
    Definition Classes
    Params
  166. def setFinalStorageLevel(value: String): SAR.this.type

    Definition Classes
    RecommendationParams
  167. def setImplicitPrefs(value: Boolean): SAR.this.type

    Definition Classes
    RecommendationParams
  168. def setIntermediateStorageLevel(value: String): SAR.this.type

    Definition Classes
    RecommendationParams
  169. def setItemCol(value: String): SAR.this.type

    Definition Classes
    SARParams
  170. def setMaxIter(value: Int): SAR.this.type

    Definition Classes
    RecommendationParams
  171. def setNonnegative(value: Boolean): SAR.this.type

    Definition Classes
    RecommendationParams
  172. def setNumItemBlocks(value: Int): SAR.this.type

    Definition Classes
    RecommendationParams
  173. def setNumUserBlocks(value: Int): SAR.this.type

    Definition Classes
    RecommendationParams
  174. def setPredictionCol(value: String): SAR.this.type

    Definition Classes
    RecommendationParams
  175. def setRank(value: Int): SAR.this.type

    Definition Classes
    RecommendationParams
  176. def setRatingCol(value: String): SAR.this.type

    Definition Classes
    SARParams
  177. def setRegParam(value: Double): SAR.this.type

    Definition Classes
    RecommendationParams
  178. def setSeed(value: Long): SAR.this.type

    Definition Classes
    RecommendationParams
  179. def setSimilarityFunction(value: String): SAR.this.type

    Definition Classes
    SARParams
  180. def setStartTime(value: String): SAR.this.type
    Definition Classes
    SARParams
  181. def setStartTimeFormat(value: String): SAR.this.type
    Definition Classes
    SARParams
  182. def setSupportThreshold(value: Int): SAR.this.type
    Definition Classes
    SARParams
  183. def setTimeCol(value: String): SAR.this.type

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

    Definition Classes
    SARParams
  186. val similarityFunction: Param[String]
    Definition Classes
    SARParams
  187. val startTime: Param[String]
    Definition Classes
    SARParams
  188. val startTimeFormat: Param[String]
    Definition Classes
    SARParams
  189. val supportThreshold: IntParam
    Definition Classes
    SARParams
  190. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  191. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  192. val timeCol: Param[String]
    Definition Classes
    SARParams
  193. val timeDecayCoeff: IntParam
    Definition Classes
    SARParams
  194. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  195. def transformSchema(schema: StructType): StructType
    Definition Classes
    SAR → PipelineStage
  196. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  197. val uid: String
    Definition Classes
    SAR → SynapseMLLogging → Identifiable
  198. val userCol: Param[String]
    Definition Classes
    ALSModelParams
  199. def validateAndTransformSchema(schema: StructType): StructType
    Attributes
    protected
    Definition Classes
    ALSParams
  200. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  201. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  202. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  203. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from SynapseMLLogging

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 DotnetWrappable

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