# Package opennlp.tools.util.featuregen

package opennlp.tools.util.featuregen
This package contains classes for generating sequence features.

- Related Packages
  Package
  Description
  opennlp.tools.util
  Package containing utility data structures and algorithms used by multiple other packages.
- Class
  Description
  AdaptiveFeatureGenerator
  An interface for generating features for name entity identification and for updating document level contexts.
  AdditionalContextFeatureGenerator
  The `AdditionalContextFeatureGenerator` generates the context from the passed in additional context.
  AggregatedFeatureGenerator
  The `AggregatedFeatureGenerator` aggregates a set of `feature generators` and calls them to generate the features.
  AggregatedFeatureGeneratorFactory
  A `GeneratorFactory` that produces `AggregatedFeatureGenerator` instances when `AggregatedFeatureGeneratorFactory.create()` is called.
  BigramNameFeatureGenerator
  Adds bigram features based on tokens and token classes.
  BigramNameFeatureGeneratorFactory
  A `GeneratorFactory` that produces `BigramNameFeatureGenerator` instances when `BigramNameFeatureGeneratorFactory.create()` is called.
  BrownBigramFeatureGenerator
  Generates Brown cluster features for token bigrams.
  BrownCluster
  Class to load a Brown cluster document in the format: `word\tword_class\tprob`.
  BrownCluster.BrownClusterSerializer
  BrownClusterBigramFeatureGeneratorFactory
  A `GeneratorFactory` that produces `BrownBigramFeatureGenerator` instances when `BrownClusterBigramFeatureGeneratorFactory.create()` is called.
  BrownClusterTokenClassFeatureGeneratorFactory
  A `GeneratorFactory` that produces `BrownTokenClassFeatureGenerator` instances when `BrownClusterTokenClassFeatureGeneratorFactory.create()` is called.
  BrownClusterTokenFeatureGeneratorFactory
  A `GeneratorFactory` that produces `BrownTokenFeatureGenerator` instances when `BrownClusterTokenFeatureGeneratorFactory.create()` is called.
  BrownTokenClasses
  Obtain the paths listed in the pathLengths array from the Brown class.
  BrownTokenClassFeatureGenerator
  Generates `BrownCluster` features for current token and token class.
  BrownTokenFeatureGenerator
  Generates `BrownCluster` features for current token.
  CachedFeatureGenerator
  Caches features of the aggregated `generators`.
  CachedFeatureGeneratorFactory
  A `GeneratorFactory` that produces `CachedFeatureGenerator` instances when `CachedFeatureGeneratorFactory.create()` is called.
  CharacterNgramFeatureGenerator
  The `CharacterNgramFeatureGenerator` uses character ngrams to generate features about each token.
  CharacterNgramFeatureGeneratorFactory
  A `GeneratorFactory` that produces `CharacterNgramFeatureGenerator` instances when `CharacterNgramFeatureGeneratorFactory.create()` is called.
  DefinitionFeatureGeneratorFactory
  A `GeneratorFactory` that produces `OutcomePriorFeatureGenerator` instances when `DefinitionFeatureGeneratorFactory.create()` is called.
  DictionaryFeatureGenerator
  The `DictionaryFeatureGenerator` uses a `DictionaryNameFinder` to generate features for detected names based on the `InSpanGenerator`.
  DictionaryFeatureGeneratorFactory
  A `GeneratorFactory` that produces `DictionaryFeatureGenerator` instances when `DictionaryFeatureGeneratorFactory.create()` is called.
  DocumentBeginFeatureGenerator
  This feature generator creates document begin features.
  DocumentBeginFeatureGeneratorFactory
  A `GeneratorFactory` that produces `DocumentBeginFeatureGenerator` instances when `DocumentBeginFeatureGeneratorFactory.create()` is called.
  FeatureGeneratorResourceProvider
  The `FeatureGeneratorResourceProvider` provides access to the resources available in the model.
  FeatureGeneratorUtil
  This class provide common utilities for feature generation.
  GeneratorFactory
  Creates a set of feature generators based on a provided XML descriptor.
  GeneratorFactory.AbstractXmlFeatureGeneratorFactory
  InSpanGenerator
  Generates features if the tokens are recognized by the provided `TokenNameFinder`.
  OutcomePriorFeatureGenerator
  The definition feature maps the underlying distribution of outcomes.
  PosTaggerFeatureGenerator
  A POS tagging driven feature generator.
  PosTaggerFeatureGeneratorFactory
  A `GeneratorFactory` that produces `PosTaggerFeatureGenerator` instances when `PosTaggerFeatureGeneratorFactory.create()` is called.
  POSTaggerNameFeatureGenerator
  Adds the token POS tag as feature.
  POSTaggerNameFeatureGeneratorFactory
  A `GeneratorFactory` that produces `POSTaggerNameFeatureGenerator` instances when `POSTaggerNameFeatureGeneratorFactory.create()` is called.
  PrefixFeatureGenerator
  A feature generator implementation that generates prefix-based features.
  PrefixFeatureGeneratorFactory
  A `GeneratorFactory` that produces `PrefixFeatureGenerator` instances when `PrefixFeatureGeneratorFactory.create()` is called.
  PreviousMapFeatureGenerator
  This `AdaptiveFeatureGenerator` generates features indicating the outcome associated with a previously occurring word.
  PreviousMapFeatureGeneratorFactory
  A `GeneratorFactory` that produces `PreviousMapFeatureGenerator` instances when `PreviousMapFeatureGeneratorFactory.create()` is called.
  PreviousTwoMapFeatureGenerator
  This `AdaptiveFeatureGenerator` generates features indicating the outcome associated with two previously occurring words.
  SentenceFeatureGenerator
  This feature generator creates sentence begin and end features.
  SentenceFeatureGeneratorFactory
  A `GeneratorFactory` that produces `SentenceFeatureGenerator` instances when `SentenceFeatureGeneratorFactory.create()` is called.
  StringPattern
  Recognizes predefined patterns in strings.
  SuffixFeatureGenerator
  A feature generator implementation that generates suffix-based features.
  SuffixFeatureGeneratorFactory
  A `GeneratorFactory` that produces `SuffixFeatureGenerator` instances when `SuffixFeatureGeneratorFactory.create()` is called.
  TokenClassFeatureGenerator
  Generates features for the class of a token.
  TokenClassFeatureGeneratorFactory
  A `GeneratorFactory` that produces `TokenClassFeatureGenerator` instances when `TokenClassFeatureGeneratorFactory.create()` is called.
  TokenFeatureGenerator
  Generates a feature which contains a token itself.
  TokenFeatureGeneratorFactory
  A `GeneratorFactory` that produces `TokenFeatureGenerator` instances when `TokenFeatureGeneratorFactory.create()` is called.
  TokenPatternFeatureGenerator
  Partitions tokens into sub-tokens based on character classes and generates class features for each of the sub-tokens and combinations of those sub-tokens.
  TokenPatternFeatureGeneratorFactory
  A `GeneratorFactory` instantiates `TokenPatternFeatureGenerator` instances when `TokenPatternFeatureGeneratorFactory.create()` is called.
  TrigramNameFeatureGenerator
  Adds trigram features based on tokens and token classes.
  TrigramNameFeatureGeneratorFactory
  A `GeneratorFactory` that produces `TrigramNameFeatureGenerator` instances when `TrigramNameFeatureGeneratorFactory.create()` is called.
  WindowFeatureGenerator
  Generates previous (left-sided) and next (right-sided) features for a given `AdaptiveFeatureGenerator`.
  WindowFeatureGeneratorFactory
  A `GeneratorFactory` that produces `WindowFeatureGenerator` instances when `WindowFeatureGeneratorFactory.create()` is called.
  WordClusterDictionary
  WordClusterDictionary.WordClusterDictionarySerializer
  WordClusterFeatureGenerator
  An `AdaptiveFeatureGenerator` implementation of a word cluster feature generator.
  WordClusterFeatureGeneratorFactory
  Defines a word cluster `GeneratorFactory`; it reads an element containing 'w2vwordcluster' as a tag name.