opennlp.tools.postag

Class POSEvaluator

java.lang.Object

opennlp.tools.util.eval.Evaluator<POSSample>

opennlp.tools.postag.POSEvaluator

public class POSEvaluator
extends Evaluator<POSSample>

The POSEvaluator measures the performance of the given POSTagger with the provided reference POSSamples.

Constructor Summary

Constructors

Constructor and Description
POSEvaluator(POSTagger tagger, POSTaggerEvaluationMonitor... listeners) Initializes the current instance.

Method Summary

Modifier and Type	Method and Description
double	getWordAccuracy() Retrieves the word accuracy.
long	getWordCount() Retrieves the total number of words considered in the evaluation.
protected POSSample	processSample(POSSample reference) Evaluates the given reference POSSample object.
String	toString() Represents this objects as human readable String.

Methods inherited from class opennlp.tools.util.eval.Evaluator

evaluate, evaluateSample

Methods inherited from class java.lang.Object

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

Constructor Detail

POSEvaluator

public POSEvaluator(POSTagger tagger,
                    POSTaggerEvaluationMonitor... listeners)

Initializes the current instance.

Parameters:

tagger -

listeners - an array of evaluation listeners

Method Detail

processSample

protected POSSample processSample(POSSample reference)

Evaluates the given reference POSSample object. This is done by tagging the sentence from the reference POSSample with the POSTagger. The tags are then used to update the word accuracy score.

Overrides:

processSample in class Evaluator<POSSample>

Parameters:

reference - the reference POSSample.

Returns:

the predicted POSSample.

getWordAccuracy

public double getWordAccuracy()

Retrieves the word accuracy. This is defined as: word accuracy = correctly detected tags / total words

Returns:

the word accuracy

getWordCount

public long getWordCount()

Retrieves the total number of words considered in the evaluation.

Returns:

the word count

toString

public String toString()

Represents this objects as human readable String.

Overrides:

toString in class Object