org.apache.spark.ml.regression

Interface FactorizationMachinesParams

All Superinterfaces:

HasFeaturesCol, HasFitIntercept, HasLabelCol, HasMaxIter, HasPredictionCol, HasRegParam, HasSeed, HasSolver, HasStepSize, HasTol, HasWeightCol, Identifiable, Params, PredictorParams, java.io.Serializable

All Known Subinterfaces:

FactorizationMachines, FMClassifierParams, FMRegressorParams

All Known Implementing Classes:

FMClassificationModel, FMClassifier, FMRegressionModel, FMRegressor

public interface FactorizationMachinesParams
extends PredictorParams, HasMaxIter, HasStepSize, HasTol, HasSolver, HasSeed, HasFitIntercept, HasRegParam, HasWeightCol

Params for Factorization Machines

Method Summary

Modifier and Type	Method and Description
IntParam	factorSize() Param for dimensionality of the factors (>= 0)
BooleanParam	fitLinear() Param for whether to fit linear term (aka 1-way term)
int	getFactorSize()
boolean	getFitLinear()
double	getInitStd()
double	getMiniBatchFraction()
DoubleParam	initStd() Param for standard deviation of initial coefficients
DoubleParam	miniBatchFraction() Param for mini-batch fraction, must be in range (0, 1]
Param<String>	solver() The solver algorithm for optimization.

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

extractInstances, extractInstances, validateAndTransformSchema

Methods inherited from interface org.apache.spark.ml.param.shared.HasLabelCol

getLabelCol, labelCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasFeaturesCol

featuresCol, getFeaturesCol

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

getPredictionCol, predictionCol

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

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

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

toString, uid

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

getMaxIter, maxIter

Methods inherited from interface org.apache.spark.ml.param.shared.HasStepSize

getStepSize, stepSize

Methods inherited from interface org.apache.spark.ml.param.shared.HasTol

getTol, tol

Methods inherited from interface org.apache.spark.ml.param.shared.HasSolver

getSolver

Methods inherited from interface org.apache.spark.ml.param.shared.HasSeed

getSeed, seed

Methods inherited from interface org.apache.spark.ml.param.shared.HasFitIntercept

fitIntercept, getFitIntercept

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

getRegParam, regParam

Methods inherited from interface org.apache.spark.ml.param.shared.HasWeightCol

getWeightCol, weightCol

Method Detail

factorSize

IntParam factorSize()

Param for dimensionality of the factors (>= 0)

Returns:

(undocumented)

fitLinear

BooleanParam fitLinear()

Param for whether to fit linear term (aka 1-way term)

Returns:

(undocumented)

getFactorSize

int getFactorSize()

getFitLinear

boolean getFitLinear()

getInitStd

double getInitStd()

getMiniBatchFraction

double getMiniBatchFraction()

initStd

DoubleParam initStd()

Param for standard deviation of initial coefficients

Returns:

(undocumented)

miniBatchFraction

DoubleParam miniBatchFraction()

Param for mini-batch fraction, must be in range (0, 1]

Returns:

(undocumented)

solver

Param<String> solver()

The solver algorithm for optimization. Supported options: "gd", "adamW". Default: "adamW"

Specified by:

solver in interface HasSolver

Returns:

(undocumented)