opennlp.tools.languagemodel

Class NGramLanguageModel

java.lang.Object

opennlp.tools.ngram.NGramModel

opennlp.tools.languagemodel.NGramLanguageModel

All Implemented Interfaces:

Iterable<StringList>, LanguageModel

public class NGramLanguageModel
extends NGramModel
implements LanguageModel

A LanguageModel based on a NGramModel using Laplace smoothing probability estimation to get the probabilities of the ngrams. See also NGramUtils.calculateLaplaceSmoothingProbability( opennlp.tools.util.StringList, Iterable, int, Double).

Constructor Summary

Constructors

Constructor and Description
NGramLanguageModel()
NGramLanguageModel(double k)
NGramLanguageModel(InputStream in)
NGramLanguageModel(InputStream in, double k)
NGramLanguageModel(InputStream in, int n)
NGramLanguageModel(InputStream in, int n, double k)
NGramLanguageModel(int n)
NGramLanguageModel(int n, double k)

Method Summary

Modifier and Type	Method and Description
double	calculateProbability(StringList sample) Calculate the probability of a series of tokens (e.g.
StringList	predictNextTokens(StringList tokens) Predict the most probable output sequence of tokens, given an input sequence of tokens

Methods inherited from class opennlp.tools.ngram.NGramModel

add, add, add, contains, cutoff, equals, getCount, hashCode, iterator, numberOfGrams, remove, serialize, setCount, size, toDictionary, toDictionary, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

NGramLanguageModel

public NGramLanguageModel()

NGramLanguageModel

public NGramLanguageModel(int n)

NGramLanguageModel

public NGramLanguageModel(double k)

NGramLanguageModel

public NGramLanguageModel(int n,
                          double k)

NGramLanguageModel

public NGramLanguageModel(InputStream in)
                   throws IOException

Throws:

IOException

NGramLanguageModel

public NGramLanguageModel(InputStream in,
                          double k)
                   throws IOException

Throws:

IOException

NGramLanguageModel

public NGramLanguageModel(InputStream in,
                          int n)
                   throws IOException

Throws:

IOException

NGramLanguageModel

public NGramLanguageModel(InputStream in,
                          int n,
                          double k)
                   throws IOException

Throws:

IOException

Method Detail

calculateProbability

public double calculateProbability(StringList sample)

Description copied from interface: LanguageModel

Calculate the probability of a series of tokens (e.g. a sentence), given a vocabulary

Specified by:

calculateProbability in interface LanguageModel

Parameters:

sample - the text tokens to calculate the probability for

Returns:

the probability of the given text tokens in the vocabulary

predictNextTokens

public StringList predictNextTokens(StringList tokens)

Description copied from interface: LanguageModel

Predict the most probable output sequence of tokens, given an input sequence of tokens

Specified by:

predictNextTokens in interface LanguageModel

Parameters:

tokens - a sequence of tokens

Returns:

the most probable subsequent token sequence