org.nd4j.autodiff.samediff.ops

Class SDRNN

java.lang.Object

org.nd4j.autodiff.samediff.ops.SDOps

org.nd4j.autodiff.samediff.ops.SDRNN

public class SDRNN
extends SDOps

SameDiff Recurrent Neural Network operations
Accessible via SameDiff.rnn()
See also SDNN (accessible via SameDiff.nn() for general neural network ops.
See also SDCNN (accessible via SameDiff.cnn() for convolutional neural network ops.

Author:

Alex Black

Field Summary

Fields inherited from class org.nd4j.autodiff.samediff.ops.SDOps

sd

Constructor Summary

Constructors

Constructor and Description
SDRNN(SameDiff sameDiff)

Method Summary

Modifier and Type	Method and Description
GRUCellOutputs	gru(SDVariable x, SDVariable hLast, GRUWeights weights) See gru(String, SDVariable, SDVariable, GRUWeights).
GRUCellOutputs	gru(String baseName, SDVariable x, SDVariable hLast, GRUWeights weights) The GRU cell.
LSTMCellOutputs	lstmCell(SDVariable x, SDVariable cLast, SDVariable yLast, LSTMWeights weights, LSTMConfiguration config) See lstmCell(String, SDVariable, SDVariable, SDVariable, LSTMWeights, LSTMConfiguration).
LSTMCellOutputs	lstmCell(String baseName, SDVariable x, SDVariable cLast, SDVariable yLast, LSTMWeights weights, LSTMConfiguration config) The LSTM cell.
LSTMLayerOutputs	lstmLayer(int maxTSLength, SDVariable x, SDVariable cLast, SDVariable yLast, LSTMWeights weights, LSTMConfiguration config) See lstmLayer(String, SDVariable, SDVariable, SDVariable, SDVariable, LSTMWeights, LSTMConfiguration)
LSTMLayerOutputs	lstmLayer(SDVariable maxTSLength, SDVariable x, SDVariable cLast, SDVariable yLast, LSTMWeights weights, LSTMConfiguration config) See lstmLayer(String, SDVariable, SDVariable, SDVariable, SDVariable, LSTMWeights, LSTMConfiguration)
LSTMLayerOutputs	lstmLayer(String baseName, int maxTSLength, SDVariable x, SDVariable cLast, SDVariable yLast, LSTMWeights weights, LSTMConfiguration config) See lstmLayer(String, SDVariable, SDVariable, SDVariable, SDVariable, LSTMWeights, LSTMConfiguration)
LSTMLayerOutputs	lstmLayer(String baseName, SDVariable maxTSLength, SDVariable x, SDVariable cLast, SDVariable yLast, LSTMWeights weights, LSTMConfiguration config) The LSTM layer.
SRULayerOutputs	sru(SDVariable x, SDVariable initialC, SDVariable mask, SRUWeights weights) See sru(String, SDVariable, SDVariable, SDVariable, SRUWeights)
SRULayerOutputs	sru(SDVariable x, SDVariable initialC, SRUWeights weights) See sru(String, SDVariable, SDVariable, SDVariable, SRUWeights)
SRULayerOutputs	sru(String baseName, SDVariable x, SDVariable initialC, SDVariable mask, SRUWeights weights) The SRU layer.
SRULayerOutputs	sru(String baseName, SDVariable x, SDVariable initialC, SRUWeights weights) See sru(String, SDVariable, SDVariable, SDVariable, SRUWeights)
SRUCellOutputs	sruCell(SDVariable x, SDVariable cLast, SRUWeights weights) See sruCell(String, SDVariable, SDVariable, SRUWeights).
SRUCellOutputs	sruCell(String baseName, SDVariable x, SDVariable cLast, SRUWeights weights) The SRU cell.

Methods inherited from class org.nd4j.autodiff.samediff.ops.SDOps

f, updateVariableNameAndReference

Methods inherited from class java.lang.Object

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

Constructor Detail

SDRNN

public SDRNN(SameDiff sameDiff)

Method Detail

gru

public GRUCellOutputs gru(@NonNull
                          SDVariable x,
                          @NonNull
                          SDVariable hLast,
                          @NonNull
                          GRUWeights weights)

See gru(String, SDVariable, SDVariable, GRUWeights).

gru

public GRUCellOutputs gru(String baseName,
                          @NonNull
                          SDVariable x,
                          @NonNull
                          SDVariable hLast,
                          @NonNull
                          GRUWeights weights)

The GRU cell. Does a single time step operation.

Parameters:

baseName - The base name for the gru cell

x - Input, with shape [batchSize, inSize]

hLast - Output of the previous cell/time step, with shape [batchSize, numUnits]

weights - The cell's weights.

Returns:

The cell's outputs.

lstmCell

public LSTMCellOutputs lstmCell(@NonNull
                                SDVariable x,
                                @NonNull
                                SDVariable cLast,
                                @NonNull
                                SDVariable yLast,
                                LSTMWeights weights,
                                LSTMConfiguration config)

See lstmCell(String, SDVariable, SDVariable, SDVariable, LSTMWeights, LSTMConfiguration).

lstmCell

public LSTMCellOutputs lstmCell(String baseName,
                                @NonNull
                                SDVariable x,
                                @NonNull
                                SDVariable cLast,
                                @NonNull
                                SDVariable yLast,
                                @NonNull
                                LSTMWeights weights,
                                @NonNull
                                LSTMConfiguration config)

The LSTM cell. Does a single time step operation.

Parameters:

baseName - The base name for the lstm cell

x - Input, with shape [batchSize, inSize]

cLast - Previous cell state, with shape [batchSize, numUnits]

yLast - Previous cell output, with shape [batchSize, numUnits]

weights - The cell's weights.

config - The cell's config.

Returns:

The cell's outputs.

lstmLayer

public LSTMLayerOutputs lstmLayer(@NonNull
                                  SDVariable maxTSLength,
                                  @NonNull
                                  SDVariable x,
                                  @NonNull
                                  SDVariable cLast,
                                  @NonNull
                                  SDVariable yLast,
                                  @NonNull
                                  LSTMWeights weights,
                                  @NonNull
                                  LSTMConfiguration config)

See lstmLayer(String, SDVariable, SDVariable, SDVariable, SDVariable, LSTMWeights, LSTMConfiguration)

lstmLayer

public LSTMLayerOutputs lstmLayer(int maxTSLength,
                                  @NonNull
                                  SDVariable x,
                                  @NonNull
                                  SDVariable cLast,
                                  @NonNull
                                  SDVariable yLast,
                                  @NonNull
                                  LSTMWeights weights,
                                  @NonNull
                                  LSTMConfiguration config)

See lstmLayer(String, SDVariable, SDVariable, SDVariable, SDVariable, LSTMWeights, LSTMConfiguration)

lstmLayer

public LSTMLayerOutputs lstmLayer(String baseName,
                                  int maxTSLength,
                                  @NonNull
                                  SDVariable x,
                                  @NonNull
                                  SDVariable cLast,
                                  @NonNull
                                  SDVariable yLast,
                                  @NonNull
                                  LSTMWeights weights,
                                  @NonNull
                                  LSTMConfiguration config)

See lstmLayer(String, SDVariable, SDVariable, SDVariable, SDVariable, LSTMWeights, LSTMConfiguration)

lstmLayer

public LSTMLayerOutputs lstmLayer(String baseName,
                                  @NonNull
                                  SDVariable maxTSLength,
                                  @NonNull
                                  SDVariable x,
                                  @NonNull
                                  SDVariable cLast,
                                  @NonNull
                                  SDVariable yLast,
                                  @NonNull
                                  LSTMWeights weights,
                                  @NonNull
                                  LSTMConfiguration config)

The LSTM layer. Does multiple time steps. Input shape depends on data format (in config):
TNS -> [timeSteps, batchSize, inSize]
NST -> [batchSize, inSize, timeSteps]
NTS -> [batchSize, timeSteps, inSize]

Parameters:

baseName - The base name for the lstm layer

x - Input, with shape dependent on the data format (in config).

cLast - Previous/initial cell state, with shape [batchSize, numUnits]

yLast - Previous/initial cell output, with shape [batchSize, numUnits]

weights - The layer's weights.

config - The layer's config.

Returns:

The layer's outputs.

sruCell

public SRUCellOutputs sruCell(@NonNull
                              SDVariable x,
                              @NonNull
                              SDVariable cLast,
                              @NonNull
                              SRUWeights weights)

See sruCell(String, SDVariable, SDVariable, SRUWeights).

sruCell

public SRUCellOutputs sruCell(String baseName,
                              @NonNull
                              SDVariable x,
                              @NonNull
                              SDVariable cLast,
                              @NonNull
                              SRUWeights weights)

The SRU cell. Does a single time step operation.

Parameters:

baseName - The base name for the sru cell

x - Input, with shape [batchSize, inSize]

cLast - Previous cell state, with shape [batchSize, inSize]

weights - The cell's weights.

Returns:

The cell's outputs.

sru

public SRULayerOutputs sru(@NonNull
                           SDVariable x,
                           @NonNull
                           SDVariable initialC,
                           @NonNull
                           SRUWeights weights)

See sru(String, SDVariable, SDVariable, SDVariable, SRUWeights)

sru

public SRULayerOutputs sru(String baseName,
                           @NonNull
                           SDVariable x,
                           @NonNull
                           SDVariable initialC,
                           @NonNull
                           SRUWeights weights)

See sru(String, SDVariable, SDVariable, SDVariable, SRUWeights)

sru

public SRULayerOutputs sru(@NonNull
                           SDVariable x,
                           @NonNull
                           SDVariable initialC,
                           SDVariable mask,
                           @NonNull
                           SRUWeights weights)

See sru(String, SDVariable, SDVariable, SDVariable, SRUWeights)

sru

public SRULayerOutputs sru(String baseName,
                           @NonNull
                           SDVariable x,
                           @NonNull
                           SDVariable initialC,
                           SDVariable mask,
                           @NonNull
                           SRUWeights weights)

The SRU layer. Does a single time step operation.

Parameters:

baseName - The base name for the sru layer

x - Input, with shape [batchSize, inSize, timeSeriesLength]

initialC - Initial cell state, with shape [batchSize, inSize]

mask - An optional dropout mask, with shape [batchSize, inSize]

weights - The layer's weights.

Returns:

The layer's outputs.