ALSModel

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

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

Attributes
protected
Definition Classes
Params
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
final def asInstanceOf[T0]: T0

Definition Classes
Any
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
val checkpointInterval: IntParam

param for checkpoint interval
param for checkpoint interval

Definition Classes
HasCheckpointInterval
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
def explainParams(): String

Returns the documentation of all params.
Returns the documentation of all params.

Definition Classes
Params
def finalize(): Unit

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

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

Definition Classes
ALSModel → Model
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
def getAlpha: Double

Definition Classes
ALSParams
def getCheckpointInterval: Int

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

Definition Classes
AnyRef → Any
def getImplicitPrefs: Boolean

Definition Classes
ALSParams
def getItemCol: String

Definition Classes
ALSParams
def getMaxIter: Int

Definition Classes
HasMaxIter
val getNonnegative: Boolean

Definition Classes
ALSParams
def getNumItemBlocks: Int

Definition Classes
ALSParams
def getNumUserBlocks: Int

Definition Classes
ALSParams
def getPredictionCol: String

Definition Classes
HasPredictionCol
def getRank: Int

Definition Classes
ALSParams
def getRatingCol: String

Definition Classes
ALSParams
def getRegParam: Double

Definition Classes
HasRegParam
def getUserCol: String

Definition Classes
ALSParams
def hashCode(): Int

Definition Classes
AnyRef → Any
val implicitPrefs: BooleanParam

Param to decide whether to use implicit preference.
Param to decide whether to use implicit preference.

Definition Classes
ALSParams
final def isInstanceOf[T0]: Boolean

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

Checks whether a param is explicitly set.
Checks whether a param is explicitly set.

Definition Classes
Params
def isTraceEnabled(): Boolean

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

Param for the column name for item ids.
Param for the column name for item ids.

Definition Classes
ALSParams
def log: Logger

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

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

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

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

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

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

Attributes
protected
Definition Classes
Logging
def logName: String

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

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

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

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

Attributes
protected
Definition Classes
Logging
val maxIter: IntParam

param for max number of iterations
param for max number of iterations

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

Definition Classes
AnyRef
val nonnegative: BooleanParam

Param for whether to apply nonnegativity constraints.
Param for whether to apply nonnegativity constraints.

Definition Classes
ALSParams
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numItemBlocks: IntParam

Param for number of item blocks.
Param for number of item blocks.

Definition Classes
ALSParams
val numUserBlocks: IntParam

Param for number of user blocks.
Param for number of user blocks.

Definition Classes
ALSParams
val paramMap: ParamMap

Internal param map.
Internal param map.

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

Returns all params.
Returns all params.

Definition Classes
Params
val parent: ALS

The parent estimator that produced this model.
The parent estimator that produced this model.

Definition Classes
ALSModel → Model
val predictionCol: Param[String]

param for prediction column name
param for prediction column name

Definition Classes
HasPredictionCol
val rank: IntParam

Param for rank of the matrix factorization.
Param for rank of the matrix factorization.

Definition Classes
ALSParams
val ratingCol: Param[String]

Param for the column name for ratings.
Param for the column name for ratings.

Definition Classes
ALSParams
val regParam: DoubleParam

param for regularization parameter
param for regularization parameter

Definition Classes
HasRegParam
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
def setPredictionCol(value: String): ALSModel.this.type
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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
ALSModel → Transformer
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()
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
ALSModel → PipelineStage
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
val userCol: Param[String]

Param for the column name for user ids.
Param for the column name for user ids.

Definition Classes
ALSParams
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
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
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
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from ALSParams

Inherited from HasCheckpointInterval

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 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

class ALSModel extends Model[ALSModel] with ALSParams

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def addOutputColumn(schema: StructType, colName: String, dataType: DataType): StructType

val alpha: DoubleParam

final def asInstanceOf[T0]: T0

def checkInputColumn(schema: StructType, colName: String, dataType: DataType): Unit

val checkpointInterval: IntParam

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def explainParams(): String

def finalize(): Unit

val fittingParamMap: ParamMap

def get[T](param: Param[T]): T

def getAlpha: Double

def getCheckpointInterval: Int

final def getClass(): Class[_]

def getImplicitPrefs: Boolean

def getItemCol: String

def getMaxIter: Int

val getNonnegative: Boolean

def getNumItemBlocks: Int

def getNumUserBlocks: Int

def getPredictionCol: String

def getRank: Int

def getRatingCol: String

def getRegParam: Double

def getUserCol: String

def hashCode(): Int

val implicitPrefs: BooleanParam

final def isInstanceOf[T0]: Boolean

def isSet(param: Param[_]): Boolean

def isTraceEnabled(): Boolean

val itemCol: Param[String]

def log: Logger

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

def logDebug(msg: ⇒ String): Unit

def logError(msg: ⇒ String, throwable: Throwable): Unit

def logError(msg: ⇒ String): Unit

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

def logInfo(msg: ⇒ String): Unit

def logName: String

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

def logTrace(msg: ⇒ String): Unit

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

def logWarning(msg: ⇒ String): Unit

val maxIter: IntParam

final def ne(arg0: AnyRef): Boolean

val nonnegative: BooleanParam

final def notify(): Unit

final def notifyAll(): Unit

val numItemBlocks: IntParam

val numUserBlocks: IntParam

val paramMap: ParamMap

def params: Array[Param[_]]

val parent: ALS

val predictionCol: Param[String]

val rank: IntParam

val ratingCol: Param[String]

val regParam: DoubleParam

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

def setPredictionCol(value: String): ALSModel.this.type

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

def toString(): String

def transform(dataset: DataFrame, paramMap: ParamMap): DataFrame

def transform(dataset: DataFrame, paramPairs: ParamPair[_]*): DataFrame

def transformSchema(schema: StructType, paramMap: ParamMap): StructType

def transformSchema(schema: StructType, paramMap: ParamMap, logging: Boolean): StructType

val userCol: Param[String]

def validate(): Unit

def validate(paramMap: ParamMap): Unit

def validateAndTransformSchema(schema: StructType, paramMap: ParamMap): StructType

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit