class SARModel extends Model[SARModel] with BaseRecommendationModel with Wrappable with SARParams with ComplexParamsWritable with SynapseMLLogging

SAR Model

Linear Supertypes
SynapseMLLogging, ComplexParamsWritable, MLWritable, SARParams, RecommendationParams, ALSParams, HasSeed, HasCheckpointInterval, HasRegParam, HasMaxIter, Wrappable, DotnetWrappable, RWrappable, PythonWrappable, BaseWrappable, BaseRecommendationModel, ALSModelParams, HasBlockSize, HasPredictionCol, Model[SARModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SARModel
  2. SynapseMLLogging
  3. ComplexParamsWritable
  4. MLWritable
  5. SARParams
  6. RecommendationParams
  7. ALSParams
  8. HasSeed
  9. HasCheckpointInterval
  10. HasRegParam
  11. HasMaxIter
  12. Wrappable
  13. DotnetWrappable
  14. RWrappable
  15. PythonWrappable
  16. BaseWrappable
  17. BaseRecommendationModel
  18. ALSModelParams
  19. HasBlockSize
  20. HasPredictionCol
  21. Model
  22. Transformer
  23. PipelineStage
  24. Logging
  25. Params
  26. Serializable
  27. Serializable
  28. Identifiable
  29. AnyRef
  30. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SARModel()
  2. new SARModel(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[_]): SARModel.this.type
    Definition Classes
    Params
  6. val coldStartStrategy: Param[String]
    Definition Classes
    ALSModelParams
  7. def copy(extra: ParamMap): SARModel
    Definition Classes
    SARModel → Model → Transformer → 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. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  15. def getALSModel(uid: String, rank: Int, userFactors: DataFrame, itemFactors: DataFrame): ALSModel
    Definition Classes
    BaseRecommendationModel
  16. def getAlpha: Double
    Definition Classes
    ALSParams
  17. final def getBlockSize: Int
    Definition Classes
    HasBlockSize
  18. final def getCheckpointInterval: Int
    Definition Classes
    HasCheckpointInterval
  19. def getColdStartStrategy: String
    Definition Classes
    ALSModelParams
  20. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  21. def getFinalStorageLevel: String
    Definition Classes
    ALSParams
  22. def getImplicitPrefs: Boolean
    Definition Classes
    ALSParams
  23. def getIntermediateStorageLevel: String
    Definition Classes
    ALSParams
  24. def getItemCol: String
    Definition Classes
    ALSModelParams
  25. def getItemDataFrame: DataFrame

  26. final def getMaxIter: Int
    Definition Classes
    HasMaxIter
  27. def getNonnegative: Boolean
    Definition Classes
    ALSParams
  28. def getNumItemBlocks: Int
    Definition Classes
    ALSParams
  29. def getNumUserBlocks: Int
    Definition Classes
    ALSParams
  30. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  31. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  32. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  33. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  34. def getRank: Int
    Definition Classes
    ALSParams
  35. def getRatingCol: String
    Definition Classes
    ALSParams
  36. final def getRegParam: Double
    Definition Classes
    HasRegParam
  37. final def getSeed: Long
    Definition Classes
    HasSeed
  38. def getUserCol: String
    Definition Classes
    ALSModelParams
  39. def getUserDataFrame: DataFrame

  40. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  41. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  42. def hasParent: Boolean
    Definition Classes
    Model
  43. val implicitPrefs: BooleanParam
    Definition Classes
    ALSParams
  44. val intermediateStorageLevel: Param[String]
    Definition Classes
    ALSParams
  45. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  46. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  47. val itemCol: Param[String]
    Definition Classes
    ALSModelParams
  48. val itemDataFrame: DataFrameParam
  49. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  50. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  51. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  52. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  53. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  54. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  55. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  56. final val maxIter: IntParam
    Definition Classes
    HasMaxIter
  57. val nonnegative: BooleanParam
    Definition Classes
    ALSParams
  58. val numItemBlocks: IntParam
    Definition Classes
    ALSParams
  59. val numUserBlocks: IntParam
    Definition Classes
    ALSParams
  60. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  61. var parent: Estimator[SARModel]
    Definition Classes
    Model
  62. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  63. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  64. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  65. val rank: IntParam
    Definition Classes
    ALSParams
  66. val ratingCol: Param[String]
    Definition Classes
    ALSParams
  67. def recommendForAllItems(numItems: Int): DataFrame
    Definition Classes
    SARModelBaseRecommendationModel
  68. def recommendForAllUsers(numItems: Int): DataFrame

    Returns top numItems items recommended for each user, for all users.

    Returns top numItems items recommended for each user, for all users.

    numItems

    max number of recommendations for each user

    returns

    a DataFrame of (userCol: Int, recommendations), where recommendations are stored as an array of (itemCol: Int, rating: Float) Rows.

    Definition Classes
    SARModelBaseRecommendationModel
  69. def recommendForUserSubset(dataset: Dataset[_], numItems: Int): DataFrame

    Returns top numItems items recommended for each user id in the input data set.

    Returns top numItems items recommended for each user id in the input data set. Note that if there are duplicate ids in the input dataset, only one set of recommendations per unique id will be returned.

    dataset

    a Dataset containing a column of user ids. The column name must match userCol.

    numItems

    max number of recommendations for each user.

    returns

    a DataFrame of (userCol: Int, recommendations), where recommendations are stored as an array of (itemCol: Int, rating: Float) Rows.

  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): SARModel.this.type
    Definition Classes
    Params
  74. def setActivityTimeFormat(value: String): SARModel.this.type
    Definition Classes
    SARParams
  75. def setAlpha(value: Double): SARModel.this.type

    Definition Classes
    RecommendationParams
  76. def setBlockSize(value: Int): SARModel.this.type

    Definition Classes
    RecommendationParams
  77. def setCheckpointInterval(value: Int): SARModel.this.type

    Definition Classes
    RecommendationParams
  78. def setColdStartStrategy(value: String): SARModel.this.type

    Definition Classes
    RecommendationParams
  79. def setFinalStorageLevel(value: String): SARModel.this.type

    Definition Classes
    RecommendationParams
  80. def setImplicitPrefs(value: Boolean): SARModel.this.type

    Definition Classes
    RecommendationParams
  81. def setIntermediateStorageLevel(value: String): SARModel.this.type

    Definition Classes
    RecommendationParams
  82. def setItemCol(value: String): SARModel.this.type

    Definition Classes
    SARParams
  83. def setItemDataFrame(value: DataFrame): SARModel.this.type

  84. def setMaxIter(value: Int): SARModel.this.type

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

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

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

    Definition Classes
    RecommendationParams
  88. def setParent(parent: Estimator[SARModel]): SARModel
    Definition Classes
    Model
  89. def setPredictionCol(value: String): SARModel.this.type

    Definition Classes
    RecommendationParams
  90. def setRank(value: Int): SARModel.this.type

    Definition Classes
    RecommendationParams
  91. def setRatingCol(value: String): SARModel.this.type

    Definition Classes
    SARParams
  92. def setRegParam(value: Double): SARModel.this.type

    Definition Classes
    RecommendationParams
  93. def setSeed(value: Long): SARModel.this.type

    Definition Classes
    RecommendationParams
  94. def setSimilarityFunction(value: String): SARModel.this.type

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

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

    Definition Classes
    SARParams
  101. def setUserDataFrame(value: DataFrame): SARModel.this.type

  102. val similarityFunction: Param[String]
    Definition Classes
    SARParams
  103. val startTime: Param[String]
    Definition Classes
    SARParams
  104. val startTimeFormat: Param[String]
    Definition Classes
    SARParams
  105. val supportThreshold: IntParam
    Definition Classes
    SARParams
  106. val timeCol: Param[String]
    Definition Classes
    SARParams
  107. val timeDecayCoeff: IntParam
    Definition Classes
    SARParams
  108. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  109. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    SARModel → Transformer
  110. def transform(rank: Int, userDataFrame: DataFrame, itemDataFrame: DataFrame, dataset: Dataset[_]): DataFrame
    Definition Classes
    BaseRecommendationModel
  111. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  112. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  113. def transformSchema(schema: StructType): StructType
    Definition Classes
    SARModel → PipelineStage
  114. val uid: String
    Definition Classes
    SARModelSynapseMLLogging → Identifiable
  115. val userCol: Param[String]
    Definition Classes
    ALSModelParams
  116. val userDataFrame: DataFrameParam
  117. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable