opennlp.tools.postag

Class POSTaggerCrossValidator

java.lang.Object

opennlp.tools.postag.POSTaggerCrossValidator

public class POSTaggerCrossValidator
extends Object

Constructor Summary

Constructors

Constructor and Description
POSTaggerCrossValidator(String languageCode, ModelType modelType, POSDictionary tagDictionary, Dictionary ngramDictionary) Deprecated. use POSTaggerCrossValidator(String, TrainingParameters, POSTaggerFactory, POSTaggerEvaluationMonitor...) instead and pass in a TrainingParameters object and a POSTaggerFactory.
POSTaggerCrossValidator(String languageCode, ModelType modelType, POSDictionary tagDictionary, Dictionary ngramDictionary, int cutoff, int iterations) Deprecated. use POSTaggerCrossValidator(String, TrainingParameters, POSTaggerFactory, POSTaggerEvaluationMonitor...) instead and pass in a TrainingParameters object and a POSTaggerFactory.
POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, File tagDictionary, Integer ngramCutoff, Integer tagdicCutoff, String factoryClass, POSTaggerEvaluationMonitor... listeners) Creates a POSTaggerCrossValidator that builds a ngram dictionary dynamically.
POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, POSDictionary tagDictionary, Dictionary ngramDictionary, POSTaggerEvaluationMonitor... listeners) Deprecated. use POSTaggerCrossValidator(String, TrainingParameters, POSTaggerFactory, POSTaggerEvaluationMonitor...) instead and pass in a POSTaggerFactory.
POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, POSDictionary tagDictionary, Integer ngramCutoff, POSTaggerEvaluationMonitor... listeners) Deprecated. use #POSTaggerCrossValidator(String, TrainingParameters, POSDictionary, Integer, String, POSTaggerEvaluationMonitor...) instead and pass in the name of POSTaggerFactory sub-class.
POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, POSDictionary tagDictionary, POSTaggerEvaluationMonitor... listeners) Deprecated. use POSTaggerCrossValidator(String, TrainingParameters, POSTaggerFactory, POSTaggerEvaluationMonitor...) instead and pass in a POSTaggerFactory.
POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, POSTaggerFactory factory, POSTaggerEvaluationMonitor... listeners) Creates a POSTaggerCrossValidator using the given POSTaggerFactory.

Method Summary

Modifier and Type	Method and Description
void	evaluate(ObjectStream<POSSample> samples, int nFolds) Starts the evaluation.
double	getWordAccuracy() Retrieves the accuracy for all iterations.
long	getWordCount() Retrieves the number of words which where validated over all iterations.

Methods inherited from class java.lang.Object

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

Constructor Detail

POSTaggerCrossValidator

public POSTaggerCrossValidator(String languageCode,
                               TrainingParameters trainParam,
                               File tagDictionary,
                               Integer ngramCutoff,
                               Integer tagdicCutoff,
                               String factoryClass,
                               POSTaggerEvaluationMonitor... listeners)

Creates a POSTaggerCrossValidator that builds a ngram dictionary dynamically. It instantiates a sub-class of POSTaggerFactory using the tag and the ngram dictionaries.

POSTaggerCrossValidator

public POSTaggerCrossValidator(String languageCode,
                               TrainingParameters trainParam,
                               POSTaggerFactory factory,
                               POSTaggerEvaluationMonitor... listeners)

Creates a POSTaggerCrossValidator using the given POSTaggerFactory.

POSTaggerCrossValidator

public POSTaggerCrossValidator(String languageCode,
                               ModelType modelType,
                               POSDictionary tagDictionary,
                               Dictionary ngramDictionary,
                               int cutoff,
                               int iterations)

Deprecated. use POSTaggerCrossValidator(String, TrainingParameters, POSTaggerFactory, POSTaggerEvaluationMonitor...) instead and pass in a TrainingParameters object and a POSTaggerFactory.

POSTaggerCrossValidator

public POSTaggerCrossValidator(String languageCode,
                               ModelType modelType,
                               POSDictionary tagDictionary,
                               Dictionary ngramDictionary)

Deprecated. use POSTaggerCrossValidator(String, TrainingParameters, POSTaggerFactory, POSTaggerEvaluationMonitor...) instead and pass in a TrainingParameters object and a POSTaggerFactory.

POSTaggerCrossValidator

public POSTaggerCrossValidator(String languageCode,
                               TrainingParameters trainParam,
                               POSDictionary tagDictionary,
                               POSTaggerEvaluationMonitor... listeners)

Deprecated. use POSTaggerCrossValidator(String, TrainingParameters, POSTaggerFactory, POSTaggerEvaluationMonitor...) instead and pass in a POSTaggerFactory.

POSTaggerCrossValidator

public POSTaggerCrossValidator(String languageCode,
                               TrainingParameters trainParam,
                               POSDictionary tagDictionary,
                               Integer ngramCutoff,
                               POSTaggerEvaluationMonitor... listeners)

Deprecated. use #POSTaggerCrossValidator(String, TrainingParameters, POSDictionary, Integer, String, POSTaggerEvaluationMonitor...) instead and pass in the name of POSTaggerFactory sub-class.

POSTaggerCrossValidator

public POSTaggerCrossValidator(String languageCode,
                               TrainingParameters trainParam,
                               POSDictionary tagDictionary,
                               Dictionary ngramDictionary,
                               POSTaggerEvaluationMonitor... listeners)

Deprecated. use POSTaggerCrossValidator(String, TrainingParameters, POSTaggerFactory, POSTaggerEvaluationMonitor...) instead and pass in a POSTaggerFactory.

Method Detail

evaluate

public void evaluate(ObjectStream<POSSample> samples,
                     int nFolds)
              throws IOException

Starts the evaluation.

Parameters:

samples - the data to train and test

nFolds - number of folds

Throws:

IOException

getWordAccuracy

public double getWordAccuracy()

Retrieves the accuracy for all iterations.

Returns:

the word accuracy

getWordCount

public long getWordCount()

Retrieves the number of words which where validated over all iterations. The result is the amount of folds multiplied by the total number of words.

Returns:

the word count