Package org.nd4j.autodiff.listeners.impl

Enum UIListener.UpdateRatio

java.lang.Object

java.lang.Enum<UIListener.UpdateRatio>

org.nd4j.autodiff.listeners.impl.UIListener.UpdateRatio

All Implemented Interfaces:

Serializable, Comparable<UIListener.UpdateRatio>

Enclosing class:

UIListener

public static enum UIListener.UpdateRatio
extends Enum<UIListener.UpdateRatio>

Used to specify how the Update:Parameter ratios are computed. Only relevant when the update ratio calculation is enabled via UIListener.Builder.updateRatios(int, UpdateRatio); update ratio collection is disabled by default
L2: l2Norm(updates)/l2Norm(parameters) is used
MEAN_MAGNITUDE: mean(abs(updates))/mean(abs(parameters)) is used

Enum Constant Summary

Enum Constants

Enum Constant	Description
L2
MEAN_MAGNITUDE

Method Summary

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

L2

public static final UIListener.UpdateRatio L2

MEAN_MAGNITUDE

public static final UIListener.UpdateRatio MEAN_MAGNITUDE

Method Detail

values

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

Returns:

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

valueOf

public static UIListener.UpdateRatio 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