jsat.classifiers.evaluation

Interface ClassificationScore

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Accuracy, AUC, BalancedAccuracy, F1Score, FbetaScore, Kappa, LogLoss, MatthewsCorrelationCoefficient, Precision, Recall, SimpleBinaryClassMetric

public interface ClassificationScore
extends java.io.Serializable

This interface defines the contract for evaluating or "scoring" the results on a classification problem.

All classification scores must override the equals(java.lang.Object) and hashCode() methods. If a score has parameters, different objects with different parameters must not be equal. However, different objects with the same parameters must be equal even if their internal states are different

Method Summary

Modifier and Type	Method and Description
void	addResult(CategoricalResults prediction, int trueLabel, double weight) Adds the given result to the score
void	addResults(ClassificationScore other) The score contained in this object is augmented with the results already accumulated in the other object.
ClassificationScore	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name to present for this score
double	getScore() Computes the score for the results that have been enrolled via addResult(jsat.classifiers.CategoricalResults, int, double)
int	hashCode()
boolean	lowerIsBetter() Returns true if a lower score is better, or false if a higher score is better
void	prepare(CategoricalData toPredict) Prepares this score to predict on the given input

Method Detail

prepare

void prepare(CategoricalData toPredict)

Prepares this score to predict on the given input

Parameters:

toPredict - the class label information that will be evaluated

addResult

void addResult(CategoricalResults prediction,
               int trueLabel,
               double weight)

Adds the given result to the score

Parameters:

prediction - the prediction for the data point

trueLabel - the true label for the data point

weight - the weigh to assign to the data point

addResults

void addResults(ClassificationScore other)

The score contained in this object is augmented with the results already accumulated in the other object. This does not result in an averaging, but alters the current object to have the same score it would have had if all the results were originally inserted into this object.

This method is only required to work if other if of the same class as this object.

Parameters:

other - the object to add the results from

getScore

double getScore()

Computes the score for the results that have been enrolled via addResult(jsat.classifiers.CategoricalResults, int, double)

Returns:

the score for the current results

lowerIsBetter

boolean lowerIsBetter()

Returns true if a lower score is better, or false if a higher score is better

Returns:

true if a lower score is better

equals

boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

ClassificationScore clone()

getName

java.lang.String getName()

Returns the name to present for this score

Returns:

the score name