Class AbstractTrainer
java.lang.Object
opennlp.tools.ml.AbstractTrainer
- All Implemented Interfaces:
Trainer
- Direct Known Subclasses:
AbstractEventModelSequenceTrainer, AbstractEventTrainer
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAbstractTrainer(TrainingParameters trainParams) Initializes aAbstractTrainerviaTrainingParameters. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddToReport(String key, String value) Adds the key-value pair to the report map.intintRetrieves theTrainingConfigurationassociated with anAbstractTrainer.voidinit(TrainingParameters trainParams, Map<String, String> reportMap) voidinit(TrainingParameters trainParams, Map<String, String> reportMap, TrainingConfiguration config) Conducts the initialization of aTrainerviaTrainingParameters,report mapandTrainingConfigurationvoidvalidate()Checks the configuredparameters.
-
Field Details
-
trainingParameters
-
reportMap
-
trainingConfiguration
-
-
Constructor Details
-
AbstractTrainer
public AbstractTrainer() -
AbstractTrainer
Initializes aAbstractTrainerviaTrainingParameters.- Parameters:
trainParams- TheTrainingParametersto use.
-
-
Method Details
-
init
- Specified by:
initin interfaceTrainer- Parameters:
trainParams- TheTrainingParametersto use.reportMap- TheMapinstance used as report map.
-
init
public void init(TrainingParameters trainParams, Map<String, String> reportMap, TrainingConfiguration config) Conducts the initialization of aTrainerviaTrainingParameters,report mapandTrainingConfiguration- Specified by:
initin interfaceTrainer- Parameters:
trainParams- TheTrainingParametersto use.reportMap- TheMapinstance used as report map.config- TheTrainingConfigurationto use. If null, suitable defaults will be used.
-
getAlgorithm
- Returns:
- Retrieves the configured
TrainingParameters.ALGORITHM_PARAMvalue.
-
getCutoff
public int getCutoff()- Returns:
- Retrieves the configured
TrainingParameters.CUTOFF_PARAMvalue.
-
getIterations
public int getIterations()- Returns:
- Retrieves the configured
TrainingParameters.ITERATIONS_PARAMvalue.
-
validate
public void validate()Checks the configuredparameters. If a subclass overrides this, it should callsuper.validate();.- Throws:
IllegalArgumentException- Thrown if default training parameters are invalid.
-
addToReport
-
getTrainingConfiguration
Retrieves theTrainingConfigurationassociated with anAbstractTrainer.- Returns:
TrainingConfiguration
-