jsat.classifiers.evaluation

Class FbetaScore

java.lang.Object

jsat.classifiers.evaluation.SimpleBinaryClassMetric

jsat.classifiers.evaluation.FbetaScore

All Implemented Interfaces:

Serializable, ClassificationScore

public class FbetaScore
extends SimpleBinaryClassMetric

The F_β score is the generalization of F1Score, where β indicates the level of preference for precision over recall. This score is only valid for binary classification problems.

Author:

Edward Raff

See Also:

Serialized Form

Field Summary

Fields inherited from class jsat.classifiers.evaluation.SimpleBinaryClassMetric

fn, fp, tn, tp

Constructor Summary

Constructors

Constructor and Description
FbetaScore(double beta) Creates a new Fβ score
FbetaScore(FbetaScore toClone) Copy constructor

Method Summary

Modifier and Type	Method and Description
FbetaScore	clone()
boolean	equals(Object obj)
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()

Methods inherited from class jsat.classifiers.evaluation.SimpleBinaryClassMetric

addResult, addResults, lowerIsBetter, prepare

Methods inherited from class java.lang.Object

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

Constructor Detail

FbetaScore

public FbetaScore(double beta)

Creates a new F_β score

Parameters:

beta - the weight to apply to precision over recall, must be in (0, ∞)

FbetaScore

public FbetaScore(FbetaScore toClone)

Copy constructor

Parameters:

toClone - the object to copy

Method Detail

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

Specified by:

getScore in class SimpleBinaryClassMetric

Returns:

the score for the current results

equals

public boolean equals(Object obj)

Specified by:

equals in interface ClassificationScore

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface ClassificationScore

Overrides:

hashCode in class Object

clone

public FbetaScore clone()

Specified by:

clone in interface ClassificationScore

Specified by:

clone in class SimpleBinaryClassMetric

getName

public String getName()

Description copied from interface: ClassificationScore

Returns the name to present for this score

Returns:

the score name