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, 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. BasicLogging
  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. 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. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  21. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  31. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  32. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  33. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  34. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  35. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  36. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  39. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  40. def explainParams(): String
    Definition Classes
    Params
  41. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  42. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  43. val finalStorageLevel: Param[String]
    Definition Classes
    ALSParams
  44. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  45. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  46. def getALSModel(uid: String, rank: Int, userFactors: DataFrame, itemFactors: DataFrame): ALSModel
    Definition Classes
    BaseRecommendationModel
  47. def getAlpha: Double
    Definition Classes
    ALSParams
  48. final def getBlockSize: Int
    Definition Classes
    HasBlockSize
  49. final def getCheckpointInterval: Int
    Definition Classes
    HasCheckpointInterval
  50. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  51. def getColdStartStrategy: String
    Definition Classes
    ALSModelParams
  52. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  53. def getFinalStorageLevel: String
    Definition Classes
    ALSParams
  54. def getImplicitPrefs: Boolean
    Definition Classes
    ALSParams
  55. def getIntermediateStorageLevel: String
    Definition Classes
    ALSParams
  56. def getItemCol: String
    Definition Classes
    ALSModelParams
  57. def getItemDataFrame: DataFrame

  58. final def getMaxIter: Int
    Definition Classes
    HasMaxIter
  59. def getNonnegative: Boolean
    Definition Classes
    ALSParams
  60. def getNumItemBlocks: Int
    Definition Classes
    ALSParams
  61. def getNumUserBlocks: Int
    Definition Classes
    ALSParams
  62. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  63. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  64. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  65. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  66. def getRank: Int
    Definition Classes
    ALSParams
  67. def getRatingCol: String
    Definition Classes
    ALSParams
  68. final def getRegParam: Double
    Definition Classes
    HasRegParam
  69. final def getSeed: Long
    Definition Classes
    HasSeed
  70. def getUserCol: String
    Definition Classes
    ALSModelParams
  71. def getUserDataFrame: DataFrame

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

  152. final val regParam: DoubleParam
    Definition Classes
    HasRegParam
  153. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  154. final val seed: LongParam
    Definition Classes
    HasSeed
  155. final def set(paramPair: ParamPair[_]): SARModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  156. final def set(param: String, value: Any): SARModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  157. final def set[T](param: Param[T], value: T): SARModel.this.type
    Definition Classes
    Params
  158. def setActivityTimeFormat(value: String): SARModel.this.type
    Definition Classes
    SARParams
  159. def setAlpha(value: Double): SARModel.this.type

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

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

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

    Definition Classes
    RecommendationParams
  163. final def setDefault(paramPairs: ParamPair[_]*): SARModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  164. final def setDefault[T](param: Param[T], value: T): SARModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  165. def setFinalStorageLevel(value: String): SARModel.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    SARParams
  181. def setStartTime(value: String): SARModel.this.type
    Definition Classes
    SARParams
  182. def setStartTimeFormat(value: String): SARModel.this.type
    Definition Classes
    SARParams
  183. def setSupportThreshold(value: Int): SARModel.this.type
    Definition Classes
    SARParams
  184. def setTimeCol(value: String): SARModel.this.type

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

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

  188. val similarityFunction: Param[String]
    Definition Classes
    SARParams
  189. val startTime: Param[String]
    Definition Classes
    SARParams
  190. val startTimeFormat: Param[String]
    Definition Classes
    SARParams
  191. val supportThreshold: IntParam
    Definition Classes
    SARParams
  192. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  193. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  194. val timeCol: Param[String]
    Definition Classes
    SARParams
  195. val timeDecayCoeff: IntParam
    Definition Classes
    SARParams
  196. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  197. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    SARModel → Transformer
  198. def transform(rank: Int, userDataFrame: DataFrame, itemDataFrame: DataFrame, dataset: Dataset[_]): DataFrame
    Definition Classes
    BaseRecommendationModel
  199. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  200. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  201. def transformSchema(schema: StructType): StructType
    Definition Classes
    SARModel → PipelineStage
  202. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  203. val uid: String
    Definition Classes
    SARModel → BasicLogging → Identifiable
  204. val userCol: Param[String]
    Definition Classes
    ALSModelParams
  205. val userDataFrame: DataFrameParam
  206. def validateAndTransformSchema(schema: StructType): StructType
    Attributes
    protected
    Definition Classes
    ALSParams
  207. val ver: String
    Definition Classes
    BasicLogging
  208. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  209. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  210. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  211. 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 DotnetWrappable

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