Package smile.classification

Record Class RandomForest.Model

java.lang.Object

java.lang.Record

smile.classification.RandomForest.Model

Record Components:

tree - The decision tree.

metrics - The validation metrics on out-of-bag samples.

weight - The weight of tree, which is used for aggregating tree votes.

All Implemented Interfaces:

Serializable, Comparable<RandomForest.Model>

Enclosing class:

RandomForest

public static record RandomForest.Model(DecisionTree tree, ClassificationMetrics metrics, double weight)
extends Record
implements Serializable, Comparable<RandomForest.Model>

The base model.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Model(DecisionTree tree, ClassificationMetrics metrics)	Constructor.
Model(DecisionTree tree, ClassificationMetrics metrics, double weight)	Creates an instance of a Model record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(RandomForest.Model o)
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.
ClassificationMetrics	metrics()	Returns the value of the metrics record component.
final String	toString()	Returns a string representation of this record class.
DecisionTree	tree()	Returns the value of the tree record component.
double	weight()	Returns the value of the weight record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Model

public Model(DecisionTree tree,
 ClassificationMetrics metrics)

Constructor. OOB accuracy will be used as weight.

Parameters:

tree - The decision tree.

metrics - The validation metrics on out-of-bag samples.

Model

public Model(DecisionTree tree,
 ClassificationMetrics metrics,
 double weight)

Creates an instance of a Model record class.

Parameters:

tree - the value for the tree record component

metrics - the value for the metrics record component

weight - the value for the weight record component

Method Details

compareTo

public int compareTo(RandomForest.Model o)

Specified by:

compareTo in interface Comparable<RandomForest.Model>

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 '=='.

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.

tree

public DecisionTree tree()

Returns the value of the tree record component.

Returns:

the value of the tree record component

metrics

public ClassificationMetrics metrics()

Returns the value of the metrics record component.

Returns:

the value of the metrics record component

weight

public double weight()

Returns the value of the weight record component.

Returns:

the value of the weight record component