Package opennlp.tools.namefind

Klasse TokenNameFinderModel

java.lang.Object

opennlp.tools.util.model.BaseModel

opennlp.tools.namefind.TokenNameFinderModel

Alle implementierten Schnittstellen:

Serializable, ArtifactProvider

public class TokenNameFinderModel
extends BaseModel

The TokenNameFinderModel is the model used by a learnable TokenNameFinder.

Siehe auch:

• NameFinderME
• Serialisierte Form

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	TokenNameFinderModel.FeatureGeneratorCreationError

Feldübersicht

Von Klasse geerbte Felder opennlp.tools.util.model.BaseModel

TRAINING_CUTOFF_PROPERTY, TRAINING_EVENTHASH_PROPERTY, TRAINING_ITERATIONS_PROPERTY

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
TokenNameFinderModel(File modelFile)	Initializes a TokenNameFinderModel instance via a valid File.
TokenNameFinderModel(InputStream in)	Initializes a TokenNameFinderModel instance via a valid InputStream.
TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, byte[] generatorDescriptor, Map<String,Object> resources, Map<String,String> manifestInfoEntries)	Initializes a TokenNameFinderModel instance via given parameters.
TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, int beamSize, byte[] generatorDescriptor, Map<String,Object> resources, Map<String,String> manifestInfoEntries)	Initializes a TokenNameFinderModel instance 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 a TokenNameFinderModel instance via given parameters.
TokenNameFinderModel(String languageCode, MaxentModel nameFinderModel, Map<String,Object> resources, Map<String,String> manifestInfoEntries)	Initializes a TokenNameFinderModel instance via given parameters.
TokenNameFinderModel(String languageCode, SequenceClassificationModel nameFinderModel, byte[] generatorDescriptor, Map<String,Object> resources, Map<String,String> manifestInfoEntries, SequenceCodec<String> seqCodec, TokenNameFinderFactory factory)	Initializes a TokenNameFinderModel instance via given parameters.
TokenNameFinderModel(URL modelURL)	Initializes a TokenNameFinderModel instance via a valid URL.
TokenNameFinderModel(Path modelPath)	Initializes a TokenNameFinderModel instance via a valid Path.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static Map<String,ArtifactSerializer<?>>	createArtifactSerializers()	Create the serializers.
TokenNameFinderFactory	getFactory()
SequenceClassificationModel	getNameFinderSequenceModel()
SequenceCodec<String>	getSequenceCodec()

Von Klasse geerbte Methoden opennlp.tools.util.model.BaseModel

getArtifact, getLanguage, getManifestProperty, getVersion, isLoadedFromSerialized, serialize, serialize, serialize

Von Klasse geerbte Methoden java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

TokenNameFinderModel

public TokenNameFinderModel(String languageCode,
 SequenceClassificationModel nameFinderModel,
 byte[] generatorDescriptor,
 Map<String,Object> resources,
 Map<String,String> manifestInfoEntries,
 SequenceCodec<String> seqCodec,
 TokenNameFinderFactory factory)

Initializes a TokenNameFinderModel instance via given parameters.

Parameter:

languageCode - The ISO conform language code.

nameFinderModel - A valid MaxentModel.

generatorDescriptor - The byte[] representing the feature generator descriptor.

resources - Additional resources in a mapping.

manifestInfoEntries - Additional information kept in the manifest.

seqCodec - The SequenceCodec to use.

factory - The TokenNameFinderFactory for creating related objects.

Löst aus:

IllegalArgumentException - Thrown if the namFinderModel incompatible with seqCodec.

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 a TokenNameFinderModel instance via given parameters.

Parameter:

languageCode - The ISO conform language code.

nameFinderModel - A valid MaxentModel.

beamSize - The beam size. Must be greater than 0.

generatorDescriptor - The byte[] representing the feature generator descriptor.

resources - Additional resources in a mapping.

manifestInfoEntries - Additional information kept in the manifest.

seqCodec - The SequenceCodec to use.

factory - The TokenNameFinderFactory for creating related objects.

Löst aus:

IllegalArgumentException - Thrown if the namFinderModel incompatible with seqCodec.

