org.deeplearning4j.nn.api

Enum OptimizationAlgorithm

java.lang.Object

java.lang.Enum<OptimizationAlgorithm>

org.deeplearning4j.nn.api.OptimizationAlgorithm

All Implemented Interfaces:

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

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

Optimization algorithm to use

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONJUGATE_GRADIENT
HESSIAN_FREE Deprecated.
LBFGS
LINE_GRADIENT_DESCENT
STOCHASTIC_GRADIENT_DESCENT

Method Summary

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

LINE_GRADIENT_DESCENT

public static final OptimizationAlgorithm LINE_GRADIENT_DESCENT

CONJUGATE_GRADIENT

public static final OptimizationAlgorithm CONJUGATE_GRADIENT

HESSIAN_FREE

@Deprecated
public static final OptimizationAlgorithm HESSIAN_FREE

Deprecated.

LBFGS

public static final OptimizationAlgorithm LBFGS

STOCHASTIC_GRADIENT_DESCENT

public static final OptimizationAlgorithm STOCHASTIC_GRADIENT_DESCENT

Method Detail

values

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

Returns:

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

valueOf

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