Record Class RegressionValidations<M>

java.lang.Object

java.lang.Record

smile.validation.RegressionValidations<M>

Type Parameters:

M - The regression model type.

Record Components:

rounds - The multiple round validations.

avg - The average of metrics.

std - The standard deviation of metrics.

All Implemented Interfaces:

Serializable

public record RegressionValidations<M>(List<RegressionValidation<M>> rounds, RegressionMetrics avg, RegressionMetrics std)
extends Record
implements Serializable

Regression model validation results.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RegressionValidations(List<RegressionValidation<M>> rounds, RegressionMetrics avg, RegressionMetrics std)	Creates an instance of a RegressionValidations record class.

Method Summary

Modifier and Type	Method	Description
RegressionMetrics	avg()	Returns the value of the avg 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.
static <M> RegressionValidations<M>	of(List<RegressionValidation<M>> rounds)	Factory method.
List<RegressionValidation<M>>	rounds()	Returns the value of the rounds record component.
RegressionMetrics	std()	Returns the value of the std record component.
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

RegressionValidations

public RegressionValidations(List<RegressionValidation<M>> rounds,
 RegressionMetrics avg,
 RegressionMetrics std)

Creates an instance of a RegressionValidations record class.

Parameters:

rounds - the value for the rounds record component

avg - the value for the avg record component

std - the value for the std record component

Method Details

of

public static <M> RegressionValidations<M> of(List<RegressionValidation<M>> rounds)

Factory method.

Type Parameters:

M - the regression model type.

Parameters:

rounds - the validation metrics of multiple rounds.

Returns:

the validation object.

toString

public 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

rounds

public List<RegressionValidation<M>> rounds()

Returns the value of the rounds record component.

Returns:

the value of the rounds record component

avg

public RegressionMetrics avg()

Returns the value of the avg record component.

Returns:

the value of the avg record component

std

public RegressionMetrics std()

Returns the value of the std record component.

Returns:

the value of the std record component