Package opennlp.tools.languagemodel
Class NGramLanguageModel
java.lang.Object
opennlp.tools.ngram.NGramModel
opennlp.tools.languagemodel.NGramLanguageModel
- All Implemented Interfaces:
Iterable<StringList>,LanguageModel
A
LanguageModel based on a NGramModel using Stupid Backoff to get
the probabilities of the ngrams.-
Constructor Summary
ConstructorsConstructorDescriptionInitializes anNGramLanguageModelwithDEFAULT_N.NGramLanguageModel(int n) Initializes anNGramLanguageModelwith the givennfor the ngram size.Initializes aNGramLanguageModelinstance via a validInputStream.NGramLanguageModel(InputStream in, int n) Initializes aNGramLanguageModelinstance via a validInputStream. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds further tokens.doublecalculateProbability(String... tokens) Calculate the probability of a series of tokens (e.g. a sentence), given a vocabulary.String[]predictNextTokens(String... tokens) Predict the most probable output sequence of tokens, given an input sequence oftokens.Methods inherited from class opennlp.tools.ngram.NGramModel
add, add, add, contains, cutoff, equals, getCount, hashCode, iterator, numberOfGrams, remove, serialize, setCount, size, toDictionary, toDictionary, toStringMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
NGramLanguageModel
public NGramLanguageModel()Initializes anNGramLanguageModelwithDEFAULT_N. -
NGramLanguageModel
public NGramLanguageModel(int n) Initializes anNGramLanguageModelwith the givennfor the ngram size.- Parameters:
n- The size of the ngrams to be used. Must be greater than0.- Throws:
IllegalArgumentException- Thrown if one of the arguments was invalid.
-
NGramLanguageModel
Initializes aNGramLanguageModelinstance via a validInputStream.- Parameters:
in- TheInputStreamused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.IllegalArgumentException- Thrown if one of the arguments was invalid.
-
NGramLanguageModel
Initializes aNGramLanguageModelinstance via a validInputStream.- Parameters:
in- TheInputStreamused for loading the model.n- The size of the ngrams to be used. Must be greater than0.- Throws:
IOException- Thrown if IO errors occurred during initialization.IllegalArgumentException- Thrown if one of the arguments was invalid.
-
-
Method Details
-
add
Adds further tokens.- Parameters:
tokens- Text elements to add to theNGramLanguageModel.
-
calculateProbability
Description copied from interface:LanguageModelCalculate the probability of a series of tokens (e.g. a sentence), given a vocabulary.- Specified by:
calculateProbabilityin interfaceLanguageModel- Parameters:
tokens- the text tokens to calculate theprobabilityfor.- Returns:
- the probability of the given text tokens in the vocabulary
-
predictNextTokens
Description copied from interface:LanguageModelPredict the most probable output sequence of tokens, given an input sequence oftokens.- Specified by:
predictNextTokensin interfaceLanguageModel- Parameters:
tokens- a sequence of tokens- Returns:
- the most probable subsequent token sequence
-