Class/Object

com.microsoft.ml.spark

SAR

Related Docs: object SAR | package spark

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, Estimator[SARModel], PipelineStage, org.apache.spark.internal.Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. 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. Estimator
  15. PipelineStage
  16. Logging
  17. Params
  18. Serializable
  19. Serializable
  20. Identifiable
  21. AnyRef
  22. 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. val alpha: DoubleParam

    Permalink
    Definition Classes
    ALSParams

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. val checkedCast: UserDefinedFunction

    Permalink
    Attributes
    protected[org.apache.spark.ml.recommendation]
    Definition Classes
    ALSModelParams

  9. final val checkpointInterval: IntParam

    Permalink
    Definition Classes
    HasCheckpointInterval

  10. final def clear(param: Param[_]): SAR.this.type

    Permalink
    Definition Classes
    Params

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. val coldStartStrategy: Param[String]

    Permalink
    Definition Classes
    ALSModelParams

  13. def copy(extra: ParamMap): SAR

    Permalink
    Definition Classes
    SAR → Estimator → PipelineStage → Params

  14. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  15. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  18. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  19. def explainParams(): String

    Permalink
    Definition Classes
    Params

  20. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  21. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  22. val finalStorageLevel: Param[String]

    Permalink
    Definition Classes
    ALSParams

  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  24. def fit(dataset: Dataset[_]): SARModel

    Permalink
    Definition Classes
    SAR → Estimator

  25. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SARModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  26. def fit(dataset: Dataset[_], paramMap: ParamMap): SARModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SARModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()

  28. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  29. def getActivityTimeFormat: String

    Permalink

  30. def getAlpha: Double

    Permalink
    Definition Classes
    ALSParams

  31. final def getCheckpointInterval: Int

    Permalink
    Definition Classes
    HasCheckpointInterval

  32. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  33. def getColdStartStrategy: String

    Permalink
    Definition Classes
    ALSModelParams

  34. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  35. def getFinalStorageLevel: String

    Permalink
    Definition Classes
    ALSParams

  36. def getImplicitPrefs: Boolean

    Permalink
    Definition Classes
    ALSParams

  37. def getIntermediateStorageLevel: String

    Permalink
    Definition Classes
    ALSParams

  38. def getItemCol: String

    Permalink
    Definition Classes
    ALSModelParams

  39. final def getMaxIter: Int

    Permalink
    Definition Classes
    HasMaxIter

  40. def getNonnegative: Boolean

    Permalink
    Definition Classes
    ALSParams

  41. def getNumItemBlocks: Int

    Permalink
    Definition Classes
    ALSParams

  42. def getNumUserBlocks: Int

    Permalink
    Definition Classes
    ALSParams

  43. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params

  44. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

  45. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol

  46. def getRank: Int

    Permalink
    Definition Classes
    ALSParams

  47. def getRatingCol: String

    Permalink
    Definition Classes
    ALSParams

  48. final def getRegParam: Double

    Permalink
    Definition Classes
    HasRegParam

  49. final def getSeed: Long

    Permalink
    Definition Classes
    HasSeed

  50. def getSimilarityFunction: String

    Permalink

  51. def getStartTimeFormat: String

    Permalink

  52. def getSupportThreshold: Int

    Permalink

  53. def getTimeCol: String

    Permalink

  54. def getTimeDecayCoeff: Int

    Permalink

  55. def getUserCol: String

    Permalink
    Definition Classes
    ALSModelParams

  56. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  57. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  58. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  59. val implicitPrefs: BooleanParam

    Permalink
    Definition Classes
    ALSParams

  60. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  61. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  62. val intermediateStorageLevel: Param[String]

    Permalink
    Definition Classes
    ALSParams

  63. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  64. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  65. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  66. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  67. val itemCol: Param[String]

    Permalink
    Definition Classes
    ALSModelParams

  68. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  69. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  70. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  71. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  72. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  73. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  74. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  75. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  76. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  77. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  78. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  79. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  80. final val maxIter: IntParam

    Permalink
    Definition Classes
    HasMaxIter

  81. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  82. val nonnegative: BooleanParam

    Permalink
    Definition Classes
    ALSParams

  83. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  84. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  85. val numItemBlocks: IntParam

    Permalink
    Definition Classes
    ALSParams

  86. val numUserBlocks: IntParam

    Permalink
    Definition Classes
    ALSParams

  87. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  88. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol

  89. val rank: IntParam

    Permalink
    Definition Classes
    ALSParams

  90. val ratingCol: Param[String]

    Permalink
    Definition Classes
    ALSParams

  91. final val regParam: DoubleParam

    Permalink
    Definition Classes
    HasRegParam

  92. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  93. final val seed: LongParam

    Permalink
    Definition Classes
    HasSeed

  94. final def set(paramPair: ParamPair[_]): SAR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  95. final def set(param: String, value: Any): SAR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  96. final def set[T](param: Param[T], value: T): SAR.this.type

    Permalink
    Definition Classes
    Params

  97. def setActivityTimeFormat(value: String): SAR.this.type

    Permalink
    Definition Classes
    SARParams

  98. final def setDefault(paramPairs: ParamPair[_]*): SAR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  99. final def setDefault[T](param: Param[T], value: T): SAR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  100. def setItemCol(value: String): SAR.this.type

    Permalink

    Definition Classes
    SARParams

  101. def setRatingCol(value: String): SAR.this.type

    Permalink

    Definition Classes
    SARParams

  102. def setSimilarityFunction(value: String): SAR.this.type

    Permalink

    Definition Classes
    SARParams

  103. def setStartTime(value: String): SAR.this.type

    Permalink
    Definition Classes
    SARParams

  104. def setStartTimeFormat(value: String): SAR.this.type

    Permalink
    Definition Classes
    SARParams

  105. def setSupportThreshold(value: Int): SAR.this.type

    Permalink
    Definition Classes
    SARParams

  106. def setTimeCol(value: String): SAR.this.type

    Permalink

    Definition Classes
    SARParams

  107. def setTimeDecayCoeff(value: Int): SAR.this.type

    Permalink
    Definition Classes
    SARParams

  108. def setUserCol(value: String): SAR.this.type

    Permalink

    Definition Classes
    SARParams

  109. val similarityFunction: Param[String]

    Permalink
    Definition Classes
    SARParams

  110. val startTime: Param[String]

    Permalink
    Definition Classes
    SARParams

  111. val startTimeFormat: Param[String]

    Permalink
    Definition Classes
    SARParams

  112. val supportThreshold: IntParam

    Permalink
    Definition Classes
    SARParams

  113. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  114. val timeCol: Param[String]

    Permalink
    Definition Classes
    SARParams

  115. val timeDecayCoeff: IntParam

    Permalink
    Definition Classes
    SARParams

  116. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  117. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    SAR → PipelineStage

  118. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  119. val uid: String

    Permalink

    The id of the module

    The id of the module

    Definition Classes
    SAR → Identifiable

  120. val userCol: Param[String]

    Permalink
    Definition Classes
    ALSModelParams

  121. def validateAndTransformSchema(schema: StructType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    ALSParams

  122. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  123. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  124. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  125. 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 org.apache.spark.internal.Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameter setters

Parameter getters

Members