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. 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 dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  9. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  10. def explainParams(): String
    Definition Classes
    Params
  11. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  12. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  13. val finalStorageLevel: Param[String]
    Definition Classes
    ALSParams
  14. def fit(dataset: Dataset[_]): SARModel
    Definition Classes
    SAR → Estimator
  15. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[SARModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  16. def fit(dataset: Dataset[_], paramMap: ParamMap): SARModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  17. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SARModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  18. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  19. def getActivityTimeFormat: String

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

  42. def getStartTimeFormat: String

  43. def getSupportThreshold: Int

  44. def getTimeCol: String

  45. def getTimeDecayCoeff: Int

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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