eus.ixa.ixa.pipe.ml.document

Class DocumentClassifierEvaluator

java.lang.Object

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

eus.ixa.ixa.pipe.ml.document.DocumentClassifierEvaluator

public class DocumentClassifierEvaluator
extends opennlp.tools.util.eval.Evaluator<DocSample>

The DocumentClassifierEvaluator measures the performance of the given DocumentClassifier with the provided reference DocSamples.

See Also:

DocumentClassifier, DocSample

Constructor Summary

Constructors

Constructor and Description
DocumentClassifierEvaluator(DocumentClassifier classifier, DocumentClassifierEvaluationMonitor... listeners) Initializes the current instance.

Method Summary

Modifier and Type	Method and Description
double	getAccuracy() Retrieves the accuracy of provided DocumentClassifier.
long	getDocumentCount()
DocSample	processSample(DocSample sample) Evaluates the given reference DocSample 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

DocumentClassifierEvaluator

public DocumentClassifierEvaluator(DocumentClassifier classifier,
                                   DocumentClassifierEvaluationMonitor... listeners)

Initializes the current instance.

Parameters:

classifier - the document classifier instance

listeners - the listeners

Method Detail

processSample

public DocSample processSample(DocSample sample)

Evaluates the given reference DocSample object. This is done by categorizing the document from the provided DocSample. The detected category is then used to calculate and update the score.

Specified by:

processSample in class opennlp.tools.util.eval.Evaluator<DocSample>

Parameters:

sample - the reference DocSample.

getAccuracy

public double getAccuracy()

Retrieves the accuracy of provided DocumentClassifier. accuracy = correctly categorized documents / total documents

Returns:

the accuracy

getDocumentCount

public long getDocumentCount()

toString

public String toString()

Represents this objects as human readable String.

Overrides:

toString in class Object