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

SAR Model

Linear Supertypes
BasicLogging, 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. BasicLogging
  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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val activityTimeFormat: Param[String]
    Definition Classes
    SARParams
  6. val alpha: DoubleParam
    Definition Classes
    ALSParams
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final val blockSize: IntParam
    Definition Classes
    HasBlockSize
  9. val checkedCast: UserDefinedFunction
    Attributes
    protected[org.apache.spark.ml.recommendation]
    Definition Classes
    ALSModelParams
  10. final val checkpointInterval: IntParam
    Definition Classes
    HasCheckpointInterval
  11. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  12. final def clear(param: Param[_]): SARModel.this.type
    Definition Classes
    Params
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. val coldStartStrategy: Param[String]
    Definition Classes
    ALSModelParams
  15. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  16. def copy(extra: ParamMap): SARModel
    Definition Classes
    SARModel → Model → Transformer → PipelineStage → Params
  17. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  18. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  22. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  23. def explainParams(): String
    Definition Classes
    Params
  24. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  25. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  26. val finalStorageLevel: Param[String]
    Definition Classes
    ALSParams
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. def getALSModel(uid: String, rank: Int, userFactors: DataFrame, itemFactors: DataFrame): ALSModel
    Definition Classes
    BaseRecommendationModel
  30. def getAlpha: Double
    Definition Classes
    ALSParams
  31. final def getBlockSize: Int
    Definition Classes
    HasBlockSize
  32. final def getCheckpointInterval: Int
    Definition Classes
    HasCheckpointInterval
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def getColdStartStrategy: String
    Definition Classes
    ALSModelParams
  35. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  36. def getFinalStorageLevel: String
    Definition Classes
    ALSParams
  37. def getImplicitPrefs: Boolean
    Definition Classes
    ALSParams
  38. def getIntermediateStorageLevel: String
    Definition Classes
    ALSParams
  39. def getItemCol: String
    Definition Classes
    ALSModelParams
  40. def getItemDataFrame: DataFrame

  41. final def getMaxIter: Int
    Definition Classes
    HasMaxIter
  42. def getNonnegative: Boolean
    Definition Classes
    ALSParams
  43. def getNumItemBlocks: Int
    Definition Classes
    ALSParams
  44. def getNumUserBlocks: Int
    Definition Classes
    ALSParams
  45. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  46. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  47. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  48. def getRank: Int
    Definition Classes
    ALSParams
  49. def getRatingCol: String
    Definition Classes
    ALSParams
  50. final def getRegParam: Double
    Definition Classes
    HasRegParam
  51. final def getSeed: Long
    Definition Classes
    HasSeed
  52. def getUserCol: String
    Definition Classes
    ALSModelParams
  53. def getUserDataFrame: DataFrame

  54. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  55. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  56. def hasParent: Boolean
    Definition Classes
    Model
  57. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. val implicitPrefs: BooleanParam
    Definition Classes
    ALSParams
  59. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  60. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. val intermediateStorageLevel: Param[String]
    Definition Classes
    ALSParams
  62. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  63. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  64. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  65. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  66. val itemCol: Param[String]
    Definition Classes
    ALSModelParams
  67. val itemDataFrame: DataFrameParam
  68. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  69. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  70. def logClass(): Unit
    Definition Classes
    BasicLogging
  71. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  76. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  77. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  80. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  81. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  84. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  85. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  86. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  89. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  90. final val maxIter: IntParam
    Definition Classes
    HasMaxIter
  91. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  92. val nonnegative: BooleanParam
    Definition Classes
    ALSParams
  93. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  94. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  95. val numItemBlocks: IntParam
    Definition Classes
    ALSParams
  96. val numUserBlocks: IntParam
    Definition Classes
    ALSParams
  97. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  98. var parent: Estimator[SARModel]
    Definition Classes
    Model
  99. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  100. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  101. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  102. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  103. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  104. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  105. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  106. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  107. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    SARModel → PythonWrappable
  108. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  109. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  110. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  111. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  112. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  113. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  114. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  115. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  116. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  117. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  118. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  119. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  120. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  121. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  122. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  123. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  124. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  125. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  126. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  127. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  128. val rank: IntParam
    Definition Classes
    ALSParams
  129. val ratingCol: Param[String]
    Definition Classes
    ALSParams
  130. def recommendForAllItems(numItems: Int): DataFrame
    Definition Classes
    SARModel → BaseRecommendationModel
  131. 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
    SARModel → BaseRecommendationModel
  132. 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.

  133. final val regParam: DoubleParam
    Definition Classes
    HasRegParam
  134. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  135. final val seed: LongParam
    Definition Classes
    HasSeed
  136. final def set(paramPair: ParamPair[_]): SARModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  137. final def set(param: String, value: Any): SARModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  138. final def set[T](param: Param[T], value: T): SARModel.this.type
    Definition Classes
    Params
  139. def setActivityTimeFormat(value: String): SARModel.this.type
    Definition Classes
    SARParams
  140. final def setDefault(paramPairs: ParamPair[_]*): SARModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  141. final def setDefault[T](param: Param[T], value: T): SARModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  142. def setItemCol(value: String): SARModel.this.type

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

  144. def setParent(parent: Estimator[SARModel]): SARModel
    Definition Classes
    Model
  145. def setRatingCol(value: String): SARModel.this.type

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

    Definition Classes
    SARParams
  147. def setStartTime(value: String): SARModel.this.type
    Definition Classes
    SARParams
  148. def setStartTimeFormat(value: String): SARModel.this.type
    Definition Classes
    SARParams
  149. def setSupportThreshold(value: Int): SARModel.this.type
    Definition Classes
    SARParams
  150. def setTimeCol(value: String): SARModel.this.type

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

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

  154. val similarityFunction: Param[String]
    Definition Classes
    SARParams
  155. val startTime: Param[String]
    Definition Classes
    SARParams
  156. val startTimeFormat: Param[String]
    Definition Classes
    SARParams
  157. val supportThreshold: IntParam
    Definition Classes
    SARParams
  158. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  159. val timeCol: Param[String]
    Definition Classes
    SARParams
  160. val timeDecayCoeff: IntParam
    Definition Classes
    SARParams
  161. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  162. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    SARModel → Transformer
  163. def transform(rank: Int, userDataFrame: DataFrame, itemDataFrame: DataFrame, dataset: Dataset[_]): DataFrame
    Definition Classes
    BaseRecommendationModel
  164. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  165. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  166. def transformSchema(schema: StructType): StructType
    Definition Classes
    SARModel → PipelineStage
  167. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  168. val uid: String
    Definition Classes
    SARModel → BasicLogging → Identifiable
  169. val userCol: Param[String]
    Definition Classes
    ALSModelParams
  170. val userDataFrame: DataFrameParam
  171. def validateAndTransformSchema(schema: StructType): StructType
    Attributes
    protected
    Definition Classes
    ALSParams
  172. val ver: String
    Definition Classes
    BasicLogging
  173. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  174. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  175. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  176. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from BasicLogging

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 RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from BaseRecommendationModel

Inherited from ALSModelParams

Inherited from HasBlockSize

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