Package org.deeplearning4j.nn.conf.layers

Class BaseRecurrentLayer

java.lang.Object

org.deeplearning4j.nn.conf.layers.Layer

org.deeplearning4j.nn.conf.layers.BaseLayer

org.deeplearning4j.nn.conf.layers.FeedForwardLayer

org.deeplearning4j.nn.conf.layers.BaseRecurrentLayer

All Implemented Interfaces:

Serializable, Cloneable, TrainingConfig

Direct Known Subclasses:

AbstractLSTM, GravesBidirectionalLSTM, SimpleRnn

public abstract class BaseRecurrentLayer
extends FeedForwardLayer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseRecurrentLayer.Builder<T extends BaseRecurrentLayer.Builder<T>>

Field Summary

Fields

Modifier and Type	Field	Description
protected RNNFormat	rnnDataFormat
protected IWeightInit	weightInitFnRecurrent

Fields inherited from class org.deeplearning4j.nn.conf.layers.FeedForwardLayer

nIn, nOut, timeDistributedFormat

Fields inherited from class org.deeplearning4j.nn.conf.layers.BaseLayer

activationFn, biasInit, biasUpdater, gainInit, gradientNormalization, gradientNormalizationThreshold, iUpdater, regularization, regularizationBias, weightInitFn, weightNoise

Fields inherited from class org.deeplearning4j.nn.conf.layers.Layer

constraints, iDropout, layerName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseRecurrentLayer(BaseRecurrentLayer.Builder builder)

Method Summary

Modifier and Type	Method	Description
InputType	getOutputType(int layerIndex, InputType inputType)	For a given type of input to this layer, what is the type of the output?
InputPreProcessor	getPreProcessorForInputType(InputType inputType)	For the given type of input to this layer, what preprocessor (if any) is required? Returns null if no preprocessor is required, otherwise returns an appropriate InputPreProcessor for this layer, such as a CnnToFeedForwardPreProcessor
void	setNIn(InputType inputType, boolean override)	Set the nIn value (number of inputs, or input channels for CNNs) based on the given input type

Methods inherited from class org.deeplearning4j.nn.conf.layers.FeedForwardLayer

isPretrainParam

Methods inherited from class org.deeplearning4j.nn.conf.layers.BaseLayer

clone, getGradientNormalization, getRegularizationByParam, getUpdaterByParam, resetLayerDefaultConfig

Methods inherited from class org.deeplearning4j.nn.conf.layers.Layer

getMemoryReport, initializeConstraints, initializer, instantiate, setDataType

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.deeplearning4j.nn.api.TrainingConfig

getGradientNormalizationThreshold, getLayerName

Field Detail

weightInitFnRecurrent

protected IWeightInit weightInitFnRecurrent

rnnDataFormat

protected RNNFormat rnnDataFormat

Constructor Detail

BaseRecurrentLayer

protected BaseRecurrentLayer(BaseRecurrentLayer.Builder builder)

Method Detail

getOutputType

public InputType getOutputType(int layerIndex,
                               InputType inputType)

Description copied from class: Layer

For a given type of input to this layer, what is the type of the output?

Overrides:

getOutputType in class FeedForwardLayer

Parameters:

layerIndex - Index of the layer

inputType - Type of input for the layer

Returns:

Type of output from the layer

setNIn

public void setNIn(InputType inputType,
                   boolean override)

Description copied from class: Layer

Set the nIn value (number of inputs, or input channels for CNNs) based on the given input type

Overrides:

setNIn in class FeedForwardLayer

Parameters:

inputType - Input type for this layer

override - If false: only set the nIn value if it's not already set. If true: set it regardless of whether it's already set or not.

getPreProcessorForInputType

public InputPreProcessor getPreProcessorForInputType(InputType inputType)

Description copied from class: Layer

For the given type of input to this layer, what preprocessor (if any) is required?
Returns null if no preprocessor is required, otherwise returns an appropriate InputPreProcessor for this layer, such as a CnnToFeedForwardPreProcessor

Overrides:

getPreProcessorForInputType in class FeedForwardLayer

Parameters:

inputType - InputType to this layer

Returns:

Null if no preprocessor is required, otherwise the type of preprocessor necessary for this layer/input combination