Class/Object

com.microsoft.ml.spark.recommendation

SAR

Related Docs: object SAR | package recommendation

Permalink

class SAR extends Estimator[SARModel] with SARParams with DefaultParamsWritable

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

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

Instance Constructors

  1. new SAR()

    Permalink
  2. new SAR(uid: String)

    Permalink

    uid

    The id of the module

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. val activityTimeFormat: Param[String]

    Permalink
    Definition Classes
    SARParams
  6. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    HasAdditionalPythonMethods
  7. val alpha: DoubleParam

    Permalink
    Definition Classes
    ALSParams
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. val checkedCast: UserDefinedFunction

    Permalink
    Attributes
    protected[org.apache.spark.ml.recommendation]
    Definition Classes
    ALSModelParams
  10. final val checkpointInterval: IntParam

    Permalink
    Definition Classes
    HasCheckpointInterval
  11. final def clear(param: Param[_]): SAR.this.type

    Permalink
    Definition Classes
    Params
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val coldStartStrategy: Param[String]

    Permalink
    Definition Classes
    ALSModelParams
  14. def copy(extra: ParamMap): SAR

    Permalink
    Definition Classes
    SAR → Estimator → PipelineStage → Params
  15. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  16. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  20. def explainParams(): String

    Permalink
    Definition Classes
    Params
  21. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  22. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  23. val finalStorageLevel: Param[String]

    Permalink
    Definition Classes
    ALSParams
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def fit(dataset: Dataset[_]): SARModel

    Permalink
    Definition Classes
    SAR → Estimator
  26. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SARModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  27. def fit(dataset: Dataset[_], paramMap: ParamMap): SARModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  28. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SARModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  29. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  30. def getActivityTimeFormat: String

    Permalink

  31. def getAlpha: Double

    Permalink
    Definition Classes
    ALSParams
  32. final def getCheckpointInterval: Int

    Permalink
    Definition Classes
    HasCheckpointInterval
  33. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  34. def getColdStartStrategy: String

    Permalink
    Definition Classes
    ALSModelParams
  35. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  36. def getFinalStorageLevel: String

    Permalink
    Definition Classes
    ALSParams
  37. def getImplicitPrefs: Boolean

    Permalink
    Definition Classes
    ALSParams
  38. def getIntermediateStorageLevel: String

    Permalink
    Definition Classes
    ALSParams
  39. def getItemCol: String

    Permalink
    Definition Classes
    ALSModelParams
  40. final def getMaxIter: Int

    Permalink
    Definition Classes
    HasMaxIter
  41. def getNonnegative: Boolean

    Permalink
    Definition Classes
    ALSParams
  42. def getNumItemBlocks: Int

    Permalink
    Definition Classes
    ALSParams
  43. def getNumUserBlocks: Int

    Permalink
    Definition Classes
    ALSParams
  44. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  45. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  46. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  47. def getRank: Int

    Permalink
    Definition Classes
    ALSParams
  48. def getRatingCol: String

    Permalink
    Definition Classes
    ALSParams
  49. final def getRegParam: Double

    Permalink
    Definition Classes
    HasRegParam
  50. final def getSeed: Long

    Permalink
    Definition Classes
    HasSeed
  51. def getSimilarityFunction: String

    Permalink

  52. def getStartTimeFormat: String

    Permalink

  53. def getSupportThreshold: Int

    Permalink

  54. def getTimeCol: String

    Permalink

  55. def getTimeDecayCoeff: Int

    Permalink

  56. def getUserCol: String

    Permalink
    Definition Classes
    ALSModelParams
  57. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  58. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  59. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  60. val implicitPrefs: BooleanParam

    Permalink
    Definition Classes
    ALSParams
  61. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. val intermediateStorageLevel: Param[String]

    Permalink
    Definition Classes
    ALSParams
  64. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  65. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  66. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  67. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. val itemCol: Param[String]

    Permalink
    Definition Classes
    ALSModelParams
  69. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  75. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  77. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  79. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  81. final val maxIter: IntParam

    Permalink
    Definition Classes
    HasMaxIter
  82. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  83. val nonnegative: BooleanParam

    Permalink
    Definition Classes
    ALSParams
  84. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  85. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  86. val numItemBlocks: IntParam

    Permalink
    Definition Classes
    ALSParams
  87. val numUserBlocks: IntParam

    Permalink
    Definition Classes
    ALSParams
  88. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  89. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol
  90. val rank: IntParam

    Permalink
    Definition Classes
    ALSParams
  91. val ratingCol: Param[String]

    Permalink
    Definition Classes
    ALSParams
  92. final val regParam: DoubleParam

    Permalink
    Definition Classes
    HasRegParam
  93. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  94. final val seed: LongParam

    Permalink
    Definition Classes
    HasSeed
  95. final def set(paramPair: ParamPair[_]): SAR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  96. final def set(param: String, value: Any): SAR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  97. final def set[T](param: Param[T], value: T): SAR.this.type

    Permalink
    Definition Classes
    Params
  98. def setActivityTimeFormat(value: String): SAR.this.type

    Permalink
    Definition Classes
    SARParams
  99. final def setDefault(paramPairs: ParamPair[_]*): SAR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  100. final def setDefault[T](param: Param[T], value: T): SAR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  101. def setItemCol(value: String): SAR.this.type

    Permalink

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

    Permalink

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

    Permalink

    Definition Classes
    SARParams
  104. def setStartTime(value: String): SAR.this.type

    Permalink
    Definition Classes
    SARParams
  105. def setStartTimeFormat(value: String): SAR.this.type

    Permalink
    Definition Classes
    SARParams
  106. def setSupportThreshold(value: Int): SAR.this.type

    Permalink
    Definition Classes
    SARParams
  107. def setTimeCol(value: String): SAR.this.type

    Permalink

    Definition Classes
    SARParams
  108. def setTimeDecayCoeff(value: Int): SAR.this.type

    Permalink
    Definition Classes
    SARParams
  109. def setUserCol(value: String): SAR.this.type

    Permalink

    Definition Classes
    SARParams
  110. val similarityFunction: Param[String]

    Permalink
    Definition Classes
    SARParams
  111. val startTime: Param[String]

    Permalink
    Definition Classes
    SARParams
  112. val startTimeFormat: Param[String]

    Permalink
    Definition Classes
    SARParams
  113. val supportThreshold: IntParam

    Permalink
    Definition Classes
    SARParams
  114. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  115. val timeCol: Param[String]

    Permalink
    Definition Classes
    SARParams
  116. val timeDecayCoeff: IntParam

    Permalink
    Definition Classes
    SARParams
  117. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  118. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    SAR → PipelineStage
  119. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  120. val uid: String

    Permalink

    The id of the module

    The id of the module

    Definition Classes
    SAR → Identifiable
  121. val userCol: Param[String]

    Permalink
    Definition Classes
    ALSModelParams
  122. def validateAndTransformSchema(schema: StructType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    ALSParams
  123. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

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 HasPredictionCol

Inherited from Wrappable

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