TokenNameFinderModel

public TokenNameFinderModel(String languageCode,
 MaxentModel nameFinderModel,
 byte[] generatorDescriptor,
 Map<String,Object> resources,
 Map<String,String> manifestInfoEntries)

Initializes a TokenNameFinderModel instance via given parameters.

Parameter:

languageCode - The ISO conform language code.

nameFinderModel - A valid MaxentModel.

generatorDescriptor - The byte[] representing the feature generator descriptor.

resources - Additional resources in a mapping.

manifestInfoEntries - Additional information kept in the manifest.

Löst aus:

IllegalArgumentException - Thrown if the namFinderModel incompatible with seqCodec.

TokenNameFinderModel

public TokenNameFinderModel(String languageCode,
 MaxentModel nameFinderModel,
 int beamSize,
 byte[] generatorDescriptor,
 Map<String,Object> resources,
 Map<String,String> manifestInfoEntries)

Initializes a TokenNameFinderModel instance via given parameters.

Parameter:

languageCode - The ISO conform language code.

nameFinderModel - A valid MaxentModel.

beamSize - The beam size. Must be greater than 0.

generatorDescriptor - The byte[] representing the feature generator descriptor.

resources - Additional resources in a mapping.

manifestInfoEntries - Additional information kept in the manifest.

Löst aus:

IllegalArgumentException - Thrown if the namFinderModel incompatible with seqCodec.

TokenNameFinderModel

public TokenNameFinderModel(String languageCode,
 MaxentModel nameFinderModel,
 Map<String,Object> resources,
 Map<String,String> manifestInfoEntries)

Initializes a TokenNameFinderModel instance via given parameters.

Parameter:

languageCode - The ISO conform language code.

nameFinderModel - A valid MaxentModel.

resources - Additional resources in a mapping.

manifestInfoEntries - Additional information kept in the manifest.

Löst aus:

IllegalArgumentException - Thrown if the nameFinderModel is incompatible with seqCodec.

TokenNameFinderModel

public TokenNameFinderModel(InputStream in)
                     throws IOException

Initializes a TokenNameFinderModel instance via a valid InputStream.

Parameter:

in - The InputStream used for loading the model.

Löst aus:

IOException - Thrown if IO errors occurred during initialization.

TokenNameFinderModel

public TokenNameFinderModel(File modelFile)
                     throws IOException

Initializes a TokenNameFinderModel instance via a valid File.

Parameter:

modelFile - The File used for loading the model.

Löst aus:

IOException - Thrown if IO errors occurred during initialization.

TokenNameFinderModel

public TokenNameFinderModel(Path modelPath)
                     throws IOException

Initializes a TokenNameFinderModel instance via a valid Path.

Parameter:

modelPath - The Path used for loading the model.

Löst aus:

IOException - Thrown if IO errors occurred during initialization.

TokenNameFinderModel

public TokenNameFinderModel(URL modelURL)
                     throws IOException

Initializes a TokenNameFinderModel instance via a valid URL.

Parameter:

modelURL - The URL used for loading the model.

Löst aus:

IOException - Thrown if IO errors occurred during initialization.

Methodendetails

getNameFinderSequenceModel

public SequenceClassificationModel getNameFinderSequenceModel()

Gibt zurück:

Retrieves a valid SequenceClassificationModel or null if no matching one could be found.

getSequenceCodec

public SequenceCodec<String> getSequenceCodec()

Gibt zurück:

Retrieves the SequenceCodec in use.

getFactory

public TokenNameFinderFactory getFactory()

Gibt zurück:

Retrieves the TokenNameFinderFactory in use.

createArtifactSerializers

public static Map<String,ArtifactSerializer<?>> createArtifactSerializers()

Create the serializers. Currently, for serializers related to features that require external resources, such as W2VClassesDictionary objects, the convention is to add its element tag name as key of the serializer map.

For example, the element tag name for the WordClusterFeatureGenerator which uses W2VClassesDictionary objects serialized by the W2VClassesDictionarySerializer is 'wordcluster', which is the key used to add the serializer to the map.

Gibt zurück:

A Map containing the added serializers.