Record Class RandomForest.Options

java.lang.Object

java.lang.Record

smile.regression.RandomForest.Options

Record Components:

ntrees - the number of trees.

mtry - the number of input variables to be used to determine the decision at a node of the tree. p/3 generally give good performance, where p is the number of variables.

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.

subsample - the sampling rate for training tree. 1.0 means sampling with replacement. < 1.0 means sampling without replacement.

seeds - optional RNG seeds for each regression tree.

controller - the optional training controller.

Enclosing class:

RandomForest

public static record RandomForest.Options(int ntrees, int mtry, int maxDepth, int maxNodes, int nodeSize, double subsample, long[] seeds, IterativeAlgorithmController<RandomForest.TrainingStatus> controller)
extends Record

Random forest hyperparameters.

Constructor Summary

Constructors

Constructor	Description
Options(int ntrees)	Constructor.
Options(int ntrees, int mtry)	Constructor.
Options(int ntrees, int mtry, int maxDepth, int maxNodes, int nodeSize, double subsample, long[] seeds, IterativeAlgorithmController<RandomForest.TrainingStatus> controller)	Constructor.

Method Summary

Modifier and Type	Method	Description
IterativeAlgorithmController<RandomForest.TrainingStatus>	controller()	Returns the value of the controller 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.
int	maxDepth()	Returns the value of the maxDepth record component.
int	maxNodes()	Returns the value of the maxNodes record component.
int	mtry()	Returns the value of the mtry record component.
int	nodeSize()	Returns the value of the nodeSize record component.
int	ntrees()	Returns the value of the ntrees record component.
static RandomForest.Options	of(Properties props)	Returns the options from properties.
long[]	seeds()	Returns the value of the seeds record component.
double	subsample()	Returns the value of the subsample record component.
Properties	toProperties()	Returns the persistent set of hyperparameters.
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(int ntrees,
 int mtry,
 int maxDepth,
 int maxNodes,
 int nodeSize,
 double subsample,
 long[] seeds,
 IterativeAlgorithmController<RandomForest.TrainingStatus> controller)

Constructor.

Options

public Options(int ntrees)

Constructor.

Parameters:

ntrees - the number of trees.

Options

public Options(int ntrees,
 int mtry)

Constructor.

Parameters:

ntrees - the number of trees.

mtry - the number of input variables to be used to determine the decision at a node of the tree. p/3 generally give good performance, where p is the number of variables.

Method Details

toProperties

public Properties toProperties()

Returns the persistent set of hyperparameters.

Returns:

the persistent set.

of

public static RandomForest.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.

ntrees

public int ntrees()

Returns the value of the ntrees record component.

Returns:

the value of the ntrees record component

mtry

public int mtry()

Returns the value of the mtry record component.

Returns:

the value of the mtry 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

subsample

public double subsample()

Returns the value of the subsample record component.

Returns:

the value of the subsample record component

seeds

public long[] seeds()

Returns the value of the seeds record component.

Returns:

the value of the seeds record component

controller

public IterativeAlgorithmController<RandomForest.TrainingStatus> controller()

Returns the value of the controller record component.

Returns:

the value of the controller record component