ai.idylnlp.models.opennlp.training.model

Enum TrainingAlgorithm

java.lang.Object

java.lang.Enum<TrainingAlgorithm>

ai.idylnlp.models.opennlp.training.model.TrainingAlgorithm

All Implemented Interfaces:

Serializable, Comparable<TrainingAlgorithm>

public enum TrainingAlgorithm
extends Enum<TrainingAlgorithm>

A training algorithm.

Author:

Mountain Fog, Inc.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAXENT_QN Uses the maxent algorithm with L-BFGFS.
PERCEPTRON Uses the perceptron algorithm.

Method Summary

Modifier and Type	Method and Description
static TrainingAlgorithm	fromValue(String algorithm) Gets the TrainingAlgorithm from a string value or throws an IllegalArgumentException if the algorithm string value is not a valid algorithm.
String	getAlgorithm() Gets the algorithm.
static TrainingAlgorithm	getDefaultAlgorithm() Gets the default TrainingAlgorithm.
String	getName() Gets the name of the algorithm.
String	toString()
static TrainingAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static TrainingAlgorithm[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MAXENT_QN

public static final TrainingAlgorithm MAXENT_QN

Uses the maxent algorithm with L-BFGFS.

PERCEPTRON

public static final TrainingAlgorithm PERCEPTRON

Uses the perceptron algorithm.

Method Detail

values

public static TrainingAlgorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TrainingAlgorithm c : TrainingAlgorithm.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TrainingAlgorithm valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getAlgorithm

public String getAlgorithm()

Gets the algorithm.

Returns:

The algorithm.

getName

public String getName()

Gets the name of the algorithm.

Returns:

The name of the algorithm.

getDefaultAlgorithm

public static TrainingAlgorithm getDefaultAlgorithm()

Gets the default TrainingAlgorithm.

Returns:

The default TrainingAlgorithm.

toString

public String toString()

Overrides:

toString in class Enum<TrainingAlgorithm>

fromValue

public static TrainingAlgorithm fromValue(String algorithm)

Gets the TrainingAlgorithm from a string value or throws an IllegalArgumentException if the algorithm string value is not a valid algorithm.

Parameters:

algorithm - The algorithm.

Returns:

A TrainingAlgorithm.