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, 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. RWrappable
  14. PythonWrappable
  15. BaseWrappable
  16. BaseRecommendationModel
  17. ALSModelParams
  18. HasBlockSize
  19. HasPredictionCol
  20. Model
  21. Transformer
  22. PipelineStage
  23. Logging
  24. Params
  25. Serializable
  26. Serializable
  27. Identifiable
  28. AnyRef
  29. 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 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. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  14. def getALSModel(uid: String, rank: Int, userFactors: DataFrame, itemFactors: DataFrame): ALSModel
    Definition Classes
    BaseRecommendationModel
  15. def getAlpha: Double
    Definition Classes
    ALSParams
  16. final def getBlockSize: Int
    Definition Classes
    HasBlockSize
  17. final def getCheckpointInterval: Int
    Definition Classes
    HasCheckpointInterval
  18. def getColdStartStrategy: String
    Definition Classes
    ALSModelParams
  19. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  20. def getFinalStorageLevel: String
    Definition Classes
    ALSParams
  21. def getImplicitPrefs: Boolean
    Definition Classes
    ALSParams
  22. def getIntermediateStorageLevel: String
    Definition Classes
    ALSParams
  23. def getItemCol: String
    Definition Classes
    ALSModelParams
  24. def getItemDataFrame: DataFrame

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

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

  68. final val regParam: DoubleParam
    Definition Classes
    HasRegParam
  69. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  70. final val seed: LongParam
    Definition Classes
    HasSeed
  71. final def set[T](param: Param[T], value: T): SARModel.this.type
    Definition Classes
    Params
  72. def setActivityTimeFormat(value: String): SARModel.this.type
    Definition Classes
    SARParams
  73. def setAlpha(value: Double): SARModel.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  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 transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    SARModel → Transformer
  108. def transform(rank: Int, userDataFrame: DataFrame, itemDataFrame: DataFrame, dataset: Dataset[_]): DataFrame
    Definition Classes
    BaseRecommendationModel
  109. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  110. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  111. def transformSchema(schema: StructType): StructType
    Definition Classes
    SARModel → PipelineStage
  112. val uid: String
    Definition Classes
    SARModelSynapseMLLogging → Identifiable
  113. val userCol: Param[String]
    Definition Classes
    ALSModelParams
  114. val userDataFrame: DataFrameParam
  115. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable