Package org.tribuo.math.optimisers

Enum Class GradientOptimiserOptions.StochasticGradientOptimiserType

java.lang.Object

java.lang.Enum<GradientOptimiserOptions.StochasticGradientOptimiserType>

org.tribuo.math.optimisers.GradientOptimiserOptions.StochasticGradientOptimiserType

All Implemented Interfaces:

Serializable, Comparable<GradientOptimiserOptions.StochasticGradientOptimiserType>, Constable

Enclosing class:

GradientOptimiserOptions

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

Type of the gradient optimisers available in CLIs.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADADELTA	The AdaDelta optimiser.
ADAGRAD	The AdaGrad optimiser.
ADAGRADRDA	The AdaGrad Regularised Dual Averaging optimiser.
ADAM	The Adam optimiser.
CONSTANTSGD	SGD with a constant learning rate.
LINEARSGD	SGD with a linear-decay learning rate.
PEGASOS	The Pegasos optimiser.
RMSPROP	The RMSProp optimiser.
SQRTSGD	SGD with a square root decay learning rate.

Method Summary

Modifier and Type	Method	Description
static GradientOptimiserOptions.StochasticGradientOptimiserType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GradientOptimiserOptions.StochasticGradientOptimiserType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADADELTA

public static final GradientOptimiserOptions.StochasticGradientOptimiserType ADADELTA

The AdaDelta optimiser.

ADAGRAD

public static final GradientOptimiserOptions.StochasticGradientOptimiserType ADAGRAD

The AdaGrad optimiser.

ADAGRADRDA

public static final GradientOptimiserOptions.StochasticGradientOptimiserType ADAGRADRDA

The AdaGrad Regularised Dual Averaging optimiser.

ADAM

public static final GradientOptimiserOptions.StochasticGradientOptimiserType ADAM

The Adam optimiser.

PEGASOS

public static final GradientOptimiserOptions.StochasticGradientOptimiserType PEGASOS

The Pegasos optimiser.

RMSPROP

public static final GradientOptimiserOptions.StochasticGradientOptimiserType RMSPROP

The RMSProp optimiser.

CONSTANTSGD

public static final GradientOptimiserOptions.StochasticGradientOptimiserType CONSTANTSGD

SGD with a constant learning rate.

LINEARSGD

public static final GradientOptimiserOptions.StochasticGradientOptimiserType LINEARSGD

SGD with a linear-decay learning rate.

SQRTSGD

public static final GradientOptimiserOptions.StochasticGradientOptimiserType SQRTSGD

SGD with a square root decay learning rate.

Method Details

values

public static GradientOptimiserOptions.StochasticGradientOptimiserType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static GradientOptimiserOptions.StochasticGradientOptimiserType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null