opennlp.tools.doccat

Class DocumentCategorizerME

java.lang.Object

opennlp.tools.doccat.DocumentCategorizerME

All Implemented Interfaces:

DocumentCategorizer

public class DocumentCategorizerME
extends Object
implements DocumentCategorizer

Maxent implementation of DocumentCategorizer.

Constructor Summary

Constructors

Constructor and Description
DocumentCategorizerME(DoccatModel model) Initializes the current instance with a doccat model.
DocumentCategorizerME(DoccatModel model, FeatureGenerator... featureGenerators) Deprecated. train a DoccatModel with a specific DoccatFactory to customize the FeatureGenerators

Method Summary

Methods

Modifier and Type	Method and Description
double[]	categorize(String documentText) Categorizes the given text.
double[]	categorize(String[] text) Categorizes the given text.
double[]	categorize(String[] text, Map<String,Object> extraInformation)
double[]	categorize(String documentText, Map<String,Object> extraInformation) Categorizes the given text.
String	getAllResults(double[] results)
String	getBestCategory(double[] outcome)
String	getCategory(int index)
int	getIndex(String category)
int	getNumberOfCategories()
Map<String,Double>	scoreMap(String text) Returns a map in which the key is the category name and the value is the score
SortedMap<Double,Set<String>>	sortedScoreMap(String text) Returns a map with the score as a key in ascendng order.
static DoccatModel	train(String languageCode, ObjectStream<DocumentSample> samples) Deprecated. Use train(String, ObjectStream, TrainingParameters, DoccatFactory) instead.
static DoccatModel	train(String languageCode, ObjectStream<DocumentSample> samples, TrainingParameters mlParams, DoccatFactory factory)
static DoccatModel	train(String languageCode, ObjectStream<DocumentSample> samples, TrainingParameters mlParams, FeatureGenerator... featureGenerators) Deprecated. Use train(String, ObjectStream, TrainingParameters, DoccatFactory) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentCategorizerME

public DocumentCategorizerME(DoccatModel model,
                     FeatureGenerator... featureGenerators)

Deprecated. train a DoccatModel with a specific DoccatFactory to customize the FeatureGenerators

Initializes a the current instance with a doccat model and custom feature generation. The feature generation must be identical to the configuration at training time.

Parameters:

model -

featureGenerators -

DocumentCategorizerME

public DocumentCategorizerME(DoccatModel model)

Initializes the current instance with a doccat model. Default feature generation is used.

Parameters:

model -

Method Detail

categorize

public double[] categorize(String[] text,
                  Map<String,Object> extraInformation)

Specified by:

categorize in interface DocumentCategorizer

categorize

public double[] categorize(String[] text)

Categorizes the given text.

Specified by:

categorize in interface DocumentCategorizer

Parameters:

text -

categorize

public double[] categorize(String documentText,
                  Map<String,Object> extraInformation)

Categorizes the given text. The Tokenizer is obtained from DoccatFactory.getTokenizer() and defaults to SimpleTokenizer.

Specified by:

categorize in interface DocumentCategorizer

categorize

public double[] categorize(String documentText)

Categorizes the given text. The text is tokenized with the SimpleTokenizer before it is passed to the feature generation.

Specified by:

categorize in interface DocumentCategorizer

scoreMap

public Map<String,Double> scoreMap(String text)

Returns a map in which the key is the category name and the value is the score

Specified by:

scoreMap in interface DocumentCategorizer

Parameters:

text - the input text to classify

Returns:

sortedScoreMap

public SortedMap<Double,Set<String>> sortedScoreMap(String text)

Returns a map with the score as a key in ascendng order. The value is a Set of categories with the score. Many categories can have the same score, hence the Set as value

Specified by:

sortedScoreMap in interface DocumentCategorizer

Parameters:

text - the input text to classify

Returns:

getBestCategory

public String getBestCategory(double[] outcome)

Specified by:

getBestCategory in interface DocumentCategorizer

getIndex

public int getIndex(String category)

Specified by:

getIndex in interface DocumentCategorizer

getCategory

public String getCategory(int index)

Specified by:

getCategory in interface DocumentCategorizer

getNumberOfCategories

public int getNumberOfCategories()

Specified by:

getNumberOfCategories in interface DocumentCategorizer

getAllResults

public String getAllResults(double[] results)

Specified by:

getAllResults in interface DocumentCategorizer

train

public static DoccatModel train(String languageCode,
                ObjectStream<DocumentSample> samples,
                TrainingParameters mlParams,
                FeatureGenerator... featureGenerators)
                         throws IOException

Deprecated. Use train(String, ObjectStream, TrainingParameters, DoccatFactory) instead.

Throws:

IOException

train

public static DoccatModel train(String languageCode,
                ObjectStream<DocumentSample> samples,
                TrainingParameters mlParams,
                DoccatFactory factory)
                         throws IOException

Throws:

IOException

train

public static DoccatModel train(String languageCode,
                ObjectStream<DocumentSample> samples)
                         throws IOException

Deprecated. Use train(String, ObjectStream, TrainingParameters, DoccatFactory) instead.

Trains a doccat model with default feature generation.

Parameters:

languageCode -

samples -

Returns:

the trained doccat model

Throws:

IOException

ObjectStreamException