FMRegressionModel (Spark 3.5.5 JavaDoc) (original) (raw)

Object
- org.apache.spark.ml.PipelineStage
- - org.apache.spark.ml.Transformer
    - - org.apache.spark.ml.Model
        * * org.apache.spark.ml.PredictionModel<FeaturesType,M>
        * * org.apache.spark.ml.regression.RegressionModel<Vector,FMRegressionModel>
        * * org.apache.spark.ml.regression.FMRegressionModel
All Implemented Interfaces:
java.io.Serializable, org.apache.spark.internal.Logging, Params, HasFeaturesCol, HasFitIntercept, HasLabelCol, HasMaxIter, HasPredictionCol, HasRegParam, HasSeed, HasSolver, HasStepSize, HasTol, HasWeightCol, PredictorParams, FactorizationMachinesParams, FMRegressorParams, Identifiable, MLWritable

public class FMRegressionModel
extends RegressionModel<Vector,FMRegressionModel>
implements FMRegressorParams, MLWritable
See Also:
Serialized Form

Nested Class Summary

 * ### Nested classes/interfaces inherited from interface org.apache.spark.internal.Logging  
 `org.apache.spark.internal.Logging.SparkShellLoggingFilter`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method and Description
FMRegressionModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
Matrix	factors()
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
double	intercept()
Vector	linear()
static FMRegressionModel	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]
int	numFeatures() Returns the number of features the model was trained on.
double	predict(Vector features) Predict label for the given features.
static MLReader<FMRegressionModel>	read()
DoubleParam	regParam() Param for regularization parameter (>= 0).
LongParam	seed() Param for random seed.
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	toString()
String	uid() An immutable unique ID for the object and its derivatives.
Param	weightCol() Param for weight column name.
MLWriter	write() Returns an MLWriter instance for this ML instance.

   * ### Methods inherited from class org.apache.spark.ml.[PredictionModel](../../../../../org/apache/spark/ml/PredictionModel.html "class in org.apache.spark.ml")  
   `[featuresCol](../../../../../org/apache/spark/ml/PredictionModel.html#featuresCol--), [labelCol](../../../../../org/apache/spark/ml/PredictionModel.html#labelCol--), [predictionCol](../../../../../org/apache/spark/ml/PredictionModel.html#predictionCol--), [setFeaturesCol](../../../../../org/apache/spark/ml/PredictionModel.html#setFeaturesCol-java.lang.String-), [setPredictionCol](../../../../../org/apache/spark/ml/PredictionModel.html#setPredictionCol-java.lang.String-), [transform](../../../../../org/apache/spark/ml/PredictionModel.html#transform-org.apache.spark.sql.Dataset-), [transformSchema](../../../../../org/apache/spark/ml/PredictionModel.html#transformSchema-org.apache.spark.sql.types.StructType-)`  
   * ### Methods inherited from class org.apache.spark.ml.[Model](../../../../../org/apache/spark/ml/Model.html "class in org.apache.spark.ml")  
   `[hasParent](../../../../../org/apache/spark/ml/Model.html#hasParent--), [parent](../../../../../org/apache/spark/ml/Model.html#parent--), [setParent](../../../../../org/apache/spark/ml/Model.html#setParent-org.apache.spark.ml.Estimator-)`  
   * ### Methods inherited from class org.apache.spark.ml.[Transformer](../../../../../org/apache/spark/ml/Transformer.html "class in org.apache.spark.ml")  
   `[transform](../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamMap-), [transform](../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-org.apache.spark.ml.param.ParamPair...-), [transform](../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-scala.collection.Seq-)`  
   * ### Methods inherited from class org.apache.spark.ml.[PipelineStage](../../../../../org/apache/spark/ml/PipelineStage.html "class in org.apache.spark.ml")  
   `[params](../../../../../org/apache/spark/ml/PipelineStage.html#params--)`  
   * ### Methods inherited from class Object  
   `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`  
   * ### Methods inherited from interface org.apache.spark.ml.regression.[FactorizationMachinesParams](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.[PredictorParams](../../../../../org/apache/spark/ml/PredictorParams.html "interface in org.apache.spark.ml")  
   `[validateAndTransformSchema](../../../../../org/apache/spark/ml/PredictorParams.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasLabelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasFeaturesCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in 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-)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasMaxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html "interface in org.apache.spark.ml.param.shared")  
   `[getMaxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#getMaxIter--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasStepSize](../../../../../org/apache/spark/ml/param/shared/HasStepSize.html "interface in org.apache.spark.ml.param.shared")  
   `[getStepSize](../../../../../org/apache/spark/ml/param/shared/HasStepSize.html#getStepSize--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasTol](../../../../../org/apache/spark/ml/param/shared/HasTol.html "interface in org.apache.spark.ml.param.shared")  
   `[getTol](../../../../../org/apache/spark/ml/param/shared/HasTol.html#getTol--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasSolver](../../../../../org/apache/spark/ml/param/shared/HasSolver.html "interface in org.apache.spark.ml.param.shared")  
   `[getSolver](../../../../../org/apache/spark/ml/param/shared/HasSolver.html#getSolver--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html "interface in org.apache.spark.ml.param.shared")  
   `[getSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#getSeed--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasFitIntercept](../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html "interface in org.apache.spark.ml.param.shared")  
   `[getFitIntercept](../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html#getFitIntercept--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasRegParam](../../../../../org/apache/spark/ml/param/shared/HasRegParam.html "interface in org.apache.spark.ml.param.shared")  
   `[getRegParam](../../../../../org/apache/spark/ml/param/shared/HasRegParam.html#getRegParam--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html "interface in org.apache.spark.ml.param.shared")  
   `[getWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#getWeightCol--)`  
   * ### Methods inherited from interface org.apache.spark.ml.util.[MLWritable](../../../../../org/apache/spark/ml/util/MLWritable.html "interface in 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`

Method Detail

 * #### read  
 public static [MLReader](../../../../../org/apache/spark/ml/util/MLReader.html "class in org.apache.spark.ml.util")<[FMRegressionModel](../../../../../org/apache/spark/ml/regression/FMRegressionModel.html "class in org.apache.spark.ml.regression")> read()  
 * #### load  
 public static [FMRegressionModel](../../../../../org/apache/spark/ml/regression/FMRegressionModel.html "class in org.apache.spark.ml.regression") load(String path)  
 * #### factorSize  
 public final [IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param") factorSize()  
 Param for dimensionality of the factors (&gt;= 0)  
 Specified by:  
 `[factorSize](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#factorSize--)` in interface `[FactorizationMachinesParams](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html "interface in org.apache.spark.ml.regression")`  
 Returns:  
 (undocumented)  
 * #### fitLinear  
 public final [BooleanParam](../../../../../org/apache/spark/ml/param/BooleanParam.html "class in org.apache.spark.ml.param") fitLinear()  
 Param for whether to fit linear term (aka 1-way term)  
 Specified by:  
 `[fitLinear](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#fitLinear--)` in interface `[FactorizationMachinesParams](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html "interface in org.apache.spark.ml.regression")`  
 Returns:  
 (undocumented)  
 * #### miniBatchFraction  
 public final [DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param") miniBatchFraction()  
 Param for mini-batch fraction, must be in range (0, 1\]  
 Specified by:  
 `[miniBatchFraction](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#miniBatchFraction--)` in interface `[FactorizationMachinesParams](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html "interface in org.apache.spark.ml.regression")`  
 Returns:  
 (undocumented)  
 * #### initStd  
 public final [DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param") initStd()  
 Param for standard deviation of initial coefficients  
 Specified by:  
 `[initStd](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#initStd--)` in interface `[FactorizationMachinesParams](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html "interface in org.apache.spark.ml.regression")`  
 Returns:  
 (undocumented)  
 * #### solver  
 public final [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String> solver()  
 The solver algorithm for optimization. Supported options: "gd", "adamW". Default: "adamW"  
 Specified by:  
 `[solver](../../../../../org/apache/spark/ml/param/shared/HasSolver.html#solver--)` in interface `[HasSolver](../../../../../org/apache/spark/ml/param/shared/HasSolver.html "interface in org.apache.spark.ml.param.shared")`  
 Specified by:  
 `[solver](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html#solver--)` in interface `[FactorizationMachinesParams](../../../../../org/apache/spark/ml/regression/FactorizationMachinesParams.html "interface in org.apache.spark.ml.regression")`  
 Returns:  
 (undocumented)  
 * #### weightCol  
 public final [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String> weightCol()  
 Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.  
 Specified by:  
 `[weightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#weightCol--)` in interface `[HasWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### regParam  
 public final [DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param") regParam()  
 Description copied from interface: `[HasRegParam](../../../../../org/apache/spark/ml/param/shared/HasRegParam.html#regParam--)`  
 Param for regularization parameter (&gt;= 0).  
 Specified by:  
 `[regParam](../../../../../org/apache/spark/ml/param/shared/HasRegParam.html#regParam--)` in interface `[HasRegParam](../../../../../org/apache/spark/ml/param/shared/HasRegParam.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### fitIntercept  
 public final [BooleanParam](../../../../../org/apache/spark/ml/param/BooleanParam.html "class in org.apache.spark.ml.param") fitIntercept()  
 Param for whether to fit an intercept term.  
 Specified by:  
 `[fitIntercept](../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html#fitIntercept--)` in interface `[HasFitIntercept](../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### seed  
 public final [LongParam](../../../../../org/apache/spark/ml/param/LongParam.html "class in org.apache.spark.ml.param") seed()  
 Description copied from interface: `[HasSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--)`  
 Param for random seed.  
 Specified by:  
 `[seed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--)` in interface `[HasSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### tol  
 public final [DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param") tol()  
 Description copied from interface: `[HasTol](../../../../../org/apache/spark/ml/param/shared/HasTol.html#tol--)`  
 Param for the convergence tolerance for iterative algorithms (&gt;= 0).  
 Specified by:  
 `[tol](../../../../../org/apache/spark/ml/param/shared/HasTol.html#tol--)` in interface `[HasTol](../../../../../org/apache/spark/ml/param/shared/HasTol.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### stepSize  
 public [DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param") stepSize()  
 Description copied from interface: `[HasStepSize](../../../../../org/apache/spark/ml/param/shared/HasStepSize.html#stepSize--)`  
 Param for Step size to be used for each iteration of optimization (&gt; 0).  
 Specified by:  
 `[stepSize](../../../../../org/apache/spark/ml/param/shared/HasStepSize.html#stepSize--)` in interface `[HasStepSize](../../../../../org/apache/spark/ml/param/shared/HasStepSize.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### maxIter  
 public final [IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param") maxIter()  
 Description copied from interface: `[HasMaxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#maxIter--)`  
 Param for maximum number of iterations (&gt;= 0).  
 Specified by:  
 `[maxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#maxIter--)` in interface `[HasMaxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### uid  
 public String uid()  
 An immutable unique ID for the object and its derivatives.  
 Specified by:  
 `[uid](../../../../../org/apache/spark/ml/util/Identifiable.html#uid--)` in interface `[Identifiable](../../../../../org/apache/spark/ml/util/Identifiable.html "interface in org.apache.spark.ml.util")`  
 Returns:  
 (undocumented)  
 * #### intercept  
 public double intercept()  
 * #### linear  
 public [Vector](../../../../../org/apache/spark/ml/linalg/Vector.html "interface in org.apache.spark.ml.linalg") linear()  
 * #### factors  
 public [Matrix](../../../../../org/apache/spark/ml/linalg/Matrix.html "interface in org.apache.spark.ml.linalg") factors()  
 * #### numFeatures  
 public int numFeatures()  
 Returns the number of features the model was trained on. If unknown, returns -1  
 Overrides:  
 `[numFeatures](../../../../../org/apache/spark/ml/PredictionModel.html#numFeatures--)` in class `[PredictionModel](../../../../../org/apache/spark/ml/PredictionModel.html "class in org.apache.spark.ml")<[Vector](../../../../../org/apache/spark/ml/linalg/Vector.html "interface in org.apache.spark.ml.linalg"),[FMRegressionModel](../../../../../org/apache/spark/ml/regression/FMRegressionModel.html "class in org.apache.spark.ml.regression")>`  
 * #### predict  
 public double predict([Vector](../../../../../org/apache/spark/ml/linalg/Vector.html "interface in org.apache.spark.ml.linalg") features)  
 Predict label for the given features. This method is used to implement `transform()` and output `predictionCol`.  
 Specified by:  
 `[predict](../../../../../org/apache/spark/ml/PredictionModel.html#predict-FeaturesType-)` in class `[PredictionModel](../../../../../org/apache/spark/ml/PredictionModel.html "class in org.apache.spark.ml")<[Vector](../../../../../org/apache/spark/ml/linalg/Vector.html "interface in org.apache.spark.ml.linalg"),[FMRegressionModel](../../../../../org/apache/spark/ml/regression/FMRegressionModel.html "class in org.apache.spark.ml.regression")>`  
 Parameters:  
 `features` \- (undocumented)  
 Returns:  
 (undocumented)  
 * #### copy  
 public [FMRegressionModel](../../../../../org/apache/spark/ml/regression/FMRegressionModel.html "class in org.apache.spark.ml.regression") copy([ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param") extra)  
 Description copied from interface: `[Params](../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-)`  
 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. See `defaultCopy()`.  
 Specified by:  
 `[copy](../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-)` in interface `[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")`  
 Specified by:  
 `[copy](../../../../../org/apache/spark/ml/Model.html#copy-org.apache.spark.ml.param.ParamMap-)` in class `[Model](../../../../../org/apache/spark/ml/Model.html "class in org.apache.spark.ml")<[FMRegressionModel](../../../../../org/apache/spark/ml/regression/FMRegressionModel.html "class in org.apache.spark.ml.regression")>`  
 Parameters:  
 `extra` \- (undocumented)  
 Returns:  
 (undocumented)  
 * #### write  
 public [MLWriter](../../../../../org/apache/spark/ml/util/MLWriter.html "class in org.apache.spark.ml.util") write()  
 Description copied from interface: `[MLWritable](../../../../../org/apache/spark/ml/util/MLWritable.html#write--)`  
 Returns an `MLWriter` instance for this ML instance.  
 Specified by:  
 `[write](../../../../../org/apache/spark/ml/util/MLWritable.html#write--)` in interface `[MLWritable](../../../../../org/apache/spark/ml/util/MLWritable.html "interface in org.apache.spark.ml.util")`  
 Returns:  
 (undocumented)  
 * #### toString  
 public String toString()  
 Specified by:  
 `[toString](../../../../../org/apache/spark/ml/util/Identifiable.html#toString--)` in interface `[Identifiable](../../../../../org/apache/spark/ml/util/Identifiable.html "interface in org.apache.spark.ml.util")`  
 Overrides:  
 `toString` in class `Object`

FMRegressionModel (Spark 3.5.5 JavaDoc) (original) (raw)

Nested Class Summary

Method Summary

Method Detail