org.apache.spark.ml.recommendation

Class ALSModel

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.Model<ALSModel>

org.apache.spark.ml.recommendation.ALSModel

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable, MLWritable

public class ALSModel
extends Model<ALSModel>
implements MLWritable

:: Experimental :: Model fitted by ALS.

param: rank rank of the matrix factorization model param: userFactors a DataFrame that stores user factors in two columns: id and features param: itemFactors a DataFrame that stores item factors in two columns: id and features

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ALSModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
java.lang.String	getItemCol()
java.lang.String	getUserCol()
Param<java.lang.String>	itemCol() Param for the column name for item ids.
DataFrame	itemFactors()
static ALSModel	load(java.lang.String path)
int	rank()
static MLReader<ALSModel>	read()
ALSModel	setItemCol(java.lang.String value)
ALSModel	setPredictionCol(java.lang.String value)
ALSModel	setUserCol(java.lang.String value)
DataFrame	transform(DataFrame dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
java.lang.String	uid() An immutable unique ID for the object and its derivatives.
Param<java.lang.String>	userCol() Param for the column name for user ids.
DataFrame	userFactors()
MLWriter	write() Returns an MLWriter instance for this ML instance.

Methods inherited from class org.apache.spark.ml.Model

hasParent, parent, setParent

Methods inherited from class org.apache.spark.ml.Transformer

transform, transform, transform

Methods inherited from class org.apache.spark.ml.PipelineStage

transformSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

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

toString

Methods inherited from interface org.apache.spark.ml.util.MLWritable

save

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Method Detail

read

public static MLReader<ALSModel> read()

load

public static ALSModel load(java.lang.String path)

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

rank

public int rank()

userFactors

public DataFrame userFactors()

itemFactors

public DataFrame itemFactors()

setUserCol

public ALSModel setUserCol(java.lang.String value)

setItemCol

public ALSModel setItemCol(java.lang.String value)

setPredictionCol

public ALSModel setPredictionCol(java.lang.String value)

transform

public DataFrame transform(DataFrame dataset)

Description copied from class: Transformer

Transforms the input dataset.

Specified by:

transform in class Transformer

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

copy

public ALSModel copy(ParamMap extra)

Description copied from interface: 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.

Specified by:

copy in interface Params

Specified by:

copy in class Model<ALSModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

write

public MLWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)

userCol

public Param<java.lang.String> userCol()

Param for the column name for user ids. Default: "user"

Returns:

(undocumented)

getUserCol

public java.lang.String getUserCol()

itemCol

public Param<java.lang.String> itemCol()

Param for the column name for item ids. Default: "item"

Returns:

(undocumented)

getItemCol

public java.lang.String getItemCol()