org.tribuo.math.optimisers

Enum GradientOptimiserOptions.StochasticGradientOptimiserType

java.lang.Object

java.lang.Enum<GradientOptimiserOptions.StochasticGradientOptimiserType>

org.tribuo.math.optimisers.GradientOptimiserOptions.StochasticGradientOptimiserType

All Implemented Interfaces:

Serializable, Comparable<GradientOptimiserOptions.StochasticGradientOptimiserType>

Enclosing class:

GradientOptimiserOptions

public static enum GradientOptimiserOptions.StochasticGradientOptimiserType
extends Enum<GradientOptimiserOptions.StochasticGradientOptimiserType>

Type of the gradient optimisers available in CLIs.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADADELTA
ADAGRAD
ADAGRADRDA
ADAM
CONSTANTSGD
LINEARSGD
PEGASOS
RMSPROP
SQRTSGD

Method Summary

Modifier and Type	Method and Description
static GradientOptimiserOptions.StochasticGradientOptimiserType	valueOf(String name) Returns the enum constant of this type with the specified name.
static GradientOptimiserOptions.StochasticGradientOptimiserType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADADELTA

public static final GradientOptimiserOptions.StochasticGradientOptimiserType ADADELTA

ADAGRAD

public static final GradientOptimiserOptions.StochasticGradientOptimiserType ADAGRAD

ADAGRADRDA

public static final GradientOptimiserOptions.StochasticGradientOptimiserType ADAGRADRDA

ADAM

public static final GradientOptimiserOptions.StochasticGradientOptimiserType ADAM

PEGASOS

public static final GradientOptimiserOptions.StochasticGradientOptimiserType PEGASOS

RMSPROP

public static final GradientOptimiserOptions.StochasticGradientOptimiserType RMSPROP

CONSTANTSGD

public static final GradientOptimiserOptions.StochasticGradientOptimiserType CONSTANTSGD

LINEARSGD

public static final GradientOptimiserOptions.StochasticGradientOptimiserType LINEARSGD

SQRTSGD

public static final GradientOptimiserOptions.StochasticGradientOptimiserType SQRTSGD

Method Detail

values

public static GradientOptimiserOptions.StochasticGradientOptimiserType[] 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 (GradientOptimiserOptions.StochasticGradientOptimiserType c : GradientOptimiserOptions.StochasticGradientOptimiserType.values())
    System.out.println(c);

Returns:

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

valueOf

public static GradientOptimiserOptions.StochasticGradientOptimiserType 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