Class/Object

com.microsoft.ml.spark.recommendation

SARModel

Related Docs: object SARModel | package recommendation

Permalink

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

SAR Model

Annotations
@InternalWrapper()
Linear Supertypes
ComplexParamsWritable, MLWritable, SARParams, RecommendationParams, ALSParams, HasSeed, HasCheckpointInterval, HasRegParam, HasMaxIter, Wrappable, BaseRecommendationModel, ALSModelParams, HasPredictionCol, Model[SARModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SARModel
  2. ComplexParamsWritable
  3. MLWritable
  4. SARParams
  5. RecommendationParams
  6. ALSParams
  7. HasSeed
  8. HasCheckpointInterval
  9. HasRegParam
  10. HasMaxIter
  11. Wrappable
  12. BaseRecommendationModel
  13. ALSModelParams
  14. HasPredictionCol
  15. Model
  16. Transformer
  17. PipelineStage
  18. Logging
  19. Params
  20. Serializable
  21. Serializable
  22. Identifiable
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SARModel()

    Permalink
  2. new SARModel(uid: String)

    Permalink

    uid

    The id of the module

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. val activityTimeFormat: Param[String]

    Permalink
    Definition Classes
    SARParams
  6. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    Wrappable
  7. val alpha: DoubleParam

    Permalink
    Definition Classes
    ALSParams
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. val checkedCast: UserDefinedFunction

    Permalink
    Attributes
    protected[org.apache.spark.ml.recommendation]
    Definition Classes
    ALSModelParams
  10. final val checkpointInterval: IntParam

    Permalink
    Definition Classes
    HasCheckpointInterval
  11. final def clear(param: Param[_]): SARModel.this.type

    Permalink
    Definition Classes
    Params
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val coldStartStrategy: Param[String]

    Permalink
    Definition Classes
    ALSModelParams
  14. def copy(extra: ParamMap): SARModel

    Permalink
    Definition Classes
    SARModel → Model → Transformer → PipelineStage → Params
  15. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  16. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  20. def explainParams(): String

    Permalink
    Definition Classes
    Params
  21. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  22. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  23. val finalStorageLevel: Param[String]

    Permalink
    Definition Classes
    ALSParams
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  26. def getALSModel(uid: String, rank: Int, userFactors: DataFrame, itemFactors: DataFrame): ALSModel

    Permalink
    Definition Classes
    BaseRecommendationModel
  27. def getAlpha: Double

    Permalink
    Definition Classes
    ALSParams
  28. final def getCheckpointInterval: Int

    Permalink
    Definition Classes
    HasCheckpointInterval
  29. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  30. def getColdStartStrategy: String

    Permalink
    Definition Classes
    ALSModelParams
  31. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  32. def getFinalStorageLevel: String

    Permalink
    Definition Classes
    ALSParams
  33. def getImplicitPrefs: Boolean

    Permalink
    Definition Classes
    ALSParams
  34. def getIntermediateStorageLevel: String

    Permalink
    Definition Classes
    ALSParams
  35. def getItemCol: String

    Permalink
    Definition Classes
    ALSModelParams
  36. def getItemDataFrame: DataFrame

    Permalink

  37. final def getMaxIter: Int

    Permalink
    Definition Classes
    HasMaxIter
  38. def getNonnegative: Boolean

    Permalink
    Definition Classes
    ALSParams
  39. def getNumItemBlocks: Int

    Permalink
    Definition Classes
    ALSParams
  40. def getNumUserBlocks: Int

    Permalink
    Definition Classes
    ALSParams
  41. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  42. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  43. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  44. def getRank: Int

    Permalink
    Definition Classes
    ALSParams
  45. def getRatingCol: String

    Permalink
    Definition Classes
    ALSParams
  46. final def getRegParam: Double

    Permalink
    Definition Classes
    HasRegParam
  47. final def getSeed: Long

    Permalink
    Definition Classes
    HasSeed
  48. def getUserCol: String

    Permalink
    Definition Classes
    ALSModelParams
  49. def getUserDataFrame: DataFrame

    Permalink

  50. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  51. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  52. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  53. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  54. val implicitPrefs: BooleanParam

    Permalink
    Definition Classes
    ALSParams
  55. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. val intermediateStorageLevel: Param[String]

    Permalink
    Definition Classes
    ALSParams
  58. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  59. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  60. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  61. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. val itemCol: Param[String]

    Permalink
    Definition Classes
    ALSModelParams
  63. val itemDataFrame: DataFrameParam

    Permalink
  64. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  75. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. final val maxIter: IntParam

    Permalink
    Definition Classes
    HasMaxIter
  77. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  78. val nonnegative: BooleanParam

    Permalink
    Definition Classes
    ALSParams
  79. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  80. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  81. val numItemBlocks: IntParam

    Permalink
    Definition Classes
    ALSParams
  82. val numUserBlocks: IntParam

    Permalink
    Definition Classes
    ALSParams
  83. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  84. var parent: Estimator[SARModel]

    Permalink
    Definition Classes
    Model
  85. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol
  86. val rank: IntParam

    Permalink
    Definition Classes
    ALSParams
  87. val ratingCol: Param[String]

    Permalink
    Definition Classes
    ALSParams
  88. def recommendForAllUsers(numItems: Int): DataFrame

    Permalink

    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
  89. def recommendForUserSubset(dataset: Dataset[_], numItems: Int): DataFrame

    Permalink

    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.

  90. final val regParam: DoubleParam

    Permalink
    Definition Classes
    HasRegParam
  91. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  92. final val seed: LongParam

    Permalink
    Definition Classes
    HasSeed
  93. final def set(paramPair: ParamPair[_]): SARModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  94. final def set(param: String, value: Any): SARModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  95. final def set[T](param: Param[T], value: T): SARModel.this.type

    Permalink
    Definition Classes
    Params
  96. def setActivityTimeFormat(value: String): SARModel.this.type

    Permalink
    Definition Classes
    SARParams
  97. final def setDefault(paramPairs: ParamPair[_]*): SARModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  98. final def setDefault[T](param: Param[T], value: T): SARModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  99. def setItemCol(value: String): SARModel.this.type

    Permalink

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

    Permalink

  101. def setParent(parent: Estimator[SARModel]): SARModel

    Permalink
    Definition Classes
    Model
  102. def setRatingCol(value: String): SARModel.this.type

    Permalink

    Definition Classes
    SARParams
  103. def setSimilarityFunction(value: String): SARModel.this.type

    Permalink

    Definition Classes
    SARParams
  104. def setStartTime(value: String): SARModel.this.type

    Permalink
    Definition Classes
    SARParams
  105. def setStartTimeFormat(value: String): SARModel.this.type

    Permalink
    Definition Classes
    SARParams
  106. def setSupportThreshold(value: Int): SARModel.this.type

    Permalink
    Definition Classes
    SARParams
  107. def setTimeCol(value: String): SARModel.this.type

    Permalink

    Definition Classes
    SARParams
  108. def setTimeDecayCoeff(value: Int): SARModel.this.type

    Permalink
    Definition Classes
    SARParams
  109. def setUserCol(value: String): SARModel.this.type

    Permalink

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

    Permalink

  111. val similarityFunction: Param[String]

    Permalink
    Definition Classes
    SARParams
  112. val startTime: Param[String]

    Permalink
    Definition Classes
    SARParams
  113. val startTimeFormat: Param[String]

    Permalink
    Definition Classes
    SARParams
  114. val supportThreshold: IntParam

    Permalink
    Definition Classes
    SARParams
  115. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  116. val timeCol: Param[String]

    Permalink
    Definition Classes
    SARParams
  117. val timeDecayCoeff: IntParam

    Permalink
    Definition Classes
    SARParams
  118. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  119. def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    SARModel → Transformer
  120. def transform(rank: Int, userDataFrame: DataFrame, itemDataFrame: DataFrame, dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    BaseRecommendationModel
  121. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  122. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  123. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    SARModel → PipelineStage
  124. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  125. val uid: String

    Permalink

    The id of the module

    The id of the module

    Definition Classes
    SARModel → Identifiable
  126. val userCol: Param[String]

    Permalink
    Definition Classes
    ALSModelParams
  127. val userDataFrame: DataFrameParam

    Permalink
  128. def validateAndTransformSchema(schema: StructType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    ALSParams
  129. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. def write: MLWriter

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from SARParams

Inherited from RecommendationParams

Inherited from ALSParams

Inherited from HasSeed

Inherited from HasCheckpointInterval

Inherited from HasRegParam

Inherited from HasMaxIter

Inherited from Wrappable

Inherited from BaseRecommendationModel

Inherited from ALSModelParams

Inherited from HasPredictionCol

Inherited from Model[SARModel]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

setParam

Ungrouped