org.nd4j.autodiff.listeners.impl

Enum UIListener.HistogramType

java.lang.Object

java.lang.Enum<UIListener.HistogramType>

org.nd4j.autodiff.listeners.impl.UIListener.HistogramType

All Implemented Interfaces:

Serializable, Comparable<UIListener.HistogramType>

Enclosing class:

UIListener

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

Used to specify which histograms should be collected. Histogram collection is disabled by default, but can be enabled via Builder#histograms(int, HistogramType...). Note that multiple histogram types may be collected simultaneously.
Histograms may be collected for:
PARAMETERS: All trainable parameters
PARAMETER_GRADIENTS: Gradients corresponding to the trainable parameters
PARAMETER_UPDATES: All trainable parameter updates, before they are applied during training (updates are gradients after applying updater and learning rate etc)
ACTIVATIONS: Activations - ARRAY type SDVariables - those that are not constants, variables or placeholders
ACTIVATION_GRADIENTS: Activation gradients

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVATION_GRADIENTS
ACTIVATIONS
PARAMETER_GRADIENTS
PARAMETER_UPDATES
PARAMETERS

Method Summary

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

PARAMETERS

public static final UIListener.HistogramType PARAMETERS

PARAMETER_GRADIENTS

public static final UIListener.HistogramType PARAMETER_GRADIENTS

PARAMETER_UPDATES

public static final UIListener.HistogramType PARAMETER_UPDATES

ACTIVATIONS

public static final UIListener.HistogramType ACTIVATIONS

ACTIVATION_GRADIENTS

public static final UIListener.HistogramType ACTIVATION_GRADIENTS

Method Detail

values

public static UIListener.HistogramType[] 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.HistogramType c : UIListener.HistogramType.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.HistogramType 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