Record Class ElasticNet.Options

java.lang.Object
java.lang.Record
smile.regression.ElasticNet.Options
Record Components:
lambda1 - L1 regularization penalty parameter.
lambda2 - L2 regularization penalty parameter.
tol - convergence tolerance on relative duality gap.
maxIter - maximum interior point method (IPM) iterations.
alpha - objective function decrease ratio threshold.
beta - backtracking line search step contraction factor.
eta - preconditioned conjugate gradient termination tolerance.
lsMaxIter - maximum backtracking line search iterations.
pcgMaxIter - maximum conjugate gradient 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
Hyperparameters for Elastic Net regression.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Options(double lambda1, double lambda2)
    Constructs options with default solver tolerances and iteration limits.
    Options(double lambda1, double lambda2, double tol, int maxIter)
    Constructs options with specified convergence tolerance and maximum iterations.
    Options(double lambda1, double lambda2, double tol, int maxIter, double alpha, double beta, double eta, int lsMaxIter, int pcgMaxIter)
    Validates hyperparameter values.

  • 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)
    Deserializes options from a Properties instance.
    int
    pcgMaxIter()
    Returns the value of the pcgMaxIter record component.
    double
    tol()
    Returns the value of the tol record component.
    Properties
    toProperties()
    Serializes options to a Properties map.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class 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)
      Validates hyperparameter values.

    • Options

      public Options(double lambda1, double lambda2)
      Constructs options with default solver tolerances and iteration limits.
      Parameters:
      lambda1 - L1 regularization penalty.
      lambda2 - L2 regularization penalty.

    • Options

      public Options(double lambda1, double lambda2, double tol, int maxIter)
      Constructs options with specified convergence tolerance and maximum iterations.
      Parameters:
      lambda1 - L1 regularization penalty.
      lambda2 - L2 regularization penalty.
      tol - convergence tolerance.
      maxIter - maximum iterations.

  • Method Details

    • toProperties

      public Properties toProperties()
      Serializes options to a Properties map.
      Returns:
      persistent configuration properties.

    • of

      public static ElasticNet.Options of(Properties props)
      Deserializes options from a Properties instance.
      Parameters:
      props - configuration properties.
      Returns:
      parsed Options record.

    • 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 the compare method from their corresponding wrapper classes.
      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