org.apache.spark.ml.recommendation

ALSModel

class ALSModel extends Model[ALSModel] with ALSParams

Model fitted by ALS.

Linear Supertypes
ALSParams, HasPredictionCol, HasRegParam, HasMaxIter, Model[ALSModel], Transformer, Params, Identifiable, PipelineStage, Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. ALSModel
  2. ALSParams
  3. HasPredictionCol
  4. HasRegParam
  5. HasMaxIter
  6. Model
  7. Transformer
  8. Params
  9. Identifiable
  10. PipelineStage
  11. Logging
  12. Serializable
  13. Serializable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addOutputColumn(schema: StructType, colName: String, dataType: DataType): StructType

    Attributes
    protected
    Definition Classes
    Params
  7. val alpha: DoubleParam

    Param for the alpha parameter in the implicit preference formulation.

    Param for the alpha parameter in the implicit preference formulation.

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

    Definition Classes
    Any
  9. def checkInputColumn(schema: StructType, colName: String, dataType: DataType): Unit

    Check whether the given schema contains an input column.

    Check whether the given schema contains an input column.

    colName

    Parameter name for the input column.

    dataType

    SQL DataType of the input column.

    Attributes
    protected
    Definition Classes
    Params
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  13. def explainParams(): String

    Returns the documentation of all params.

    Returns the documentation of all params.

    Definition Classes
    Params
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. val fittingParamMap: ParamMap

    Fitting parameters, such that parent.

    Fitting parameters, such that parent.fit(..., fittingParamMap) could reproduce the model.

    Definition Classes
    ALSModelModel
  16. def get[T](param: Param[T]): T

    Gets the value of a parameter in the embedded param map.

    Gets the value of a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  17. def getAlpha: Double

    Definition Classes
    ALSParams
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def getImplicitPrefs: Boolean

    Definition Classes
    ALSParams
  20. def getItemCol: String

    Definition Classes
    ALSParams
  21. def getMaxIter: Int

    Definition Classes
    HasMaxIter
  22. val getNonnegative: Boolean

    Definition Classes
    ALSParams
  23. def getNumItemBlocks: Int

    Definition Classes
    ALSParams
  24. def getNumUserBlocks: Int

    Definition Classes
    ALSParams
  25. def getPredictionCol: String

    Definition Classes
    HasPredictionCol
  26. def getRank: Int

    Definition Classes
    ALSParams
  27. def getRatingCol: String

    Definition Classes
    ALSParams
  28. def getRegParam: Double

    Definition Classes
    HasRegParam
  29. def getUserCol: String

    Definition Classes
    ALSParams
  30. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  31. val implicitPrefs: BooleanParam

    Param to decide whether to use implicit preference.

    Param to decide whether to use implicit preference.

    Definition Classes
    ALSParams
  32. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  33. def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  34. def isTraceEnabled(): Boolean

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

    Param for the column name for item ids.

    Param for the column name for item ids.

    Definition Classes
    ALSParams
  36. def log: Logger

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  43. def logName: String

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  48. val maxIter: IntParam

    param for max number of iterations

    param for max number of iterations

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

    Definition Classes
    AnyRef
  50. val nonnegative: BooleanParam

    Param for whether to apply nonnegativity constraints.

    Param for whether to apply nonnegativity constraints.

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

    Definition Classes
    AnyRef
  52. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  53. val numItemBlocks: IntParam

    Param for number of item blocks.

    Param for number of item blocks.

    Definition Classes
    ALSParams
  54. val numUserBlocks: IntParam

    Param for number of user blocks.

    Param for number of user blocks.

    Definition Classes
    ALSParams
  55. val paramMap: ParamMap

    Internal param map.

    Internal param map.

    Attributes
    protected
    Definition Classes
    Params
  56. def params: Array[Param[_]]

    Returns all params.

    Returns all params.

    Definition Classes
    Params
  57. val parent: ALS

    The parent estimator that produced this model.

    The parent estimator that produced this model.

    Definition Classes
    ALSModelModel
  58. val predictionCol: Param[String]

    param for prediction column name

    param for prediction column name

    Definition Classes
    HasPredictionCol
  59. val rank: IntParam

    Param for rank of the matrix factorization.

    Param for rank of the matrix factorization.

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

    Param for the column name for ratings.

    Param for the column name for ratings.

    Definition Classes
    ALSParams
  61. val regParam: DoubleParam

    param for regularization parameter

    param for regularization parameter

    Definition Classes
    HasRegParam
  62. def set[T](param: Param[T], value: T): ALSModel.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  63. def setPredictionCol(value: String): ALSModel.this.type

  64. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  65. def toString(): String

    Definition Classes
    AnyRef → Any
  66. def transform(dataset: DataFrame, paramMap: ParamMap): DataFrame

    Transforms the dataset with provided parameter map as additional parameters.

    Transforms the dataset with provided parameter map as additional parameters.

    dataset

    input dataset

    paramMap

    additional parameters, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    ALSModelTransformer
  67. def transform(dataset: DataFrame, paramPairs: ParamPair[_]*): DataFrame

    Transforms the dataset with optional parameters

    Transforms the dataset with optional parameters

    dataset

    input dataset

    paramPairs

    optional list of param pairs, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @varargs()
  68. def transformSchema(schema: StructType, paramMap: ParamMap): StructType

    :: DeveloperAPI ::

    :: DeveloperAPI ::

    Derives the output schema from the input schema and parameters. The schema describes the columns and types of the data.

    schema

    Input schema to this stage

    paramMap

    Parameters passed to this stage

    returns

    Output schema from this stage

    Definition Classes
    ALSModelPipelineStage
  69. def transformSchema(schema: StructType, paramMap: ParamMap, logging: Boolean): StructType

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

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

    Attributes
    protected
    Definition Classes
    PipelineStage
  70. val userCol: Param[String]

    Param for the column name for user ids.

    Param for the column name for user ids.

    Definition Classes
    ALSParams
  71. def validate(): Unit

    Validates parameter values stored internally.

    Validates parameter values stored internally. Raise an exception if any parameter value is invalid.

    Definition Classes
    Params
  72. def validate(paramMap: ParamMap): Unit

    Validates parameter values stored internally plus the input parameter map.

    Validates parameter values stored internally plus the input parameter map. Raises an exception if any parameter is invalid.

    Definition Classes
    Params
  73. def validateAndTransformSchema(schema: StructType, paramMap: ParamMap): StructType

    Validates and transforms the input schema.

    Validates and transforms the input schema.

    schema

    input schema

    paramMap

    extra params

    returns

    output schema

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ALSParams

Inherited from HasPredictionCol

Inherited from HasRegParam

Inherited from HasMaxIter

Inherited from Model[ALSModel]

Inherited from Transformer

Inherited from Params

Inherited from Identifiable

Inherited from PipelineStage

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

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 getters