Package smile.regression

Record Class ElasticNet.Options

java.lang.Object
java.lang.Record
smile.regression.ElasticNet.Options
Record Components:
lambda1 - the L1 shrinkage/regularization parameter
lambda2 - the L2 shrinkage/regularization parameter
tol - the tolerance of convergence test (relative target duality gap).
maxIter - the maximum number of IPM (Newton) iterations.
alpha - the minimum fraction of decrease in the objective function.
beta - the step size decrease factor
eta - the tolerance for PCG termination.
lsMaxIter - the maximum number of backtracking line search iterations.
pcgMaxIter - the maximum number of PCG iterations.
Enclosing class:
ElasticNet
public static record ElasticNet.Options(double lambda1, double lambda2, double tol, int maxIter, double alpha, double beta, double eta, int lsMaxIter, int pcgMaxIter) extends Record
Elastic Net hyperparameters.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Options(double lambda1, double lambda2)
    Constructor.
    Options(double lambda1, double lambda2, double tol, int maxIter)
    Constructor.
    Options(double lambda1, double lambda2, double tol, int maxIter, double alpha, double beta, double eta, int lsMaxIter, int pcgMaxIter)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    alpha()
    Returns the value of the alpha record component.
    double
    beta()
    Returns the value of the beta record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    eta()
    Returns the value of the eta record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    lambda1()
    Returns the value of the lambda1 record component.
    double
    lambda2()
    Returns the value of the lambda2 record component.
    int
    lsMaxIter()
    Returns the value of the lsMaxIter record component.
    int
    maxIter()
    Returns the value of the maxIter record component.
    static ElasticNet.Options
    of(Properties props)
    Returns the options from properties.
    int
    pcgMaxIter()
    Returns the value of the pcgMaxIter record component.
    double
    tol()
    Returns the value of the tol record component.
    Properties
    toProperties()
    Returns the persistent set of hyperparameters including smile.elastic_net.lambda1 is the L1 shrinkage/regularization parameter smile.elastic_net.lambda2 is the L2 shrinkage/regularization parameter smile.elastic_net.tolerance is the tolerance for stopping iterations (relative target duality gap).
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Options

      public Options(double lambda1, double lambda2, double tol, int maxIter, double alpha, double beta, double eta, int lsMaxIter, int pcgMaxIter)
      Constructor.

    • Options

      public Options(double lambda1, double lambda2)
      Constructor.
      Parameters:
      lambda1 - the L1 shrinkage/regularization parameter
      lambda2 - the L2 shrinkage/regularization parameter

    • Options

      public Options(double lambda1, double lambda2, double tol, int maxIter)
      Constructor.
      Parameters:
      lambda1 - the L1 shrinkage/regularization parameter
      lambda2 - the L2 shrinkage/regularization parameter
      tol - the tolerance of convergence test (relative target duality gap).
      maxIter - the maximum number of IPM (Newton) iterations.

  • Method Details

    • toProperties

      public Properties toProperties()
      Returns the persistent set of hyperparameters including
      • smile.elastic_net.lambda1 is the L1 shrinkage/regularization parameter
      • smile.elastic_net.lambda2 is the L2 shrinkage/regularization parameter
      • smile.elastic_net.tolerance is the tolerance for stopping iterations (relative target duality gap).
      • smile.elastic_net.iterations is the maximum number of IPM (Newton) iterations.
      Returns:
      the persistent set.

    • of

      public static ElasticNet.Options of(Properties props)
      Returns the options from properties.
      Parameters:
      props - the hyperparameters.
      Returns:
      the options.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • lambda1

      public double lambda1()
      Returns the value of the lambda1 record component.
      Returns:
      the value of the lambda1 record component

    • lambda2

      public double lambda2()
      Returns the value of the lambda2 record component.
      Returns:
      the value of the lambda2 record component

    • tol

      public double tol()
      Returns the value of the tol record component.
      Returns:
      the value of the tol record component

    • maxIter

      public int maxIter()
      Returns the value of the maxIter record component.
      Returns:
      the value of the maxIter record component

    • alpha

      public double alpha()
      Returns the value of the alpha record component.
      Returns:
      the value of the alpha record component

    • beta

      public double beta()
      Returns the value of the beta record component.
      Returns:
      the value of the beta record component

    • eta

      public double eta()
      Returns the value of the eta record component.
      Returns:
      the value of the eta record component

    • lsMaxIter

      public int lsMaxIter()
      Returns the value of the lsMaxIter record component.
      Returns:
      the value of the lsMaxIter record component

    • pcgMaxIter

      public int pcgMaxIter()
      Returns the value of the pcgMaxIter record component.
      Returns:
      the value of the pcgMaxIter record component