org.apache.spark.ml.recommendation

Interface ALSParams

All Superinterfaces:

HasCheckpointInterval, HasMaxIter, HasPredictionCol, HasRegParam, Identifiable, Params, java.io.Serializable

All Known Implementing Classes:

ALS, ALSModel

public interface ALSParams
extends Params, HasMaxIter, HasRegParam, HasPredictionCol, HasCheckpointInterval

Common params for ALS.

Method Summary

Methods

Modifier and Type	Method and Description
DoubleParam	alpha() Param for the alpha parameter in the implicit preference formulation.
double	getAlpha()
boolean	getImplicitPrefs()
String	getItemCol()
boolean	getNonnegative()
int	getNumItemBlocks()
int	getNumUserBlocks()
int	getRank()
String	getRatingCol()
String	getUserCol()
BooleanParam	implicitPrefs() Param to decide whether to use implicit preference.
Param<String>	itemCol() Param for the column name for item ids.
BooleanParam	nonnegative() Param for whether to apply nonnegativity constraints.
IntParam	numItemBlocks() Param for number of item blocks.
IntParam	numUserBlocks() Param for number of user blocks.
IntParam	rank() Param for rank of the matrix factorization.
Param<String>	ratingCol() Param for the column name for ratings.
Param<String>	userCol() Param for the column name for user ids.
StructType	validateAndTransformSchema(StructType schema, ParamMap paramMap) Validates and transforms the input schema.

Methods inherited from interface org.apache.spark.ml.param.HasMaxIter

getMaxIter, maxIter

Methods inherited from interface org.apache.spark.ml.param.HasRegParam

getRegParam, regParam

Methods inherited from interface org.apache.spark.ml.param.HasPredictionCol

getPredictionCol, predictionCol

Methods inherited from interface org.apache.spark.ml.param.HasCheckpointInterval

checkpointInterval, getCheckpointInterval

Methods inherited from interface org.apache.spark.ml.param.Params

addOutputColumn, checkInputColumn, explainParams, get, getParam, isSet, paramMap, params, set, set, validate, validate

Methods inherited from interface org.apache.spark.ml.Identifiable

uid

Method Detail

rank

IntParam rank()

Param for rank of the matrix factorization.

getRank

int getRank()

numUserBlocks

IntParam numUserBlocks()

Param for number of user blocks.

getNumUserBlocks

int getNumUserBlocks()

numItemBlocks

IntParam numItemBlocks()

Param for number of item blocks.

getNumItemBlocks

int getNumItemBlocks()

implicitPrefs

BooleanParam implicitPrefs()

Param to decide whether to use implicit preference.

getImplicitPrefs

boolean getImplicitPrefs()

alpha

DoubleParam alpha()

Param for the alpha parameter in the implicit preference formulation.

getAlpha

double getAlpha()

userCol

Param<String> userCol()

Param for the column name for user ids.

getUserCol

String getUserCol()

itemCol

Param<String> itemCol()

Param for the column name for item ids.

getItemCol

String getItemCol()

ratingCol

Param<String> ratingCol()

Param for the column name for ratings.

getRatingCol

String getRatingCol()

nonnegative

BooleanParam nonnegative()

Param for whether to apply nonnegativity constraints.

getNonnegative

boolean getNonnegative()

validateAndTransformSchema

StructType validateAndTransformSchema(StructType schema,
                                    ParamMap paramMap)

Validates and transforms the input schema.

Parameters:

schema - input schema

paramMap - extra params

Returns:

output schema