Class/Object

org.apache.spark.ml.recommendation

ALS

Related Docs: object ALS | package recommendation

Permalink

class ALS extends Estimator[ALSModel] with ALSParams with DefaultParamsWritable

Alternating Least Squares (ALS) matrix factorization.

ALS attempts to estimate the ratings matrix R as the product of two lower-rank matrices, X and Y, i.e. X * Yt = R. Typically these approximations are called 'factor' matrices. The general approach is iterative. During each iteration, one of the factor matrices is held constant, while the other is solved for using least squares. The newly-solved factor matrix is then held constant while solving for the other factor matrix.

This is a blocked implementation of the ALS factorization algorithm that groups the two sets of factors (referred to as "users" and "products") into blocks and reduces communication by only sending one copy of each user vector to each product block on each iteration, and only for the product blocks that need that user's feature vector. This is achieved by pre-computing some information about the ratings matrix to determine the "out-links" of each user (which blocks of products it will contribute to) and "in-link" information for each product (which of the feature vectors it receives from each user block it will depend on). This allows us to send only an array of feature vectors between each user block and product block, and have the product block find the users' ratings and update the products based on these messages.

For implicit preference data, the algorithm used is based on "Collaborative Filtering for Implicit Feedback Datasets", available at http://dx.doi.org/10.1109/ICDM.2008.22, adapted for the blocked approach used here.

Essentially instead of finding the low-rank approximations to the rating matrix R, this finds the approximations for a preference matrix P where the elements of P are 1 if r is greater than 0 and 0 if r is less than or equal to 0. The ratings then act as 'confidence' values related to strength of indicated user preferences rather than explicit ratings given to items.

