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. val activityTimeFormat: Param[String]
    Definition Classes
    SARParams
  2. val alpha: DoubleParam
    Definition Classes
    ALSParams
  3. final val blockSize: IntParam
    Definition Classes
    HasBlockSize
  4. final val checkpointInterval: IntParam
    Definition Classes
    HasCheckpointInterval
  5. final def clear(param: Param[_]): SAR.this.type
    Definition Classes
    Params
  6. val coldStartStrategy: Param[String]
    Definition Classes
    ALSModelParams
  7. def copy(extra: ParamMap): SAR
    Definition Classes
    SAR → Estimator → PipelineStage → Params
  8. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  9. def explainParams(): String
    Definition Classes
    Params
  10. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  11. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  12. val finalStorageLevel: Param[String]
    Definition Classes
    ALSParams
  13. def fit(dataset: Dataset[_]): SARModel
    Definition Classes
    SAR → Estimator
  14. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[SARModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  15. def fit(dataset: Dataset[_], paramMap: ParamMap): SARModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  16. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SARModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  17. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  18. def getActivityTimeFormat: String

  19. def getAlpha: Double
    Definition Classes
    ALSParams
  20. final def getBlockSize: Int
    Definition Classes
    HasBlockSize
  21. final def getCheckpointInterval: Int
    Definition Classes
    HasCheckpointInterval
  22. def getColdStartStrategy: String
    Definition Classes
    ALSModelParams
  23. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  24. def getFinalStorageLevel: String
    Definition Classes
    ALSParams
  25. def getImplicitPrefs: Boolean
    Definition Classes
    ALSParams
  26. def getIntermediateStorageLevel: String
    Definition Classes
    ALSParams
  27. def getItemCol: String
    Definition Classes
    ALSModelParams
  28. final def getMaxIter: Int
    Definition Classes
    HasMaxIter
  29. def getNonnegative: Boolean
    Definition Classes
    ALSParams
  30. def getNumItemBlocks: Int
    Definition Classes
    ALSParams
  31. def getNumUserBlocks: Int
    Definition Classes
    ALSParams
  32. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  33. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  34. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  35. def getRank: Int
    Definition Classes
    ALSParams
  36. def getRatingCol: String
    Definition Classes
    ALSParams
  37. final def getRegParam: Double
    Definition Classes
    HasRegParam
  38. final def getSeed: Long
    Definition Classes
    HasSeed
  39. def getSimilarityFunction: String

  40. def getStartTimeFormat: String

  41. def getSupportThreshold: Int

  42. def getTimeCol: String

  43. def getTimeDecayCoeff: Int

  44. def getUserCol: String
    Definition Classes
    ALSModelParams
  45. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  46. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  47. val implicitPrefs: BooleanParam
    Definition Classes
    ALSParams
  48. val intermediateStorageLevel: Param[String]
    Definition Classes
    ALSParams
  49. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  50. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  51. val itemCol: Param[String]
    Definition Classes
    ALSModelParams
  52. def logClass(): Unit
    Definition Classes
    BasicLogging
  53. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  54. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  55. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  56. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  57. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  58. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  59. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  60. final val maxIter: IntParam
    Definition Classes
    HasMaxIter
  61. val nonnegative: BooleanParam
    Definition Classes
    ALSParams
  62. val numItemBlocks: IntParam
    Definition Classes
    ALSParams
  63. val numUserBlocks: IntParam
    Definition Classes
    ALSParams
  64. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  65. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  66. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  67. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  68. val rank: IntParam
    Definition Classes
    ALSParams
  69. val ratingCol: Param[String]
    Definition Classes
    ALSParams
  70. final val regParam: DoubleParam
    Definition Classes
    HasRegParam
  71. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  72. final val seed: LongParam
    Definition Classes
    HasSeed
  73. final def set[T](param: Param[T], value: T): SAR.this.type
    Definition Classes
    Params
  74. def setActivityTimeFormat(value: String): SAR.this.type
    Definition Classes
    SARParams
  75. def setItemCol(value: String): SAR.this.type

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

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

    Definition Classes
    SARParams
  78. def setStartTime(value: String): SAR.this.type
    Definition Classes
    SARParams
  79. def setStartTimeFormat(value: String): SAR.this.type
    Definition Classes
    SARParams
  80. def setSupportThreshold(value: Int): SAR.this.type
    Definition Classes
    SARParams
  81. def setTimeCol(value: String): SAR.this.type

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

    Definition Classes
    SARParams
  84. val similarityFunction: Param[String]
    Definition Classes
    SARParams
  85. val startTime: Param[String]
    Definition Classes
    SARParams
  86. val startTimeFormat: Param[String]
    Definition Classes
    SARParams
  87. val supportThreshold: IntParam
    Definition Classes
    SARParams
  88. val timeCol: Param[String]
    Definition Classes
    SARParams
  89. val timeDecayCoeff: IntParam
    Definition Classes
    SARParams
  90. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  91. def transformSchema(schema: StructType): StructType
    Definition Classes
    SAR → PipelineStage
  92. val uid: String
    Definition Classes
    SAR → BasicLogging → Identifiable
  93. val userCol: Param[String]
    Definition Classes
    ALSModelParams
  94. val ver: String
    Definition Classes
    BasicLogging
  95. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable