Interface FactorizationMachinesParams

All Superinterfaces:
HasFeaturesCol, HasFitIntercept, HasLabelCol, HasMaxIter, HasPredictionCol, HasRegParam, HasSeed, HasSolver, HasStepSize, HasTol, HasWeightCol, Identifiable, Params, PredictorParams, 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 Details

    • 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)