org.deeplearning4j.nn.api

Enum MaskState

java.lang.Object

java.lang.Enum<MaskState>

org.deeplearning4j.nn.api.MaskState

All Implemented Interfaces:

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

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

MaskState: specifies whether a mask should be applied or not. Masks should not be applied in all cases, depending on the network configuration - for example input Dense -> RNN -> Dense -> RnnOutputLayer
The first dense layer should be masked (using the input mask) whereas the second shouldn't be, as it has valid data coming from the RNN layer below. For variable length situations like that, the masking can be implemented using the label mask, which will backpropagate 0s for those time steps.
In other cases, the *should* be applied - for example, input -> BidirectionalRnn -> Dense -> Output. In such a case, the dense layer should be masked using the input mask.

Essentially: Active = apply mask to activations and errors.
Passthrough = feed forward the input mask (if/when necessary) but don't actually apply it.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Active
Passthrough

Method Summary

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

Active

public static final MaskState Active

Passthrough

public static final MaskState Passthrough

Method Detail

values

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

Returns:

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

valueOf

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