ai.djl.nn.recurrent

Class RecurrentCell

java.lang.Object

ai.djl.nn.AbstractBlock

ai.djl.nn.ParameterBlock

ai.djl.nn.recurrent.RecurrentCell

All Implemented Interfaces:

Block

Direct Known Subclasses:

GRU, LSTM, RNN

public abstract class RecurrentCell
extends ParameterBlock

Applies recurrent layers to input data. Currently, vanilla RNN, LSTM and GRU are implemented, with both multi-layer and bidirectional support.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecurrentCell.BaseBuilder<T extends RecurrentCell.BaseBuilder> The Builder to construct a RecurrentCell type of Block.

Field Summary

Fields

Modifier and Type	Field and Description
protected float	dropRate
protected java.lang.String	mode
protected int	numStackedLayers
protected boolean	stateOutputs
protected long	stateSize
protected boolean	useBidirectional
protected boolean	useSequenceLength

Fields inherited from class ai.djl.nn.AbstractBlock

inputNames, inputShapes

Constructor Summary

Constructors

Constructor and Description
RecurrentCell(RecurrentCell.BaseBuilder<?> builder) Creates a RecurrentCell object.

Method Summary

Modifier and Type	Method and Description
protected void	validateInputSize(NDList inputs)

Methods inherited from class ai.djl.nn.ParameterBlock

getChildren, initialize, toString

Methods inherited from class ai.djl.nn.AbstractBlock

beforeInitialize, cast, clear, describeInput, getParameters, isInitialized, setInitializer, setInitializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.nn.Block

forward, forward, getDirectParameters, getOutputShapes, getParameterShape, loadParameters, saveParameters, validateLayout

Field Detail

stateSize

protected long stateSize

dropRate

protected float dropRate

numStackedLayers

protected int numStackedLayers

mode

protected java.lang.String mode

useSequenceLength

protected boolean useSequenceLength

useBidirectional

protected boolean useBidirectional

stateOutputs

protected boolean stateOutputs

Constructor Detail

RecurrentCell

public RecurrentCell(RecurrentCell.BaseBuilder<?> builder)

Creates a RecurrentCell object.

Parameters:

builder - the Builder that has the necessary configurations

Method Detail

validateInputSize

protected void validateInputSize(NDList inputs)