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, 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. 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. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  35. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  36. def getRank: Int
    Definition Classes
    ALSParams
  37. def getRatingCol: String
    Definition Classes
    ALSParams
  38. final def getRegParam: Double
    Definition Classes
    HasRegParam
  39. final def getSeed: Long
    Definition Classes
    HasSeed
  40. def getSimilarityFunction: String

  41. def getStartTimeFormat: String

  42. def getSupportThreshold: Int

  43. def getTimeCol: String

  44. def getTimeDecayCoeff: Int

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

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

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

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

    Definition Classes
    RecommendationParams
  78. def setFinalStorageLevel(value: String): SAR.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    SARParams
  92. def setStartTime(value: String): SAR.this.type
    Definition Classes
    SARParams
  93. def setStartTimeFormat(value: String): SAR.this.type
    Definition Classes
    SARParams
  94. def setSupportThreshold(value: Int): SAR.this.type
    Definition Classes
    SARParams
  95. def setTimeCol(value: String): SAR.this.type

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

    Definition Classes
    SARParams
  98. val similarityFunction: Param[String]
    Definition Classes
    SARParams
  99. val startTime: Param[String]
    Definition Classes
    SARParams
  100. val startTimeFormat: Param[String]
    Definition Classes
    SARParams
  101. val supportThreshold: IntParam
    Definition Classes
    SARParams
  102. val timeCol: Param[String]
    Definition Classes
    SARParams
  103. val timeDecayCoeff: IntParam
    Definition Classes
    SARParams
  104. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  105. def transformSchema(schema: StructType): StructType
    Definition Classes
    SAR → PipelineStage
  106. val uid: String
    Definition Classes
    SAR → SynapseMLLogging → Identifiable
  107. val userCol: Param[String]
    Definition Classes
    ALSModelParams
  108. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable