ai.idylnlp.models.opennlp.training

Class PartOfSpeechModelOperations

java.lang.Object

ai.idylnlp.models.opennlp.training.PartOfSpeechModelOperations

All Implemented Interfaces:

ModelSeparateDataValidationOperations<ai.idylnlp.model.training.AccuracyEvaluationResult>, ModelTrainingOperations

public class PartOfSpeechModelOperations
extends Object
implements ModelTrainingOperations, ModelSeparateDataValidationOperations<ai.idylnlp.model.training.AccuracyEvaluationResult>

Operations for training and validating part of speech models.

Author:

Mountain Fog, Inc.

Constructor Summary

Constructors

Constructor and Description
PartOfSpeechModelOperations()

Method Summary

Modifier and Type	Method and Description
ai.idylnlp.model.training.AccuracyEvaluationResult	separateDataEvaluate(ai.idylnlp.model.nlp.subjects.SubjectOfTrainingOrEvaluation SubjectOfTrainingOrEvaluation, String modelFileName, String encryptionKey) Performs model validation using separate data.
static String	train(TrainingDefinitionReader reader) Performs part-of-speech model training using a training definition file.
String	trainMaxEntQN(ai.idylnlp.model.nlp.subjects.SubjectOfTrainingOrEvaluation SubjectOfTrainingOrEvaluation, String modelFile, com.neovisionaries.i18n.LanguageCode language, String encryptionKey, int cutOff, int iterations, int threads, double l1, double l2, int m, int max) Train a maxent model using quasi-newton.
String	trainPerceptron(ai.idylnlp.model.nlp.subjects.SubjectOfTrainingOrEvaluation SubjectOfTrainingOrEvaluation, String modelFile, com.neovisionaries.i18n.LanguageCode language, String encryptionKey, int cutOff, int iterations) Train a perceptron model using.

Methods inherited from class java.lang.Object

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

Constructor Detail

PartOfSpeechModelOperations

public PartOfSpeechModelOperations()

Method Detail

train

public static String train(TrainingDefinitionReader reader)
                    throws IOException

Performs part-of-speech model training using a training definition file.

Parameters:

reader - A TrainingDefinitionReader.

Returns:

The generated model's ID.

Throws:

IOException - Thrown if the model creation fails.

separateDataEvaluate

public ai.idylnlp.model.training.AccuracyEvaluationResult separateDataEvaluate(ai.idylnlp.model.nlp.subjects.SubjectOfTrainingOrEvaluation SubjectOfTrainingOrEvaluation,
                                                                               String modelFileName,
                                                                               String encryptionKey)
                                                                        throws IOException

Description copied from interface: ModelSeparateDataValidationOperations

Performs model validation using separate data. This validation requires a built model file.

Specified by:

separateDataEvaluate in interface ModelSeparateDataValidationOperations<ai.idylnlp.model.training.AccuracyEvaluationResult>

Parameters:

SubjectOfTrainingOrEvaluation - The SubjectOfTrainingOrEvaluation.

modelFileName - The full path to the model file.

encryptionKey - The model's encryption key.

Returns:

The results of the validation as an FMeasure.

Throws:

IOException - Thrown if any of the input files cannot be read.

trainMaxEntQN

public String trainMaxEntQN(ai.idylnlp.model.nlp.subjects.SubjectOfTrainingOrEvaluation SubjectOfTrainingOrEvaluation,
                            String modelFile,
                            com.neovisionaries.i18n.LanguageCode language,
                            String encryptionKey,
                            int cutOff,
                            int iterations,
                            int threads,
                            double l1,
                            double l2,
                            int m,
                            int max)
                     throws IOException

Description copied from interface: ModelTrainingOperations

Train a maxent model using quasi-newton.

Specified by:

trainMaxEntQN in interface ModelTrainingOperations

Parameters:

SubjectOfTrainingOrEvaluation - The SubjectOfTrainingOrEvaluation.

modelFile - The output model file.

language - The language of the model.

encryptionKey - The model's encryption key.

cutOff - The training cutoff.

iterations - The training iterations.

threads - The number of training threads.

Returns:

The generated model's ID.

Throws:

IOException - Thrown if the model cannot be trained.

trainPerceptron

public String trainPerceptron(ai.idylnlp.model.nlp.subjects.SubjectOfTrainingOrEvaluation SubjectOfTrainingOrEvaluation,
                              String modelFile,
                              com.neovisionaries.i18n.LanguageCode language,
                              String encryptionKey,
                              int cutOff,
                              int iterations)
                       throws IOException

Description copied from interface: ModelTrainingOperations

Train a perceptron model using.

Specified by:

trainPerceptron in interface ModelTrainingOperations

Parameters:

SubjectOfTrainingOrEvaluation - The SubjectOfTrainingOrEvaluation.

modelFile - The output model file.

language - The language of the model.

encryptionKey - The model's encryption key.

cutOff - The training cutoff.

iterations - The training iterations.

Returns:

The generated model's ID.

Throws:

IOException - Thrown if the model cannot be trained.