Package opennlp.tools.namefind
Class TokenNameFinderModel
java.lang.Object
opennlp.tools.util.model.BaseModel
opennlp.tools.namefind.TokenNameFinderModel
- All Implemented Interfaces:
Serializable,ArtifactProvider
The
TokenNameFinderModel is the model used by a learnable TokenNameFinder.- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class opennlp.tools.util.model.BaseModel
TRAINING_CUTOFF_PROPERTY, TRAINING_EVENTHASH_PROPERTY, TRAINING_ITERATIONS_PROPERTY -
Constructor Summary
ConstructorsConstructorDescriptionTokenNameFinderModel(File modelFile) Initializes aTokenNameFinderModelinstance via a validFile.Initializes aTokenNameFinderModelinstance via a validInputStream.TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, byte[] generatorDescriptor, Map<String, Object> resources, Map<String, String> manifestInfoEntries) Initializes aTokenNameFinderModelinstance via given parameters.TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, int beamSize, byte[] generatorDescriptor, Map<String, Object> resources, Map<String, String> manifestInfoEntries) Initializes aTokenNameFinderModelinstance via given parameters.TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, int beamSize, byte[] generatorDescriptor, Map<String, Object> resources, Map<String, String> manifestInfoEntries, SequenceCodec<String> seqCodec, TokenNameFinderFactory factory) Initializes aTokenNameFinderModelinstance via given parameters.TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, Map<String, Object> resources, Map<String, String> manifestInfoEntries) Initializes aTokenNameFinderModelinstance via given parameters.TokenNameFinderModel(String languageCode, SequenceClassificationModel nameFinderModel, byte[] generatorDescriptor, Map<String, Object> resources, Map<String, String> manifestInfoEntries, SequenceCodec<String> seqCodec, TokenNameFinderFactory factory) Initializes aTokenNameFinderModelinstance via given parameters.TokenNameFinderModel(URL modelURL) Initializes aTokenNameFinderModelinstance via a validURL.TokenNameFinderModel(Path modelPath) Initializes aTokenNameFinderModelinstance via a validPath. -
Method Summary
Modifier and TypeMethodDescriptionstatic Map<String,ArtifactSerializer<?>> Create theserializers.Methods inherited from class opennlp.tools.util.model.BaseModel
getArtifact, getLanguage, getManifestProperty, getVersion, isLoadedFromSerialized, serialize, serialize, serialize
-
Constructor Details
-
TokenNameFinderModel
public TokenNameFinderModel(String languageCode, SequenceClassificationModel nameFinderModel, byte[] generatorDescriptor, Map<String, Object> resources, Map<String, String> manifestInfoEntries, SequenceCodec<String> seqCodec, TokenNameFinderFactory factory) Initializes aTokenNameFinderModelinstance via given parameters.- Parameters:
languageCode- The ISO conform language code.nameFinderModel- A validMaxentModel.generatorDescriptor- Thebyte[]representing the feature generator descriptor.resources- Additional resources in a mapping.manifestInfoEntries- Additional information kept in the manifest.seqCodec- TheSequenceCodecto use.factory- TheTokenNameFinderFactoryfor creating related objects.- Throws:
IllegalArgumentException- Thrown if thenamFinderModelincompatible withseqCodec.
-
TokenNameFinderModel
public TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, int beamSize, byte[] generatorDescriptor, Map<String, Object> resources, Map<String, String> manifestInfoEntries, SequenceCodec<String> seqCodec, TokenNameFinderFactory factory) Initializes aTokenNameFinderModelinstance via given parameters.- Parameters:
languageCode- The ISO conform language code.nameFinderModel- A validMaxentModel.beamSize- The beam size. Must be greater than0.generatorDescriptor- Thebyte[]representing the feature generator descriptor.resources- Additional resources in a mapping.manifestInfoEntries- Additional information kept in the manifest.seqCodec- TheSequenceCodecto use.factory- TheTokenNameFinderFactoryfor creating related objects.- Throws:
IllegalArgumentException- Thrown if thenamFinderModelincompatible withseqCodec.
-
TokenNameFinderModel
public TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, byte[] generatorDescriptor, Map<String, Object> resources, Map<String, String> manifestInfoEntries) Initializes aTokenNameFinderModelinstance via given parameters.- Parameters:
languageCode- The ISO conform language code.nameFinderModel- A validMaxentModel.generatorDescriptor- Thebyte[]representing the feature generator descriptor.resources- Additional resources in a mapping.manifestInfoEntries- Additional information kept in the manifest.- Throws:
IllegalArgumentException- Thrown if thenamFinderModelincompatible withseqCodec.
-
TokenNameFinderModel
public TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, int beamSize, byte[] generatorDescriptor, Map<String, Object> resources, Map<String, String> manifestInfoEntries) Initializes aTokenNameFinderModelinstance via given parameters.- Parameters:
languageCode- The ISO conform language code.nameFinderModel- A validMaxentModel.beamSize- The beam size. Must be greater than0.generatorDescriptor- Thebyte[]representing the feature generator descriptor.resources- Additional resources in a mapping.manifestInfoEntries- Additional information kept in the manifest.- Throws:
IllegalArgumentException- Thrown if thenamFinderModelincompatible withseqCodec.
-
TokenNameFinderModel
public TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, Map<String, Object> resources, Map<String, String> manifestInfoEntries) Initializes aTokenNameFinderModelinstance via given parameters.- Parameters:
languageCode- The ISO conform language code.nameFinderModel- A validMaxentModel.resources- Additional resources in a mapping.manifestInfoEntries- Additional information kept in the manifest.- Throws:
IllegalArgumentException- Thrown if thenameFinderModelis incompatible withseqCodec.
-
TokenNameFinderModel
Initializes aTokenNameFinderModelinstance via a validInputStream.- Parameters:
in- TheInputStreamused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
TokenNameFinderModel
Initializes aTokenNameFinderModelinstance via a validFile.- Parameters:
modelFile- TheFileused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
TokenNameFinderModel
Initializes aTokenNameFinderModelinstance via a validPath.- Parameters:
modelPath- ThePathused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
TokenNameFinderModel
Initializes aTokenNameFinderModelinstance via a validURL.- Parameters:
modelURL- TheURLused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
-
Method Details
-
getNameFinderSequenceModel
- Returns:
- Retrieves a valid
SequenceClassificationModelornullif no matching one could be found.
-
getSequenceCodec
- Returns:
- Retrieves the
SequenceCodecin use.
-
getFactory
- Returns:
- Retrieves the
TokenNameFinderFactoryin use.
-
createArtifactSerializers
Create theserializers. Currently, for serializers related to features that require external resources, such asW2VClassesDictionaryobjects, the convention is to add its element tag name as key of the serializer map.For example, the element tag name for the
WordClusterFeatureGeneratorwhich usesW2VClassesDictionaryobjects serialized by theW2VClassesDictionarySerializeris 'wordcluster', which is the key used to add the serializer to the map.- Returns:
- A
Mapcontaining the addedserializers.
-