it.uniroma2.sag.kelp.utils.evaluation

Class MulticlassClassificationEvaluator

java.lang.Object

it.uniroma2.sag.kelp.utils.evaluation.Evaluator

it.uniroma2.sag.kelp.utils.evaluation.MulticlassClassificationEvaluator

public class MulticlassClassificationEvaluator
extends Evaluator

This is an instance of an Evaluator. It allows to compute the some common measure for classification tasks. It computes precision, recall, f1s for each class, and a global accuracy.

Author:

Giuseppe Castellucci

Field Summary

Fields inherited from class it.uniroma2.sag.kelp.utils.evaluation.Evaluator

computed

Constructor Summary

Constructors

Constructor and Description
MulticlassClassificationEvaluator(List<Label> labels) Initialize a new F1Evaluator that will work on the specified classes

Method Summary

Modifier and Type	Method and Description
void	addCount(Example test, Prediction prediction) This method should be implemented in the subclasses to update counters useful to compute the performance measure
void	clear() Clear all the counters for a new processing.
protected void	compute() This method is intented to force the computation of the performance measure.
MulticlassClassificationEvaluator	duplicate() Returns a new instance of this Evaluator
float	getAccuracy() Return the accuracy
float	getF1For(Label l) Return the f1 for the specified label
gnu.trove.map.hash.TObjectFloatHashMap<Label>	getF1s() Return the F1 map
float	getMeanF1() Return the mean of the F1 scores considering all the labels involved
float	getMeanF1For(ArrayList<Label> ls) Return the mean of the F1 scores considering the specified labels
float	getOverallF1() Return the f1 considering all classes together
float	getOverallPrecision() Return the precision considering all classes together
float	getOverallRecall() Return the recall considering all classes together
float	getPrecisionFor(Label l) Return the precision for the specified label
gnu.trove.map.hash.TObjectFloatHashMap<Label>	getPrecisions() Return the precision map
float	getRecallFor(Label l) Return the recall for the specified label
gnu.trove.map.hash.TObjectFloatHashMap<Label>	getRecalls() Return the recall map
void	printCounters(Label l) Print the counters of the specified Label l.
String	toString()

Methods inherited from class it.uniroma2.sag.kelp.utils.evaluation.Evaluator

getPerformanceMeasure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MulticlassClassificationEvaluator

public MulticlassClassificationEvaluator(List<Label> labels)

Initialize a new F1Evaluator that will work on the specified classes

Parameters:

labels -

Method Detail

getPrecisions

public gnu.trove.map.hash.TObjectFloatHashMap<Label> getPrecisions()

Return the precision map

Returns:

getRecalls

public gnu.trove.map.hash.TObjectFloatHashMap<Label> getRecalls()

Return the recall map

Returns:

getF1s

public gnu.trove.map.hash.TObjectFloatHashMap<Label> getF1s()

Return the F1 map

Returns:

addCount

public void addCount(Example test,
                     Prediction prediction)

Description copied from class: Evaluator

This method should be implemented in the subclasses to update counters useful to compute the performance measure

Specified by:

addCount in class Evaluator

Parameters:

test - the test example

prediction - the prediction of the system

compute

protected void compute()

Description copied from class: Evaluator

This method is intented to force the computation of the performance measure.

Specified by:

compute in class Evaluator

getPrecisionFor

public float getPrecisionFor(Label l)

Return the precision for the specified label

Returns:

precision of Label l

getRecallFor

public float getRecallFor(Label l)

Return the recall for the specified label

Returns:

recall of Label l

getF1For

public float getF1For(Label l)

Return the f1 for the specified label

Returns:

f1 of Label l

getAccuracy

public float getAccuracy()

Return the accuracy

Returns:

accuracy

getOverallPrecision

public float getOverallPrecision()

Return the precision considering all classes together

Returns:

precision

getOverallRecall

public float getOverallRecall()

Return the recall considering all classes together

Returns:

recall

getOverallF1

public float getOverallF1()

Return the f1 considering all classes together

Returns:

f1

getMeanF1

public float getMeanF1()

Return the mean of the F1 scores considering all the labels involved

Returns:

mean F1 of all Label{s}

getMeanF1For

public float getMeanF1For(ArrayList<Label> ls)

Return the mean of the F1 scores considering the specified labels

Returns:

mean F1 of specified Label{s} ls

clear

public void clear()

Clear all the counters for a new processing.

Specified by:

clear in class Evaluator

printCounters

public void printCounters(Label l)

Print the counters of the specified Label l.

Parameters:

l -

toString

public String toString()

Overrides:

toString in class Object

duplicate

public MulticlassClassificationEvaluator duplicate()

Description copied from class: Evaluator

Returns a new instance of this Evaluator

Specified by:

duplicate in class Evaluator

Returns:

a new instance of this Evaluator