org.deeplearning4j.nn.workspace

Enum ArrayType

java.lang.Object

java.lang.Enum<ArrayType>

org.deeplearning4j.nn.workspace.ArrayType

All Implemented Interfaces:

Serializable, Comparable<ArrayType>

public enum ArrayType
extends Enum<ArrayType>

Array type enumeration for use with LayerWorkspaceMgr

Array types:
INPUT: The array set to the input field of a layer (i.e., input activations)
ACTIVATIONS: The output activations for a layer's feed-forward method
ACTIVATION_GRAD: Activation gradient arrays - aka "epsilons" - output from a layer's backprop method
FF_WORKING_MEM: Working memory during feed-forward. Arrays allocated here will be invalidated once a layer's feed-forward method returns.
BP_WORKING_MEM: Working memory during backprop. Arrays allocated here will be invalidated once a layer's backprop method returns
RNN_FF_LOOP_WORKING_MEM: Working memory during a single time step of RNN forward pass. Opened/closed once per timestep for RNN layers only.
RNN_BP_LOOP_WORKING_MEM Working memory during a single time step of RNN backward pass. Opened/closed once per timestep for RNN layers only.
UPDATER_WORKING_MEM: Working memory for updaters (like Adam, Nesterovs etc.
FF_CACHE: Only used in some layers, and when CacheMode is not set to NONE. Used to increase performance at the expense of memory, by storing partial activations from forward pass, so they don't need to be recalculated during backprop

Author:

Alex Black

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVATION_GRAD
ACTIVATIONS
BP_WORKING_MEM
FF_CACHE
FF_WORKING_MEM
INPUT
RNN_BP_LOOP_WORKING_MEM
RNN_FF_LOOP_WORKING_MEM
UPDATER_WORKING_MEM

Method Summary

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

INPUT

public static final ArrayType INPUT

ACTIVATIONS

public static final ArrayType ACTIVATIONS

ACTIVATION_GRAD

public static final ArrayType ACTIVATION_GRAD

FF_WORKING_MEM

public static final ArrayType FF_WORKING_MEM

BP_WORKING_MEM

public static final ArrayType BP_WORKING_MEM

RNN_FF_LOOP_WORKING_MEM

public static final ArrayType RNN_FF_LOOP_WORKING_MEM

RNN_BP_LOOP_WORKING_MEM

public static final ArrayType RNN_BP_LOOP_WORKING_MEM

UPDATER_WORKING_MEM

public static final ArrayType UPDATER_WORKING_MEM

FF_CACHE

public static final ArrayType FF_CACHE

Method Detail

values

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

Returns:

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

valueOf

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