Package opennlp.tools.ml

Klasse TrainerFactory

java.lang.Object

opennlp.tools.ml.TrainerFactory

public class TrainerFactory
extends Object

A factory to initialize Trainer instances depending on a trainer type configured via TrainingParameters.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	TrainerFactory.TrainerType

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
TrainerFactory()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static <T> EventModelSequenceTrainer<T>	getEventModelSequenceTrainer(TrainingParameters trainParams, Map<String,String> reportMap)	Retrieves an EventModelSequenceTrainer that fits the given parameters.
static EventTrainer	getEventTrainer(TrainingParameters trainParams, Map<String,String> reportMap)	Retrieves an EventTrainer that fits the given parameters.
static SequenceTrainer	getSequenceModelTrainer(TrainingParameters trainParams, Map<String,String> reportMap)	Retrieves a SequenceTrainer that fits the given parameters.
static TrainerFactory.TrainerType	getTrainerType(TrainingParameters trainParams)	Determines the TrainerFactory.TrainerType based on the TrainingParameters.ALGORITHM_PARAM value.
static boolean	isValid(TrainingParameters trainParams)

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

TrainerFactory

public TrainerFactory()

Methodendetails

getTrainerType

public static TrainerFactory.TrainerType getTrainerType(TrainingParameters trainParams)

Determines the TrainerFactory.TrainerType based on the TrainingParameters.ALGORITHM_PARAM value.

Parameter:

trainParams - - A mapping of training parameters.

Gibt zurück:

The TrainerFactory.TrainerType or null if the type couldn't be determined.

getSequenceModelTrainer

public static SequenceTrainer getSequenceModelTrainer(TrainingParameters trainParams,
 Map<String,String> reportMap)

Retrieves a SequenceTrainer that fits the given parameters.

Parameter:

trainParams - The TrainingParameters to check for the trainer type. Note: The entry TrainingParameters.ALGORITHM_PARAM is used to determine the type.

reportMap - A Map that shall be used during initialization of the SequenceTrainer.

Gibt zurück:

A valid SequenceTrainer for the configured trainParams.

Löst aus:

IllegalArgumentException - Thrown if the trainer type could not be determined.

getEventModelSequenceTrainer

public static <T> EventModelSequenceTrainer<T> getEventModelSequenceTrainer(TrainingParameters trainParams,
 Map<String,String> reportMap)

Retrieves an EventModelSequenceTrainer that fits the given parameters.

Parameter:

trainParams - The TrainingParameters to check for the trainer type. Note: The entry TrainingParameters.ALGORITHM_PARAM is used to determine the type.

reportMap - A Map that shall be used during initialization of the EventModelSequenceTrainer.

Gibt zurück:

A valid EventModelSequenceTrainer for the configured trainParams.

Löst aus:

IllegalArgumentException - Thrown if the trainer type could not be determined.

getEventTrainer

public static EventTrainer getEventTrainer(TrainingParameters trainParams,
 Map<String,String> reportMap)

Retrieves an EventTrainer that fits the given parameters.

Parameter:

trainParams - The TrainingParameters to check for the trainer type. Note: The entry TrainingParameters.ALGORITHM_PARAM is used to determine the type. If the type is not defined, the GISTrainer.MAXENT_VALUE will be used.

reportMap - A Map that shall be used during initialization of the EventTrainer.

Gibt zurück:

A valid EventTrainer for the configured trainParams.

isValid

public static boolean isValid(TrainingParameters trainParams)

Parameter:

trainParams - The TrainingParameters to validate. Must not be null.

Gibt zurück:

true if the trainParams could be validated, false otherwise.