Record Class AdaBoost.Options

java.lang.Object

java.lang.Record

smile.classification.AdaBoost.Options

Record Components:

ntrees - the number of 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.

test - the optional test data for validation per epoch.

controller - the optional training controller.

Enclosing class:

AdaBoost

public static record AdaBoost.Options(int ntrees, int maxDepth, int maxNodes, int nodeSize, DataFrame test, IterativeAlgorithmController<AdaBoost.TrainingStatus> controller)
extends Record

AdaBoost hyperparameters.

Constructor Summary

Constructors

Constructor	Description
Options(int ntrees)	Constructor.
Options(int ntrees, int maxDepth, int maxNodes, int nodeSize, DataFrame test, IterativeAlgorithmController<AdaBoost.TrainingStatus> controller)	Constructor.

Method Summary

Modifier and Type	Method	Description
IterativeAlgorithmController<AdaBoost.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	nodeSize()	Returns the value of the nodeSize record component.
int	ntrees()	Returns the value of the ntrees record component.
static AdaBoost.Options	of(Properties props)	Returns the options from properties.
DataFrame	test()	Returns the value of the test 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 maxDepth,
 int maxNodes,
 int nodeSize,
 DataFrame test,
 IterativeAlgorithmController<AdaBoost.TrainingStatus> controller)

Constructor.

Options

public Options(int ntrees)

Constructor.

Parameters:

ntrees - the number of trees.

Method Details

toProperties

public Properties toProperties()

Returns the persistent set of hyperparameters.

Returns:

the persistent set.

of

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

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

test

public DataFrame test()

Returns the value of the test record component.

Returns:

the value of the test record component

controller

public IterativeAlgorithmController<AdaBoost.TrainingStatus> controller()

Returns the value of the controller record component.

Returns:

the value of the controller record component