Record Class RidgeRegression.Options

java.lang.Object
java.lang.Record
smile.regression.RidgeRegression.Options
Record Components:
lambda - the shrinkage/regularization parameter. Large lambda means more shrinkage. Choosing an appropriate value of lambda is important, and also difficult. Its length may be 1 so that its value is applied to all variables.
beta0 - the generalized ridge penalty target. Its length may be 1 so that its value is applied to all variables.
Enclosing class:
RidgeRegression
public static record RidgeRegression.Options(double[] lambda, double[] beta0) extends Record
Ridge regression hyperparameters.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Options(double lambda)
    Constructor.
    Options(double[] lambda, double[] beta0)
    Constructor.
    Options(double lambda, double beta0)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    double[]
    beta0()
    Returns the value of the beta0 record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    double[]
    lambda()
    Returns the value of the lambda record component.
    static RidgeRegression.Options
    of(Properties props)
    Returns the options from properties.
    Properties
    toProperties()
    Returns the persistent set of hyperparameters including smile.ridge.lambda is the shrinkage/regularization parameter.
    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[] lambda, double[] beta0)
      Constructor.

    • Options

      public Options(double lambda)
      Constructor.
      Parameters:
      lambda - the shrinkage/regularization parameter.

    • Options

      public Options(double lambda, double beta0)
      Constructor.
      Parameters:
      lambda - the shrinkage/regularization parameter.
      beta0 - the generalized ridge penalty target.

  • Method Details

    • toProperties

      public Properties toProperties()
      Returns the persistent set of hyperparameters including
      • smile.ridge.lambda is the shrinkage/regularization parameter. Large lambda means more shrinkage. Choosing an appropriate value of lambda is important, and also difficult.
      • smile.ridge.standard.error is a boolean. If true, compute the estimated standard errors of the estimate of parameters
      Returns:
      the persistent set.

    • of

      public static RidgeRegression.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 Objects::equals(Object,Object).
      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.

    • lambda

      public double[] lambda()
      Returns the value of the lambda record component.
      Returns:
      the value of the lambda record component

    • beta0

      public double[] beta0()
      Returns the value of the beta0 record component.
      Returns:
      the value of the beta0 record component