Annotations
@Since( "1.3.0" )
Source
ALS.scala
Linear Supertypes
DefaultParamsWritable, MLWritable, ALSParams, HasSeed, HasCheckpointInterval, HasRegParam, HasMaxIter, ALSModelParams, HasPredictionCol, Estimator[ALSModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ALS
  2. DefaultParamsWritable
  3. MLWritable
  4. ALSParams
  5. HasSeed
  6. HasCheckpointInterval
  7. HasRegParam
  8. HasMaxIter
  9. ALSModelParams
  10. HasPredictionCol
  11. Estimator
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Serializable
  17. Identifiable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ALS()

    Permalink
    Annotations
    @Since( "1.4.0" )
  2. new ALS(uid: String)

    Permalink

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

    An alias for getOrDefault().

    An alias for getOrDefault().

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

    Permalink
    Definition Classes
    AnyRef → Any
  5. val alpha: DoubleParam

    Permalink

    Param for the alpha parameter in the implicit preference formulation (nonnegative).

    Param for the alpha parameter in the implicit preference formulation (nonnegative). Default: 1.0

    Definition Classes
    ALSParams
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val checkedCast: UserDefinedFunction

    Permalink

    Attempts to safely cast a user/item id to an Int.

    Attempts to safely cast a user/item id to an Int. Throws an exception if the value is out of integer range.

    Attributes
    protected
    Definition Classes
    ALSModelParams
  8. final val checkpointInterval: IntParam

    Permalink

    Param for set checkpoint interval (>= 1) or disable checkpoint (-1).

    Param for set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10 means that the cache will get checkpointed every 10 iterations.

    Definition Classes
    HasCheckpointInterval
  9. final def clear(param: Param[_]): ALS.this.type

    Permalink

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def copy(extra: ParamMap): ALS

    Permalink

    Creates a copy of this instance with the same UID and some extra params.

    Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

    Definition Classes
    ALSEstimatorPipelineStageParams
    Annotations
    @Since( "1.5.0" )
  12. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Permalink

    Copies param values from this instance to another instance for params shared by them.

    Copies param values from this instance to another instance for params shared by them.

    This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

    to

    the target instance, which should work with the same set of default Params as this source instance

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

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

    Permalink

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

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

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

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

    Permalink

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

    a string that contains the input param name, doc, and optionally its default value and the user-supplied value

    Definition Classes
    Params
  17. def explainParams(): String

    Permalink

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes
    Params
  18. final def extractParamMap(): ParamMap

    Permalink

    extractParamMap with no extra values.

    extractParamMap with no extra values.

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

    Permalink

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Definition Classes
    Params
  20. val finalStorageLevel: Param[String]

    Permalink

    Param for StorageLevel for ALS model factors.

    Param for StorageLevel for ALS model factors. Pass in a string representation of StorageLevel. Default: "MEMORY_AND_DISK".

    Definition Classes
    ALSParams
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def fit(dataset: Dataset[_]): ALSModel

    Permalink

    Fits a model to the input data.

    Fits a model to the input data.

    Definition Classes
    ALSEstimator
    Annotations
    @Since( "2.0.0" )
  23. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[ALSModel]

    Permalink

    Fits multiple models to the input data with multiple sets of parameters.

    Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could override this to optimize multi-model training.

    dataset

    input dataset

    paramMaps

    An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted models, matching the input parameter maps

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], paramMap: ParamMap): ALSModel

    Permalink

    Fits a single model to the input data with provided parameter map.

    Fits a single model to the input data with provided parameter map.

    dataset

    input dataset

    paramMap

    Parameter map. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  25. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): ALSModel

    Permalink

    Fits a single model to the input data with optional parameters.

    Fits a single model to the input data with optional parameters.

    dataset

    input dataset

    firstParamPair

    the first param pair, overrides embedded params

    otherParamPairs

    other param pairs. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  26. final def get[T](param: Param[T]): Option[T]

    Permalink

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  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. final def getDefault[T](param: Param[T]): Option[T]

    Permalink

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  31. def getFinalStorageLevel: String

    Permalink

    Definition Classes
    ALSParams
  32. def getImplicitPrefs: Boolean

    Permalink

    Definition Classes
    ALSParams
  33. def getIntermediateStorageLevel: String

    Permalink

    Definition Classes
    ALSParams
  34. def getItemCol: String

    Permalink

    Definition Classes
    ALSModelParams
  35. final def getMaxIter: Int

    Permalink

    Definition Classes
    HasMaxIter
  36. def getNonnegative: Boolean

    Permalink

    Definition Classes
    ALSParams
  37. def getNumItemBlocks: Int

    Permalink

    Definition Classes
    ALSParams
  38. def getNumUserBlocks: Int

    Permalink

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

    Permalink

    Gets the value of a param in the embedded param map or its default value.

    Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

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

    Permalink

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  41. final def getPredictionCol: String

    Permalink

    Definition Classes
    HasPredictionCol
  42. def getRank: Int

    Permalink

    Definition Classes
    ALSParams
  43. def getRatingCol: String

    Permalink

    Definition Classes
    ALSParams
  44. final def getRegParam: Double

    Permalink

    Definition Classes
    HasRegParam
  45. final def getSeed: Long

    Permalink

    Definition Classes
    HasSeed
  46. def getUserCol: String

    Permalink

    Definition Classes
    ALSModelParams
  47. final def hasDefault[T](param: Param[T]): Boolean

    Permalink

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

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

    Permalink

    Tests whether this instance contains a param with a given name.

    Tests whether this instance contains a param with a given name.

    Definition Classes
    Params
  49. def hashCode(): Int

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

    Permalink

    Param to decide whether to use implicit preference.

    Param to decide whether to use implicit preference. Default: false

    Definition Classes
    ALSParams
  51. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

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

    Permalink

    Param for StorageLevel for intermediate datasets.

    Param for StorageLevel for intermediate datasets. Pass in a string representation of StorageLevel. Cannot be "NONE". Default: "MEMORY_AND_DISK".

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

    Permalink

    Checks whether a param is explicitly set or has a default value.

    Checks whether a param is explicitly set or has a default value.

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

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

    Permalink

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  56. def isTraceEnabled(): Boolean

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

    Permalink

    Param for the column name for item ids.

    Param for the column name for item ids. Ids must be integers. Other numeric types are supported for this column, but will be cast to integers as long as they fall within the integer value range. Default: "item"

    Definition Classes
    ALSModelParams
  58. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Param for maximum number of iterations (>= 0).

    Param for maximum number of iterations (>= 0).

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

    Permalink
    Definition Classes
    AnyRef
  72. val nonnegative: BooleanParam

    Permalink

    Param for whether to apply nonnegativity constraints.

    Param for whether to apply nonnegativity constraints. Default: false

    Definition Classes
    ALSParams
  73. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  75. val numItemBlocks: IntParam

    Permalink

    Param for number of item blocks (positive).

    Param for number of item blocks (positive). Default: 10

    Definition Classes
    ALSParams
  76. val numUserBlocks: IntParam

    Permalink

    Param for number of user blocks (positive).

    Param for number of user blocks (positive). Default: 10

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

    Permalink

    Returns all params sorted by their names.

    Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

    Definition Classes
    Params
    Note

    Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

  78. final val predictionCol: Param[String]

    Permalink

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  79. val rank: IntParam

    Permalink

    Param for rank of the matrix factorization (positive).

    Param for rank of the matrix factorization (positive). Default: 10

    Definition Classes
    ALSParams
  80. val ratingCol: Param[String]

    Permalink

    Param for the column name for ratings.

    Param for the column name for ratings. Default: "rating"

    Definition Classes
    ALSParams
  81. final val regParam: DoubleParam

    Permalink

    Param for regularization parameter (>= 0).

    Param for regularization parameter (>= 0).

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

    Permalink

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Saves this ML instance to the input path, a shortcut of write.save(path).

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

    Permalink

    Param for random seed.

    Param for random seed.

    Definition Classes
    HasSeed
  84. final def set(paramPair: ParamPair[_]): ALS.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  85. final def set(param: String, value: Any): ALS.this.type

    Permalink

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

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

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  87. def setAlpha(value: Double): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  88. def setCheckpointInterval(value: Int): ALS.this.type

    Permalink

    Annotations
    @Since( "1.4.0" )
  89. final def setDefault(paramPairs: ParamPair[_]*): ALS.this.type

    Permalink

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

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

    Permalink

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes
    protected
    Definition Classes
    Params
  91. def setFinalStorageLevel(value: String): ALS.this.type

    Permalink

    Annotations
    @Since( "2.0.0" )
  92. def setImplicitPrefs(value: Boolean): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  93. def setIntermediateStorageLevel(value: String): ALS.this.type

    Permalink

    Annotations
    @Since( "2.0.0" )
  94. def setItemCol(value: String): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  95. def setMaxIter(value: Int): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  96. def setNonnegative(value: Boolean): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  97. def setNumBlocks(value: Int): ALS.this.type

    Permalink

    Sets both numUserBlocks and numItemBlocks to the specific value.

    Sets both numUserBlocks and numItemBlocks to the specific value.

    Annotations
    @Since( "1.3.0" )
  98. def setNumItemBlocks(value: Int): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  99. def setNumUserBlocks(value: Int): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  100. def setPredictionCol(value: String): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  101. def setRank(value: Int): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  102. def setRatingCol(value: String): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  103. def setRegParam(value: Double): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  104. def setSeed(value: Long): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  105. def setUserCol(value: String): ALS.this.type

    Permalink

    Annotations
    @Since( "1.3.0" )
  106. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  107. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  108. def transformSchema(schema: StructType): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Check transform validity and derive the output schema from the input schema.

    We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

    Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

    Definition Classes
    ALSPipelineStage
    Annotations
    @Since( "1.3.0" )
  109. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Derives the output schema from the input schema and parameters, optionally with logging.

    This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

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

    Permalink

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    ALSIdentifiable
    Annotations
    @Since( "1.4.0" )
  111. val userCol: Param[String]

    Permalink

    Param for the column name for user ids.

    Param for the column name for user ids. Ids must be integers. Other numeric types are supported for this column, but will be cast to integers as long as they fall within the integer value range. Default: "user"

    Definition Classes
    ALSModelParams
  112. def validateAndTransformSchema(schema: StructType): StructType

    Permalink

    Validates and transforms the input schema.

    Validates and transforms the input schema.

    schema

    input schema

    returns

    output schema

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

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

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

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

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    DefaultParamsWritableMLWritable

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from ALSParams

Inherited from HasSeed

Inherited from HasCheckpointInterval

Inherited from HasRegParam

Inherited from HasMaxIter

Inherited from ALSModelParams

Inherited from HasPredictionCol

Inherited from Estimator[ALSModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters

(expert-only) Parameters

A list of advanced, expert-only (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

(expert-only) Parameter setters

(expert-only) Parameter getters