Package smile.regression

Record Class GradientTreeBoost.TrainingStatus

java.lang.Object

java.lang.Record

smile.regression.GradientTreeBoost.TrainingStatus

Record Components:

tree - the tree index, starting at 1.

loss - the current loss function value.

metrics - the optional validation metrics if test data is provided.

Enclosing class:

GradientTreeBoost

public static record GradientTreeBoost.TrainingStatus(int tree, double loss, RegressionMetrics metrics)
extends Record

Training status per tree.

Constructor Summary

Constructors

Constructor	Description
TrainingStatus(int tree, double loss, RegressionMetrics metrics)	Creates an instance of a TrainingStatus record class.

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.
double	loss()	Returns the value of the loss record component.
RegressionMetrics	metrics()	Returns the value of the metrics record component.
final String	toString()	Returns a string representation of this record class.
int	tree()	Returns the value of the tree record component.

Methods inherited from class java.lang.Object

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

Constructor Details

TrainingStatus

public TrainingStatus(int tree,
 double loss,
 RegressionMetrics metrics)

Creates an instance of a TrainingStatus record class.

Parameters:

tree - the value for the tree record component

loss - the value for the loss record component

metrics - the value for the metrics record component

Method Details

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 int tree()

Returns the value of the tree record component.

Returns:

the value of the tree record component

loss

public double loss()

Returns the value of the loss record component.

Returns:

the value of the loss record component

metrics

public RegressionMetrics metrics()

Returns the value of the metrics record component.

Returns:

the value of the metrics record component