org.deeplearning4j.nn.conf

Enum LearningRatePolicy

java.lang.Object

java.lang.Enum<LearningRatePolicy>

org.deeplearning4j.nn.conf.LearningRatePolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LearningRatePolicy>

public enum LearningRatePolicy
extends java.lang.Enum<LearningRatePolicy>

Learning Rate Policy How to decay learning rate during training.

None = do not apply decay policy aka fixed in Caffe

Exponential = applies decay rate to the power of the # batches

Inverse = divide learning rate by negative (1 + decay rate * # batches)^power

Poly = polynomial decay that hits 0 when iterations are complete

Sigmoid = sigmoid decay rate

Step = decay rate to the power of the floor (nearest integer) of # of batches by # of steps

Schedule = rate to use at a specific iteration

Score = apply decay when score stops improving

Enum Constant Summary

Enum Constants

Enum Constant and Description
Exponential
Inverse
None
Poly
Schedule
Score
Sigmoid
Step
TorchStep

Method Summary

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

None

public static final LearningRatePolicy None

Exponential

public static final LearningRatePolicy Exponential

Inverse

public static final LearningRatePolicy Inverse

Poly

public static final LearningRatePolicy Poly

Sigmoid

public static final LearningRatePolicy Sigmoid

Step

public static final LearningRatePolicy Step

TorchStep

public static final LearningRatePolicy TorchStep

Schedule

public static final LearningRatePolicy Schedule

Score

public static final LearningRatePolicy Score

Method Detail

values

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

Returns:

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

valueOf

public static LearningRatePolicy valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null