FMClassifier (Spark 3.5.5 JavaDoc) (original) (raw)
Method Summary
All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type | Method and Description |
---|---|
FMClassifier | copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params. |
IntParam | factorSize() Param for dimensionality of the factors (>= 0) |
BooleanParam | fitIntercept() Param for whether to fit an intercept term. |
BooleanParam | fitLinear() Param for whether to fit linear term (aka 1-way term) |
DoubleParam | initStd() Param for standard deviation of initial coefficients |
static FMClassifier | load(String path) |
IntParam | maxIter() Param for maximum number of iterations (>= 0). |
DoubleParam | miniBatchFraction() Param for mini-batch fraction, must be in range (0, 1] |
static MLReader | read() |
DoubleParam | regParam() Param for regularization parameter (>= 0). |
LongParam | seed() Param for random seed. |
FMClassifier | setFactorSize(int value) Set the dimensionality of the factors. |
FMClassifier | setFitIntercept(boolean value) Set whether to fit intercept term. |
FMClassifier | setFitLinear(boolean value) Set whether to fit linear term. |
FMClassifier | setInitStd(double value) Set the standard deviation of initial coefficients. |
FMClassifier | setMaxIter(int value) Set the maximum number of iterations. |
FMClassifier | setMiniBatchFraction(double value) Set the mini-batch fraction parameter. |
FMClassifier | setRegParam(double value) Set the L2 regularization parameter. |
FMClassifier | setSeed(long value) Set the random seed for weight initialization. |
FMClassifier | setSolver(String value) Set the solver algorithm used for optimization. |
FMClassifier | setStepSize(double value) Set the initial step size for the first step (like learning rate). |
FMClassifier | setTol(double value) Set the convergence tolerance of iterations. |
Param | solver() The solver algorithm for optimization. |
DoubleParam | stepSize() Param for Step size to be used for each iteration of optimization (> 0). |
DoubleParam | tol() Param for the convergence tolerance for iterative algorithms (>= 0). |
String | uid() An immutable unique ID for the object and its derivatives. |
Param | weightCol() Param for weight column name. |
ProbabilisticClassifier
Methods inherited from class org.apache.spark.ml.classification.
[probabilityCol](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#probabilityCol--), [setProbabilityCol](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#setProbabilityCol-java.lang.String-), [setThresholds](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#setThresholds-double:A-), [thresholds](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#thresholds--)
Classifier
Methods inherited from class org.apache.spark.ml.classification.
[rawPredictionCol](../../../../../org/apache/spark/ml/classification/Classifier.html#rawPredictionCol--), [setRawPredictionCol](../../../../../org/apache/spark/ml/classification/Classifier.html#setRawPredictionCol-java.lang.String-)
Predictor
Methods inherited from class org.apache.spark.ml.
[featuresCol](../../../../../org/apache/spark/ml/Predictor.html#featuresCol--), [fit](../../../../../org/apache/spark/ml/Predictor.html#fit-org.apache.spark.sql.Dataset-), [labelCol](../../../../../org/apache/spark/ml/Predictor.html#labelCol--), [predictionCol](../../../../../org/apache/spark/ml/Predictor.html#predictionCol--), [setFeaturesCol](../../../../../org/apache/spark/ml/Predictor.html#setFeaturesCol-java.lang.String-), [setLabelCol](../../../../../org/apache/spark/ml/Predictor.html#setLabelCol-java.lang.String-), [setPredictionCol](../../../../../org/apache/spark/ml/Predictor.html#setPredictionCol-java.lang.String-), [transformSchema](../../../../../org/apache/spark/ml/Predictor.html#transformSchema-org.apache.spark.sql.types.StructType-)
Estimator
Methods inherited from class org.apache.spark.ml.
[fit](../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamMap-), [fit](../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-org.apache.spark.ml.param.ParamPair...-), [fit](../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-scala.collection.Seq-), [fit](../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-scala.collection.Seq-)
PipelineStage
Methods inherited from class org.apache.spark.ml.
[params](../../../../../org/apache/spark/ml/PipelineStage.html#params--)
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
FactorizationMachines
Methods inherited from interface org.apache.spark.ml.regression.
[initCoefficients](../../../../../org/apache/spark/ml/regression/FactorizationMachines.html#initCoefficients-int-), [trainImpl](../../../../../org/apache/spark/ml/regression/FactorizationMachines.html#trainImpl-org.apache.spark.rdd.RDD-int-java.lang.String-)
ProbabilisticClassifierParams
Methods inherited from interface org.apache.spark.ml.classification.
[validateAndTransformSchema](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifierParams.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-)
HasLabelCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getLabelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#getLabelCol--), [labelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#labelCol--)
HasFeaturesCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[featuresCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#featuresCol--), [getFeaturesCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#getFeaturesCol--)
HasPredictionCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#getPredictionCol--), [predictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#predictionCol--)
Params
Methods inherited from interface org.apache.spark.ml.param.
[clear](../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-), [copyValues](../../../../../org/apache/spark/ml/param/Params.html#copyValues-T-org.apache.spark.ml.param.ParamMap-), [defaultCopy](../../../../../org/apache/spark/ml/param/Params.html#defaultCopy-org.apache.spark.ml.param.ParamMap-), [defaultParamMap](../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap--), [explainParam](../../../../../org/apache/spark/ml/param/Params.html#explainParam-org.apache.spark.ml.param.Param-), [explainParams](../../../../../org/apache/spark/ml/param/Params.html#explainParams--), [extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap--), [extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap-org.apache.spark.ml.param.ParamMap-), [get](../../../../../org/apache/spark/ml/param/Params.html#get-org.apache.spark.ml.param.Param-), [getDefault](../../../../../org/apache/spark/ml/param/Params.html#getDefault-org.apache.spark.ml.param.Param-), [getOrDefault](../../../../../org/apache/spark/ml/param/Params.html#getOrDefault-org.apache.spark.ml.param.Param-), [getParam](../../../../../org/apache/spark/ml/param/Params.html#getParam-java.lang.String-), [hasDefault](../../../../../org/apache/spark/ml/param/Params.html#hasDefault-org.apache.spark.ml.param.Param-), [hasParam](../../../../../org/apache/spark/ml/param/Params.html#hasParam-java.lang.String-), [isDefined](../../../../../org/apache/spark/ml/param/Params.html#isDefined-org.apache.spark.ml.param.Param-), [isSet](../../../../../org/apache/spark/ml/param/Params.html#isSet-org.apache.spark.ml.param.Param-), [onParamChange](../../../../../org/apache/spark/ml/param/Params.html#onParamChange-org.apache.spark.ml.param.Param-), [paramMap](../../../../../org/apache/spark/ml/param/Params.html#paramMap--), [params](../../../../../org/apache/spark/ml/param/Params.html#params--), [set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.Param-T-), [set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.ParamPair-), [set](../../../../../org/apache/spark/ml/param/Params.html#set-java.lang.String-java.lang.Object-), [setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-org.apache.spark.ml.param.Param-T-), [setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-scala.collection.Seq-), [shouldOwn](../../../../../org/apache/spark/ml/param/Params.html#shouldOwn-org.apache.spark.ml.param.Param-)
Identifiable
Methods inherited from interface org.apache.spark.ml.util.
[toString](../../../../../org/apache/spark/ml/util/Identifiable.html#toString--)
HasRawPredictionCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getRawPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasRawPredictionCol.html#getRawPredictionCol--), [rawPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasRawPredictionCol.html#rawPredictionCol--)
HasProbabilityCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getProbabilityCol](../../../../../org/apache/spark/ml/param/shared/HasProbabilityCol.html#getProbabilityCol--), [probabilityCol](../../../../../org/apache/spark/ml/param/shared/HasProbabilityCol.html#probabilityCol--)
HasThresholds
Methods inherited from interface org.apache.spark.ml.param.shared.
[getThresholds](../../../../../org/apache/spark/ml/param/shared/HasThresholds.html#getThresholds--), [thresholds](../../../../../org/apache/spark/ml/param/shared/HasThresholds.html#thresholds--)
FactorizationMachinesParams
Methods inherited from interface org.apache.spark.ml.regression.
[getFactorSize](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#getFactorSize--), [getFitLinear](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#getFitLinear--), [getInitStd](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#getInitStd--), [getMiniBatchFraction](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#getMiniBatchFraction--)
HasMaxIter
Methods inherited from interface org.apache.spark.ml.param.shared.
[getMaxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#getMaxIter--)
HasStepSize
Methods inherited from interface org.apache.spark.ml.param.shared.
[getStepSize](../../../../../org/apache/spark/ml/param/shared/HasStepSize.html#getStepSize--)
HasTol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getTol](../../../../../org/apache/spark/ml/param/shared/HasTol.html#getTol--)
HasSolver
Methods inherited from interface org.apache.spark.ml.param.shared.
[getSolver](../../../../../org/apache/spark/ml/param/shared/HasSolver.html#getSolver--)
HasSeed
Methods inherited from interface org.apache.spark.ml.param.shared.
[getSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#getSeed--)
HasFitIntercept
Methods inherited from interface org.apache.spark.ml.param.shared.
[getFitIntercept](../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html#getFitIntercept--)
HasRegParam
Methods inherited from interface org.apache.spark.ml.param.shared.
[getRegParam](../../../../../org/apache/spark/ml/param/shared/HasRegParam.html#getRegParam--)
HasWeightCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#getWeightCol--)
DefaultParamsWritable
Methods inherited from interface org.apache.spark.ml.util.
[write](../../../../../org/apache/spark/ml/util/DefaultParamsWritable.html#write--)
MLWritable
Methods inherited from interface org.apache.spark.ml.util.
[save](../../../../../org/apache/spark/ml/util/MLWritable.html#save-java.lang.String-)
Methods inherited from interface org.apache.spark.internal.Logging
$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize