# Uses of Class
opennlp.tools.util.TrainingParameters

Packages that use TrainingParameters
Package
Description
opennlp.tools.chunker
Package related to finding non-recursive syntactic annotation such as noun phrase chunks.
opennlp.tools.commons
Package related to common interfaces used in different contexts.
opennlp.tools.doccat
Package for classifying a document into a category.
opennlp.tools.langdetect
Package related to predicting languages from samples of text.
opennlp.tools.lemmatizer
Package related to the lemmatizer functionality.
opennlp.tools.ml
Package related to Machine Learning (ML) features of OpenNLP, the related ML models, and trainers.
opennlp.tools.ml.maxent
Package related to ML by means of the Maximum Entropy (ME) algorithm.
opennlp.tools.ml.maxent.quasinewton
Package related to ML by means of the Quasi Newton (QN) algorithm.
opennlp.tools.ml.model
Package related to ML models and feature selection techniques.
opennlp.tools.ml.naivebayes
Package related to ML by means of the Naive Bayes algorithm.
opennlp.tools.ml.perceptron
Package related to ML by means of the perceptron algorithm.
opennlp.tools.namefind
Package related to finding proper names and numeric amounts.
opennlp.tools.parser
Package containing common code for performing full syntactic parsing.
opennlp.tools.parser.chunking
Package containing code for performing full syntactic parsing using shift/reduce-style decisions.
opennlp.tools.parser.treeinsert
Package containing experimental code for performing full syntactic parsing using attachment decisions.
opennlp.tools.postag
Package related to part-of-speech tagging.
opennlp.tools.sentdetect
Package related to identifying sentence boundaries.
opennlp.tools.tokenize
Contains classes related to finding token or words in a string.
opennlp.tools.util
Package containing utility data structures and algorithms used by multiple other packages.
opennlp.tools.util.model

- ## Uses of TrainingParameters in opennlp.tools.chunker

  Methods in opennlp.tools.chunker with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static ChunkerModel`
  ChunkerME.`train(String lang, ObjectStream<ChunkSample> in, TrainingParameters mlParams, ChunkerFactory factory)`
  Starts a training of a `ChunkerModel` with the given parameters.
  Constructors in opennlp.tools.chunker with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `ChunkerCrossValidator(String languageCode, TrainingParameters params, ChunkerFactory factory, ChunkerEvaluationMonitor... listeners)`
  Initializes a `ChunkerCrossValidator` instance via given parameters.

- ## Uses of TrainingParameters in opennlp.tools.commons

  Methods in opennlp.tools.commons with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `void`
  Trainer.`init(TrainingParameters trainParams, Map<String,String> reportMap)`
  Conducts the initialization of an `Trainer` via `TrainingParameters` and a `report map`.

- ## Uses of TrainingParameters in opennlp.tools.doccat

  Methods in opennlp.tools.doccat with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static DoccatModel`
  DocumentCategorizerME.`train(String lang, ObjectStream<DocumentSample> samples, TrainingParameters mlParams, DoccatFactory factory)`
  Starts a training of a `DoccatModel` with the given parameters.
  Constructors in opennlp.tools.doccat with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `DoccatCrossValidator(String languageCode, TrainingParameters mlParams, DoccatFactory factory, DoccatEvaluationMonitor... listeners)`
  Instantiates a `DoccatCrossValidator` with the given `generators`.

- ## Uses of TrainingParameters in opennlp.tools.langdetect

  Methods in opennlp.tools.langdetect with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static LanguageDetectorModel`
  LanguageDetectorME.`train(ObjectStream<LanguageSample> samples, TrainingParameters mlParams, LanguageDetectorFactory factory)`
  Starts a training of a `LanguageDetectorModel` with the given parameters.
  Constructors in opennlp.tools.langdetect with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `LanguageDetectorCrossValidator(TrainingParameters mlParams, LanguageDetectorFactory factory, LanguageDetectorEvaluationMonitor... listeners)`
  Initializes a `LanguageDetectorCrossValidator` with the given `parameters`.

- ## Uses of TrainingParameters in opennlp.tools.lemmatizer

  Methods in opennlp.tools.lemmatizer with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static LemmatizerModel`
  LemmatizerME.`train(String languageCode, ObjectStream<LemmaSample> samples, TrainingParameters params, LemmatizerFactory factory)`
  Starts a training of a `LemmatizerModel` with the given parameters.

- ## Uses of TrainingParameters in opennlp.tools.ml

  Fields in opennlp.tools.ml declared as TrainingParameters
  Modifier and Type
  Field
  Description
  `protected TrainingParameters`
  AbstractTrainer.`trainingParameters`
  Methods in opennlp.tools.ml with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static <T> EventModelSequenceTrainer<T>`
  TrainerFactory.`getEventModelSequenceTrainer(TrainingParameters trainParams, Map<String,String> reportMap)`
  Retrieves an `EventModelSequenceTrainer` that fits the given parameters.
  `static EventTrainer`
  TrainerFactory.`getEventTrainer(TrainingParameters trainParams, Map<String,String> reportMap)`
  Retrieves an `EventTrainer` that fits the given parameters.
  `static SequenceTrainer`
  TrainerFactory.`getSequenceModelTrainer(TrainingParameters trainParams, Map<String,String> reportMap)`
  Retrieves a `SequenceTrainer` that fits the given parameters.
  `static TrainerFactory.TrainerType`
  TrainerFactory.`getTrainerType(TrainingParameters trainParams)`
  Determines the `TrainerFactory.TrainerType` based on the `ALGORITHM_PARAM` value.
  `void`
  AbstractTrainer.`init(TrainingParameters trainParams, Map<String,String> reportMap)`
  Initializes a `AbstractTrainer` via `TrainingParameters` and a `report map`.
  `static boolean`
  TrainerFactory.`isValid(TrainingParameters trainParams)`
  Constructors in opennlp.tools.ml with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `AbstractEventTrainer(TrainingParameters parameters)`
  ``
  `AbstractTrainer(TrainingParameters trainParams)`
  Initializes a `AbstractTrainer` via `TrainingParameters`.

- ## Uses of TrainingParameters in opennlp.tools.ml.maxent

  Methods in opennlp.tools.ml.maxent with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `void`
  GISTrainer.`init(TrainingParameters trainingParameters, Map<String,String> reportMap)`
  Initializes a `AbstractTrainer` via `TrainingParameters` and a `report map`.

- ## Uses of TrainingParameters in opennlp.tools.ml.maxent.quasinewton

  Methods in opennlp.tools.ml.maxent.quasinewton with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `void`
  QNTrainer.`init(TrainingParameters trainingParameters, Map<String,String> reportMap)`
  Constructors in opennlp.tools.ml.maxent.quasinewton with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `QNTrainer(TrainingParameters parameters)`
  Initializes a `QNTrainer` with the specified `parameters`.

- ## Uses of TrainingParameters in opennlp.tools.ml.model

  Fields in opennlp.tools.ml.model declared as TrainingParameters
  Modifier and Type
  Field
  Description
  `protected TrainingParameters`
  AbstractDataIndexer.`trainingParameters`
  Methods in opennlp.tools.ml.model with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static DataIndexer`
  DataIndexerFactory.`getDataIndexer(TrainingParameters parameters, Map<String,String> reportMap)`
  Instantiates a `DataIndexer` configured via `TrainingParameters`.
  `void`
  AbstractDataIndexer.`init(TrainingParameters indexingParameters, Map<String,String> reportMap)`
  Sets parameters used during the data indexing.
  `void`
  DataIndexer.`init(TrainingParameters trainParams, Map<String,String> reportMap)`
  Sets parameters used during the data indexing.

- ## Uses of TrainingParameters in opennlp.tools.ml.naivebayes

  Constructors in opennlp.tools.ml.naivebayes with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `NaiveBayesTrainer(TrainingParameters parameters)`
  Instantiates a `NaiveBayesTrainer` with specific `TrainingParameters`.

- ## Uses of TrainingParameters in opennlp.tools.ml.perceptron

  Constructors in opennlp.tools.ml.perceptron with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `PerceptronTrainer(TrainingParameters parameters)`
  Instantiates a `PerceptronTrainer` with specific `TrainingParameters`.

- ## Uses of TrainingParameters in opennlp.tools.namefind

  Methods in opennlp.tools.namefind with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static TokenNameFinderModel`
  NameFinderME.`train(String languageCode, String type, ObjectStream<NameSample> samples, TrainingParameters params, TokenNameFinderFactory factory)`
  Starts a training of a `TokenNameFinderModel` with the given parameters.
  Constructors in opennlp.tools.namefind with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `TokenNameFinderCrossValidator(String languageCode, String type, TrainingParameters trainParams, byte[] featureGeneratorBytes, Map<String,Object> resources, TokenNameFinderEvaluationMonitor... listeners)`
  Initializes a `TokenNameFinderCrossValidator` with the given parameters.
  ``
  `TokenNameFinderCrossValidator(String languageCode, String type, TrainingParameters params, byte[] featureGeneratorBytes, Map<String,Object> resources, SequenceCodec<String> codec, TokenNameFinderEvaluationMonitor... listeners)`
  Initializes a `TokenNameFinderCrossValidator` with the given parameters.
  ``
  `TokenNameFinderCrossValidator(String languageCode, String type, TrainingParameters params, TokenNameFinderFactory factory, TokenNameFinderEvaluationMonitor... listeners)`
  Initializes a `TokenNameFinderCrossValidator` with the given parameters.

- ## Uses of TrainingParameters in opennlp.tools.parser

  Methods in opennlp.tools.parser with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static Dictionary`
  AbstractBottomUpParser.`buildDictionary(ObjectStream<Parse> data, HeadRules rules, TrainingParameters params)`
  Creates a n-gram `Dictionary` from the specified data stream using the specified head rule and specified cut-off.
  Constructors in opennlp.tools.parser with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `ParserCrossValidator(String languageCode, TrainingParameters params, HeadRules rules, ParserType parserType, ParserEvaluationMonitor... monitors)`
  Initializes a `ParserCrossValidator` instance via given parameters.

