ai.djl.training.optimizer.learningrate

Enum WarmUpMode

java.lang.Object

java.lang.Enum<WarmUpMode>

ai.djl.training.optimizer.learningrate.WarmUpMode

All Implemented Interfaces:

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

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

An enum that enumerates the types of warm-up modes for a LearningRateTracker.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTANT
LINEAR

Method Summary

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

LINEAR

public static final WarmUpMode LINEAR

CONSTANT

public static final WarmUpMode CONSTANT

Method Detail

values

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

Returns:

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

valueOf

public static WarmUpMode 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