Record Class GradientTreeBoost.Options

java.lang.Object
java.lang.Record
smile.regression.GradientTreeBoost.Options
Record Components:
loss - loss function for regression. By default, least absolute deviation is employed for robust regression.
ntrees - the number of iterations (trees).
maxDepth - the maximum depth of the tree.
maxNodes - the maximum number of leaf nodes in the tree.
nodeSize - the minimum size of leaf nodes. Setting nodeSize = 5 generally gives good results.
shrinkage - the shrinkage parameter in (0, 1] controls the learning rate of procedure.
subsample - the sampling fraction for stochastic tree boosting.
test - the optional test data for validation per epoch.
controller - the optional training controller.
Enclosing class:
GradientTreeBoost
public static record GradientTreeBoost.Options(Loss loss, int ntrees, int maxDepth, int maxNodes, int nodeSize, double shrinkage, double subsample, DataFrame test, IterativeAlgorithmController<GradientTreeBoost.TrainingStatus> controller) extends Record
Gradient tree boosting hyperparameters.

  • Constructor Details

    • Options

      public Options(Loss loss, int ntrees, int maxDepth, int maxNodes, int nodeSize, double shrinkage, double subsample, DataFrame test, IterativeAlgorithmController<GradientTreeBoost.TrainingStatus> controller)
      Constructor.

    • Options

      public Options(int ntrees)
      Constructor with the least absolute deviation loss.
      Parameters:
      ntrees - the number of iterations (trees).

    • Options

      public Options(Loss loss, int ntrees)
      Constructor.
      Parameters:
      loss - loss function for regression.
      ntrees - the number of iterations (trees).

  • Method Details

    • toProperties

      public Properties toProperties()
      Returns the persistent set of hyperparameters.
      Returns:
      the persistent set.

    • of

      public static GradientTreeBoost.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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • loss

      public Loss loss()
      Returns the value of the loss record component.
      Returns:
      the value of the loss record component

    • ntrees

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

    • maxDepth

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

    • maxNodes

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

    • nodeSize

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

    • shrinkage

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

    • subsample

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

    • test

      public DataFrame test()
      Returns the value of the test record component.
      Returns:
      the value of the test record component

    • controller

      public IterativeAlgorithmController<GradientTreeBoost.TrainingStatus> controller()
      Returns the value of the controller record component.
      Returns:
      the value of the controller record component