- ## Uses of TrainingParameters in opennlp.tools.parser.chunking

  Methods in opennlp.tools.parser.chunking with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static ParserModel`
  Parser.`train(String languageCode, ObjectStream<Parse> parseSamples, HeadRules rules, TrainingParameters mlParams)`
  Starts a training of a `ParserModel`.

- ## Uses of TrainingParameters in opennlp.tools.parser.treeinsert

  Methods in opennlp.tools.parser.treeinsert with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static ParserModel`
  Parser.`train(String languageCode, ObjectStream<Parse> parseSamples, HeadRules rules, TrainingParameters mlParams)`
  Starts a training of a `ParserModel`.

- ## Uses of TrainingParameters in opennlp.tools.postag

  Methods in opennlp.tools.postag with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static POSModel`
  POSTaggerME.`train(String languageCode, ObjectStream<POSSample> samples, TrainingParameters mlParams, POSTaggerFactory posFactory)`
  Starts a training of a `POSModel` with the given parameters.
  Constructors in opennlp.tools.postag with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, File tagDictionary, byte[] featureGeneratorBytes, Map<String,Object> resources, Integer tagdicCutoff, String factoryClass, POSTagFormat format, POSTaggerEvaluationMonitor... listeners)`
  Initializes a `POSTaggerCrossValidator` that builds a ngram dictionary dynamically.
  ``
  `POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, File tagDictionary, byte[] featureGeneratorBytes, Map<String,Object> resources, Integer tagdicCutoff, String factoryClass, POSTaggerEvaluationMonitor... listeners)`
  Initializes a `POSTaggerCrossValidator` that builds a ngram dictionary dynamically.
  ``
  `POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, POSTaggerFactory factory, POSTagFormat format, POSTaggerEvaluationMonitor... listeners)`
  Creates a `POSTaggerCrossValidator` using the given `POSTaggerFactory`.
  ``
  `POSTaggerCrossValidator(String languageCode, TrainingParameters trainParam, POSTaggerFactory factory, POSTaggerEvaluationMonitor... listeners)`
  Creates a `POSTaggerCrossValidator` using the given `POSTaggerFactory`.

- ## Uses of TrainingParameters in opennlp.tools.sentdetect

  Methods in opennlp.tools.sentdetect with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static SentenceModel`
  SentenceDetectorME.`train(String languageCode, ObjectStream<SentenceSample> samples, SentenceDetectorFactory sdFactory, TrainingParameters mlParams)`
  Starts a training of a `SentenceModel` with the given parameters.
  Constructors in opennlp.tools.sentdetect with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `SDCrossValidator(String languageCode, TrainingParameters params, SentenceDetectorFactory sdFactory, SentenceDetectorEvaluationMonitor... listeners)`

- ## Uses of TrainingParameters in opennlp.tools.tokenize

  Methods in opennlp.tools.tokenize with parameters of type TrainingParameters
  Modifier and Type
  Method
  Description
  `static TokenizerModel`
  TokenizerME.`train(ObjectStream<TokenSample> samples, TokenizerFactory factory, TrainingParameters mlParams)`
  Trains a model for the `TokenizerME`.
  Constructors in opennlp.tools.tokenize with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `TokenizerCrossValidator(TrainingParameters params, TokenizerFactory factory, TokenizerEvaluationMonitor... listeners)`
  Creates a `TokenizerCrossValidator` using the given `TokenizerFactory`.

- ## Uses of TrainingParameters in opennlp.tools.util

  Methods in opennlp.tools.util that return TrainingParameters
  Modifier and Type
  Method
  Description
  `static TrainingParameters`
  TrainingParameters.`defaultParams()`
  `TrainingParameters`
  TrainingParameters.`getParameters(String namespace)`
  `static TrainingParameters`
  TrainingParameters.`setParams(String[] params)`
  Constructors in opennlp.tools.util with parameters of type TrainingParameters
  Modifier
  Constructor
  Description
  ``
  `TrainingParameters(TrainingParameters trainingParameters)`
  Copy constructor to hand over the config of existing `TrainingParameters`.

- ## Uses of TrainingParameters in opennlp.tools.util.model

  Methods in opennlp.tools.util.model that return TrainingParameters
  Modifier and Type
  Method
  Description
  `static TrainingParameters`
  ModelUtil.`createDefaultTrainingParameters()`
  Creates the default `TrainingParameters` in case they are not provided.