Class FMeasure
java.lang.Object
opennlp.tools.util.eval.FMeasure
The
FMeasure is a utility class for evaluators
which measures precision, recall and the resulting f-measure.
Evaluation results are the arithmetic mean of the precision scores calculated for each reference sample and the arithmetic mean of the recall scores calculated for each reference sample.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate long|selected| = true positives + false positives
the count of selected (or retrieved) items.private long|target| = true positives + false negatives
the count of target (or correct) items.private longHolds the number of true positives found. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) static intcountTruePositives(Object[] references, Object[] predictions) This method counts the number of objects which are equal and occur in the references and predictions arrays.doublef-measure = 2 * precision * recall / (precision + recall).doubledoublevoidMerge results intometric.static doubleCalculates the precision score for the given reference and predicted spans.static doubleCalculates the recall score for the given reference and predicted spans.toString()voidupdateScores(Object[] references, Object[] predictions) Updates the score based on the number of true positives and the number of predictions and references.
-
Field Details
-
selected
private long selected|selected| = true positives + false positives
the count of selected (or retrieved) items. -
target
private long target|target| = true positives + false negatives
the count of target (or correct) items. -
truePositive
private long truePositiveHolds the number of true positives found.
-
-
Constructor Details
-
FMeasure
public FMeasure()
-
-
Method Details
-
getPrecisionScore
public double getPrecisionScore()- Returns:
- Retrieves the arithmetic mean of the precision scores calculated for each evaluated sample.
-
getRecallScore
public double getRecallScore()- Returns:
- Retrieves the arithmetic mean of the recall score calculated for each evaluated sample.
-
getFMeasure
public double getFMeasure()f-measure = 2 * precision * recall / (precision + recall).- Returns:
- Retrieves the f-measure or
-1if precision + recall<= 0
-
updateScores
-
mergeInto
-
toString
-
countTruePositives
This method counts the number of objects which are equal and occur in the references and predictions arrays. Matched items are removed from the prediction list.- Parameters:
references- The gold standard.predictions- The predictions.- Returns:
- The number of true positives.
-
precision
Calculates the precision score for the given reference and predicted spans.- Parameters:
references- The gold standard spans.predictions- The predicted spans.- Returns:
- The precision score or
NaNif there are no predicted spans.
-
recall
-