Record Class DecisionTree.Options

java.lang.Object

java.lang.Record

smile.classification.DecisionTree.Options

Record Components:

rule - the splitting rule.

maxDepth - the maximum depth of the tree.

maxNodes - the maximum number of leaf nodes in the tree.

nodeSize - the minimum size of leaf nodes.

Enclosing class:

DecisionTree

public static record DecisionTree.Options(SplitRule rule, int maxDepth, int maxNodes, int nodeSize)
extends Record

Decision tree hyperparameters.

Constructor Summary

Constructors

Constructor	Description
Options()	Constructor.
Options(SplitRule rule, int maxDepth, int maxNodes, int nodeSize)	Constructor.

Method Summary

Modifier and Type	Method	Description
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.
static DecisionTree.Options	of(Properties props)	Returns the options from properties.
SplitRule	rule()	Returns the value of the rule record component.
Properties	toProperties()	Returns the persistent set of hyperparameters including smile.cart.split_rule smile.cart.max_depth smile.cart.max_nodes smile.cart.node_size
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(SplitRule rule,
 int maxDepth,
 int maxNodes,
 int nodeSize)

Constructor.

Options

public Options()

Constructor.

Method Details

toProperties

public Properties toProperties()

Returns the persistent set of hyperparameters including

• smile.cart.split_rule
• smile.cart.max_depth
• smile.cart.max_nodes
• smile.cart.node_size

Returns:

the persistent set.

of

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

rule

public SplitRule rule()

Returns the value of the rule record component.

Returns:

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