org.deeplearning4j.datasets.datavec

Enum SequenceRecordReaderDataSetIterator.AlignmentMode

java.lang.Object

java.lang.Enum<SequenceRecordReaderDataSetIterator.AlignmentMode>

org.deeplearning4j.datasets.datavec.SequenceRecordReaderDataSetIterator.AlignmentMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SequenceRecordReaderDataSetIterator.AlignmentMode>

Enclosing class:

SequenceRecordReaderDataSetIterator

public static enum SequenceRecordReaderDataSetIterator.AlignmentMode
extends java.lang.Enum<SequenceRecordReaderDataSetIterator.AlignmentMode>

Alignment mode for dealing with input/labels of differing lengths (for example, one-to-many and many-to-one type situations). For example, might have 10 time steps total but only one label at end for sequence classification.
Currently supported modes:
EQUAL_LENGTH: Default. Assume that label and input time series are of equal length, and all examples are of the same length
ALIGN_START: Align the label/input time series at the first time step, and zero pad either the labels or the input at the end
ALIGN_END: Align the label/input at the last time step, zero padding either the input or the labels as required
Note 1: When the time series for each example are of different lengths, the shorter time series will be padded to the length of the longest time series.
Note 2: When ALIGN_START or ALIGN_END are used, the DataSet masking functionality is used. Thus, the returned DataSets will have the input and mask arrays set. These mask arrays identify whether an input/label is actually present, or whether the value is merely masked.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIGN_END
ALIGN_START
EQUAL_LENGTH

Method Summary

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

EQUAL_LENGTH

public static final SequenceRecordReaderDataSetIterator.AlignmentMode EQUAL_LENGTH

ALIGN_START

public static final SequenceRecordReaderDataSetIterator.AlignmentMode ALIGN_START

ALIGN_END

public static final SequenceRecordReaderDataSetIterator.AlignmentMode ALIGN_END

Method Detail

values

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

Returns:

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

valueOf

public static SequenceRecordReaderDataSetIterator.AlignmentMode 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