Package org.deeplearning4j.nn.conf

Enum Updater

java.lang.Object

java.lang.Enum<Updater>

org.deeplearning4j.nn.conf.Updater

All Implemented Interfaces:

Serializable, Comparable<Updater>

public enum Updater
extends Enum<Updater>

All the possible different updaters

Author:

Adam Gibson

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADADELTA
ADAGRAD
ADAM
ADAMAX
CUSTOM	Deprecated.
NADAM
NESTEROVS
NONE
RMSPROP
SGD

Method Summary

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

SGD

public static final Updater SGD

ADAM

public static final Updater ADAM

ADAMAX

public static final Updater ADAMAX

ADADELTA

public static final Updater ADADELTA

NESTEROVS

public static final Updater NESTEROVS

NADAM

public static final Updater NADAM

ADAGRAD

public static final Updater ADAGRAD

RMSPROP

public static final Updater RMSPROP

NONE

public static final Updater NONE

CUSTOM

@Deprecated
public static final Updater CUSTOM

Deprecated.

Method Detail

values

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

Returns:

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

valueOf

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

getIUpdaterWithDefaultConfig

public IUpdater getIUpdaterWithDefaultConfig()