eus.ixa.ixa.pipe.pos.train

Class AbstractTrainer

java.lang.Object

eus.ixa.ixa.pipe.pos.train.AbstractTrainer

All Implemented Interfaces:

Trainer

Direct Known Subclasses:

FixedTrainer

public abstract class AbstractTrainer
extends Object
implements Trainer

Training POS tagger with Apache OpenNLP Machine Learning API.

Version:

2014-07-07

Author:

ragerri

Constructor Summary

Constructors

Constructor and Description
AbstractTrainer(opennlp.tools.util.TrainingParameters params) Construct an AbstractTrainer.

Method Summary

Modifier and Type	Method and Description
protected void	createAutomaticDictionary(opennlp.tools.util.ObjectStream<opennlp.tools.postag.POSSample> aDictSamples, int aDictCutOff) Automatically create a tag dictionary from training data.
protected opennlp.tools.dictionary.Dictionary	createNgramDictionary(opennlp.tools.util.ObjectStream<opennlp.tools.postag.POSSample> aDictSamples, int aNgramCutoff) Create ngram dictionary from training data.
protected void	createTagDictionary(String dictPath) Create a tag dictionary with the dictionary contained in the dictPath.
protected Integer	getDictCutOff() Get the cutoff to create automatic dictionary from training data.
protected opennlp.tools.postag.WordTagSampleStream	getDictSamples() Get the dictSamples to automatically create tag dictionary.
protected Integer	getNgramDictCutOff() Get the cutoff to create automatic ngram dictionary from training data.
protected opennlp.tools.postag.POSTaggerFactory	getPosTaggerFactory() Get the posTaggerFactory.
protected void	setDictSamples(opennlp.tools.postag.WordTagSampleStream aDictSamples) Set the dictSamples to automatically create tag dictionary.
protected void	setPosTaggerFactory(opennlp.tools.postag.POSTaggerFactory aPosTaggerFactory) Set/implement the posTaggerFactory to be used in the pos tagger training.
opennlp.tools.postag.POSModel	train(opennlp.tools.util.TrainingParameters params) Train a pos model with a parameters file.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTrainer

public AbstractTrainer(opennlp.tools.util.TrainingParameters params)
                throws IOException

Construct an AbstractTrainer. In the params parameter there is information about the language, the featureset, and whether to use pos tag dictionaries or automatically created dictionaries from the training set.

Parameters:

params - the training parameters

Throws:

IOException - the io exceptions

Method Detail

train

public final opennlp.tools.postag.POSModel train(opennlp.tools.util.TrainingParameters params)

Description copied from interface: Trainer

Train a pos model with a parameters file.

Specified by:

train in interface Trainer

Parameters:

params - the parameters file

Returns:

the POSModel trained

createTagDictionary

protected final void createTagDictionary(String dictPath)

Create a tag dictionary with the dictionary contained in the dictPath.

Parameters:

dictPath - the string pointing to the tag dictionary

createAutomaticDictionary

protected final void createAutomaticDictionary(opennlp.tools.util.ObjectStream<opennlp.tools.postag.POSSample> aDictSamples,
                                               int aDictCutOff)

Automatically create a tag dictionary from training data.

Parameters:

aDictSamples - the dictSamples created from training data

aDictCutOff - the cutoff to create the dictionary

createNgramDictionary

protected final opennlp.tools.dictionary.Dictionary createNgramDictionary(opennlp.tools.util.ObjectStream<opennlp.tools.postag.POSSample> aDictSamples,
                                                                          int aNgramCutoff)

Create ngram dictionary from training data.

Parameters:

aDictSamples - the training data

aNgramCutoff - the cutoff

Returns:

ngram dictionary

getDictSamples

protected final opennlp.tools.postag.WordTagSampleStream getDictSamples()

Get the dictSamples to automatically create tag dictionary.

Returns:

the WordTagSampleStream dictSamples

setDictSamples

protected final void setDictSamples(opennlp.tools.postag.WordTagSampleStream aDictSamples)

Set the dictSamples to automatically create tag dictionary.

Parameters:

aDictSamples - the dict samples as a WordTagSampleStream

getPosTaggerFactory

protected final opennlp.tools.postag.POSTaggerFactory getPosTaggerFactory()

Get the posTaggerFactory. Every extension of this class must provide an implementation of the posTaggerFactory.

Returns:

the posTaggerFactory

setPosTaggerFactory

protected final void setPosTaggerFactory(opennlp.tools.postag.POSTaggerFactory aPosTaggerFactory)

Set/implement the posTaggerFactory to be used in the pos tagger training.

Parameters:

aPosTaggerFactory - the pos tagger factory implemented

getDictCutOff

protected final Integer getDictCutOff()

Get the cutoff to create automatic dictionary from training data.

Returns:

the cutoff

getNgramDictCutOff

protected final Integer getNgramDictCutOff()

Get the cutoff to create automatic ngram dictionary from training data.

Returns:

the cutoff