# Package opennlp.tools.namefind

package opennlp.tools.namefind
Package related to finding proper names and numeric amounts.

- Class
  Description
  BilouCodec
  The default `SequenceCodec` implementation according to the `BILOU` scheme.
  BilouNameFinderSequenceValidator
  A `SequenceValidator` implementation for the `BilouCodec`.
  BioCodec
  The default `SequenceCodec` implementation according to the `BIO` scheme: B: 'beginning' of a NE I: 'inside', the word is inside a NE O: 'outside', the word is a regular word outside a NE See also the paper by Roth D. and Ratinov L.: Design Challenges and Misconceptions in Named Entity Recognition.
  DefaultNameContextGenerator
  A `NameContextGenerator` implementation for determining contextual features for a `tag-chunk` style named-entity recognizer.
  DictionaryNameFinder
  This is a `Dictionary` based `name finder`.
  DocumentNameFinder
  Interface for processing an entire document allowing a `TokenNameFinder` to use context from the entire document.
  NameContextGenerator
  Interface for generating the context for a `name finder` by specifying a set of feature generators.
  NameFinderEventStream
  Class for creating an event stream out of data files for training an `TokenNameFinder`.
  NameFinderME
  A maximum-entropy-based `name finder` implementation.
  NameFinderSequenceValidator
  The default name finder `SequenceValidator` implementation.
  NameSample
  Encapsulates names for a single unit of text.
  NameSampleDataStream
  The `NameSampleDataStream` class converts tagged `strings` provided by a `DataStream` to `NameSample` objects.
  NameSampleSequenceStream
  A `SequenceStream` implementation encapsulating `samples`.
  NameSampleTypeFilter
  A `stream` which removes `name samples` which do not have a certain type.
  RegexNameFinder
  A `TokenNameFinder` implementation based on a series of regular expressions.
  RegexNameFinderFactory
  Returns a `RegexNameFinder` based on a selection of defaults or a configuration and a selection of defaults.
  RegexNameFinderFactory.DEFAULT_REGEX_NAME_FINDER
  Enumeration of typical regex expressions available in OpenNLP.
  RegexNameFinderFactory.RegexAble
  TokenNameFinder
  The interface for name finders which provide name tags for a sequence of tokens.
  TokenNameFinderCrossValidator
  Cross validator for `TokenNameFinder`.
  TokenNameFinderEvaluationMonitor
  A marker interface for evaluating `name finders`.
  TokenNameFinderEvaluator
  The `TokenNameFinderEvaluator` measures the performance of the given `TokenNameFinder` with the provided reference `samples`.
  TokenNameFinderFactory
  The factory that provides `TokenNameFinder` default implementations and resources.
  TokenNameFinderModel
  The `TokenNameFinderModel` is the model used by a learnable `TokenNameFinder`.
  TokenNameFinderModel.FeatureGeneratorCreationError