Record Class ClassificationModel

java.lang.Object

java.lang.Record

smile.model.ClassificationModel

Record Components:

algorithm - the algorithm name.

schema - the schema of input data (without response variable).

formula - the model formula.

classifier - the classification model.

train - the training metrics.

validation - the cross-validation metrics.

test - the test metrics.

tags - the model metadata tags.

All Implemented Interfaces:

Serializable, Model

public record ClassificationModel(String algorithm, StructType schema, Formula formula, DataFrameClassifier classifier, ClassificationMetrics train, ClassificationMetrics validation, ClassificationMetrics test, Properties tags)
extends Record
implements Model, Serializable

The classification model.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface Model

ID, VERSION

Constructor Summary

Constructors

Constructor	Description
ClassificationModel(String algorithm, StructType schema, Formula formula, DataFrameClassifier classifier, ClassificationMetrics train, ClassificationMetrics validation, ClassificationMetrics test, Properties tags)	Creates an instance of a ClassificationModel record class.

Method Summary

Modifier and Type	Method	Description
String	algorithm()	Returns the value of the algorithm record component.
DataFrameClassifier	classifier()	Returns the value of the classifier record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Formula	formula()	Returns the value of the formula record component.
final int	hashCode()	Returns a hash code value for this object.
int	numClasses()	Returns the number of classes.
int	predict(Tuple x)	Model inference.
int	predict(Tuple x, double[] posteriori)	Model inference.
StructType	schema()	Returns the value of the schema record component.
Properties	tags()	Returns the value of the tags record component.
ClassificationMetrics	test()	Returns the value of the test record component.
final String	toString()	Returns a string representation of this record class.
ClassificationMetrics	train()	Returns the value of the train record component.
ClassificationMetrics	validation()	Returns the value of the validation record component.

Methods inherited from class Object

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

Methods inherited from interface Model

getTag, getTag, setProperty

Constructor Details

ClassificationModel

public ClassificationModel(String algorithm,
 StructType schema,
 Formula formula,
 DataFrameClassifier classifier,
 ClassificationMetrics train,
 ClassificationMetrics validation,
 ClassificationMetrics test,
 Properties tags)

Creates an instance of a ClassificationModel record class.

Parameters:

algorithm - the value for the algorithm record component

schema - the value for the schema record component

formula - the value for the formula record component

classifier - the value for the classifier record component

train - the value for the train record component

validation - the value for the validation record component

test - the value for the test record component

tags - the value for the tags record component

Method Details

predict

public int predict(Tuple x)

Model inference.

Parameters:

x - the input tuple.

Returns:

the prediction.

predict

public int predict(Tuple x,
 double[] posteriori)

Model inference.

Parameters:

x - the input tuple.

posteriori - a posteriori probabilities on output.

Returns:

the prediction.

numClasses

public int numClasses()

Returns the number of classes.

Returns:

the number of classes.

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

algorithm

public String algorithm()

Returns the value of the algorithm record component.

Specified by:

algorithm in interface Model

Returns:

the value of the algorithm record component

schema

public StructType schema()

Returns the value of the schema record component.

Specified by:

schema in interface Model

Returns:

the value of the schema record component

formula

public Formula formula()

Returns the value of the formula record component.

Specified by:

formula in interface Model

Returns:

the value of the formula record component

classifier

public DataFrameClassifier classifier()

Returns the value of the classifier record component.

Returns:

the value of the classifier record component

train

public ClassificationMetrics train()

Returns the value of the train record component.

Returns:

the value of the train record component

validation

public ClassificationMetrics validation()

Returns the value of the validation record component.

Returns:

the value of the validation record component

test

public ClassificationMetrics test()

Returns the value of the test record component.

Returns:

the value of the test record component

tags

public Properties tags()

Returns the value of the tags record component.

Specified by:

tags in interface Model

Returns:

the value of the tags record component