jsat.classifiers.evaluation

Class AUC

java.lang.Object

jsat.classifiers.evaluation.AUC

All Implemented Interfaces:

java.io.Serializable, ClassificationScore

public class AUC
extends java.lang.Object
implements ClassificationScore

Computes the Area Under the ROC Curve as an evaluation of classification scores. The AUC takes O(n log n) time for n predictions and is only valid for binary classification problems.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AUC() Creates a new AUC object
AUC(AUC toClone) Copy constructor

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AUC

public AUC()

Creates a new AUC object

AUC

public AUC(AUC toClone)

Copy constructor

Parameters:

toClone - the object to copy

Method Detail

addResult

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

Description copied from interface: ClassificationScore

Adds the given result to the score

Specified by:

addResult in interface ClassificationScore

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

public void addResults(ClassificationScore other)

Description copied from interface: ClassificationScore

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.

Specified by:

addResults in interface ClassificationScore

Parameters:

other - the object to add the results from

prepare

public void prepare(CategoricalData toPredict)

Description copied from interface: ClassificationScore

Prepares this score to predict on the given input

Specified by:

prepare in interface ClassificationScore

Parameters:

toPredict - the class label information that will be evaluated

getScore

public double getScore()

Description copied from interface: ClassificationScore

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

Specified by:

getScore in interface ClassificationScore

Returns:

the score for the current results

lowerIsBetter

public boolean lowerIsBetter()

Description copied from interface: ClassificationScore

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

Specified by:

lowerIsBetter in interface ClassificationScore

Returns:

true if a lower score is better

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface ClassificationScore

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface ClassificationScore

Overrides:

hashCode in class java.lang.Object

clone

public AUC clone()

Specified by:

clone in interface ClassificationScore

Overrides:

clone in class java.lang.Object

getName

public java.lang.String getName()

Description copied from interface: ClassificationScore

Returns the name to present for this score

Specified by:

getName in interface ClassificationScore

Returns:

the score name