Class LemmatizerModel
java.lang.Object
opennlp.tools.util.model.BaseModel
opennlp.tools.lemmatizer.LemmatizerModel
- All Implemented Interfaces:
Serializable, ArtifactProvider
The
LemmatizerModel is the model used by a learnable Lemmatizer.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Stringprivate static final Stringprivate static final longFields inherited from class BaseModel
artifactMap, FACTORY_NAME, MANIFEST_ENTRY, toolFactory, TRAINING_CUTOFF_PROPERTY, TRAINING_EVENTHASH_PROPERTY, TRAINING_ITERATIONS_PROPERTY -
Constructor Summary
ConstructorsConstructorDescriptionLemmatizerModel(File modelFile) Initializes aLemmatizerModelinstance via a validFile.Initializes aLemmatizerModelinstance via a validInputStream.LemmatizerModel(String languageCode, MaxentModel lemmatizerModel, int beamSize, Map<String, String> manifestInfoEntries, LemmatizerFactory factory) Initializes aLemmatizerModelinstance via given parameters.LemmatizerModel(String languageCode, MaxentModel lemmatizerModel, Map<String, String> manifestInfoEntries, LemmatizerFactory factory) Initializes aLemmatizerModelinstance via given parameters.LemmatizerModel(String languageCode, MaxentModel lemmatizerModel, LemmatizerFactory factory) Initializes aLemmatizerModelinstance via given parameters.LemmatizerModel(String languageCode, SequenceClassificationModel lemmatizerModel, Map<String, String> manifestInfoEntries, LemmatizerFactory factory) Initializes aLemmatizerModelinstance via given parameters.LemmatizerModel(URL modelURL) Initializes aLemmatizerModelinstance via a validURL.LemmatizerModel(Path modelPath) Initializes aLemmatizerModelinstance via a validPath. -
Method Summary
Modifier and TypeMethodDescriptionprotected Class<? extends BaseToolFactory> Subclasses should override this method if their module has a defaultBaseToolFactorysubclass.protected voidValidates the parsed artifacts.Methods inherited from class BaseModel
checkArtifactMap, createArtifactSerializers, createArtifactSerializers, deserialize, getArtifact, getArtifactSerializer, getLanguage, getManifestProperty, getVersion, isLoadedFromSerialized, serialize, serialize, serialize, setManifestProperty, skipEntryForSerialization
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
COMPONENT_NAME
- See Also:
-
LEMMATIZER_MODEL_ENTRY_NAME
- See Also:
-
-
Constructor Details
-
LemmatizerModel
public LemmatizerModel(String languageCode, SequenceClassificationModel lemmatizerModel, Map<String, String> manifestInfoEntries, LemmatizerFactory factory) Initializes aLemmatizerModelinstance via given parameters.- Parameters:
languageCode- An ISO conform language code.lemmatizerModel- A validSequenceClassificationModel.manifestInfoEntries- Additional information kept in the manifest.factory- TheLemmatizerFactoryfor creating related objects.
-
LemmatizerModel
public LemmatizerModel(String languageCode, MaxentModel lemmatizerModel, Map<String, String> manifestInfoEntries, LemmatizerFactory factory) Initializes aLemmatizerModelinstance via given parameters.- Parameters:
languageCode- An ISO conform language code.lemmatizerModel- A validMaxentModel.manifestInfoEntries- Additional information kept in the manifest.factory- TheLemmatizerFactoryfor creating related objects.
-
LemmatizerModel
public LemmatizerModel(String languageCode, MaxentModel lemmatizerModel, int beamSize, Map<String, String> manifestInfoEntries, LemmatizerFactory factory) Initializes aLemmatizerModelinstance via given parameters.- Parameters:
languageCode- An ISO conform language code.lemmatizerModel- A validMaxentModel.beamSize- The size of the beam that should be used when decoding sequences.manifestInfoEntries- Additional information kept in the manifest.factory- TheLemmatizerFactoryfor creating related objects.
-
LemmatizerModel
Initializes aLemmatizerModelinstance via given parameters.- Parameters:
languageCode- An ISO conform language code.lemmatizerModel- A validMaxentModel.factory- TheLemmatizerFactoryfor creating related objects.
-
LemmatizerModel
Initializes aLemmatizerModelinstance via a validInputStream.- Parameters:
in- TheInputStreamused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
LemmatizerModel
Initializes aLemmatizerModelinstance via a validFile.- Parameters:
modelFile- TheFileused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
LemmatizerModel
Initializes aLemmatizerModelinstance via a validPath.- Parameters:
modelPath- ThePathused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
LemmatizerModel
Initializes aLemmatizerModelinstance via a validURL.- Parameters:
modelURL- TheURLused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
-
Method Details
-
validateArtifactMap
Description copied from class:BaseModelValidates the parsed artifacts. If something is not valid, subclasses should throw anInvalidFormatException.Note: Subclasses should generally invoke
super.validateArtifactMapat the beginning of this method.- Overrides:
validateArtifactMapin classBaseModel- Throws:
InvalidFormatException- Thrown if artifacts were found to be inconsistent.
-
getLemmatizerSequenceModel
- Returns:
- Retrieves a
SequenceClassificationModelinstance.
-
getDefaultFactory
Description copied from class:BaseModelSubclasses should override this method if their module has a defaultBaseToolFactorysubclass.- Overrides:
getDefaultFactoryin classBaseModel- Returns:
- The default
BaseToolFactoryfor the component, ornullif none.
-
getFactory
- Returns:
- Retrieves the active
LemmatizerFactory.
-