Welcome to our Support Center

LSTM

Description

Setup and add the lstm layer into the model during the definition graph step. Type : polymorphic.

 

Input parameters

 

Graph in : model architecture.

ย parameters : layer parameters.

ย units : integer, dimensionality of the output space.
ย activation :ย enum, activation function to use.
Default value โ€œtanhโ€.
output_activation : enum, activation function to use.
Default value “tanh”.
ย recurrent_activation :ย enum, activation function to use for the recurrent step.
Default value โ€œsigmoidโ€.
ย use_bias? :ย boolean, whether the layer uses a bias vector.
Default value โ€œTrueโ€.
input_weight_initializer :ย enum, initializer for the kernel weights matrix, used for the linear transformation of the inputs.
Default value โ€œglorot_uniformโ€.
ย hidden_weight_initializer :ย enum, initializer for the recurrent_kernel weights matrix, used for the linear transformation of the recurrent state.
Default value โ€œorthogonalโ€.
ย bias_initializerย :ย enum, initializer for the bias vector.
Default value โ€œzerosโ€.
unit_forget_bias? : boolean, if True, add 1 to the bias of the forget gate at initialization.
Default value “True”.
ย dropoutย :ย float, fraction of the units to drop for the linear transformation of the inputs.
Default value โ€œ0.0โ€.
ย recurrent_dropout :ย float, fraction of the units to drop for the linear transformation of the recurrent state.
Default value โ€œ0.0โ€.
ย return_sequences?ย :ย boolean, whether to return the last output in the output sequence, or the full sequence.
Default value โ€œFalseโ€.
ย stateful?ย :ย boolean, if True, the last state for each sample at index i in a batch will be used as initial state for the sample of index i in the following batch.
Default value โ€œFalseโ€.
ย optimizer :

ย algorithm :ย enum, (name of optimizer) for optimizer instance.
Default value โ€œadamโ€.
ย learning_rate :ย float, define the learning rate to use.
Default value โ€œ0.001โ€.
ย beta_1 :ย float, define the exponential decay rate for the 1st moment estimates.
Default value โ€œ0.9โ€.
ย beta_2 :ย float, define the exponential decay rate for the 2nd moment estimates.
Default value โ€œ0.999โ€.

ย training?ย :ย boolean, whether the layer is in training mode (can store data for backward).
Default value โ€œTrueโ€.
ย store?ย :ย boolean, whether the layer stores the last iteration gradient (accessible via the โ€œget_gradientsโ€ function).
Default value โ€œFalseโ€.
ย update?ย :ย boolean, whether the layerโ€™s variables should be updated during backward. Equivalent to freeze the layer.
Default value โ€œTrueโ€.
ย lda_coeff :ย float, defines the coefficient by which the loss derivative will be multiplied before being sent to the previous layer (since during the backward run we go backwards).
Default value โ€œ1โ€.

 

ย in/out paramย :

ย input_shapeย :ย integer array, shape (not including the batch axis). NB : To be used only if it is the first layer of the model.
ย output_behaviorย :ย enum, setup if the layer is an output layer.
Default โ€œNot Outputโ€โ€‹โ€‹.

name (optional) : string, name of the layer.

 

Output parameters

 

Graph out : model architecture.

Dimension

Input shape

A 3D tensor, with shape : (batch, timesteps, features).

 

Output shape

3D tensor with shape :

  • If โ€œreturn_sequencesโ€ = True : (batch_size, timesteps, units).
  • If โ€œreturn_sequencesโ€ = False ย : (batch_size, units).

Example

All these exemples are snippets PNG, you can drop these Snippet onto the block diagram and get the depicted code added to your VI (Do not forget to install HAIBAL library to run it).

LSTM layer

1 โ€“ Generate a set of data

We generate an array of data of type single and shape [batch_size = 10, timesteps = 7, features = 5].

2 โ€“ Define graph

First, we define the first layer of the graph which is an Input layer (explicit input layer method). This layer is setup as an input array shaped [timesteps = 7, features = 5].
Then we add to the graph the LSTM layer.

3 โ€“ Run graph

We call the forward method and retrieve the result with the โ€œPrediction 2Dโ€ method.
This method returns two variables, the first one is the layer information (cluster composed of the layer name, the graph index and the shape of the output layer) and the second one is the prediction with a shape of [batch_size, units].
The output dimension depends on the parameters โ€œreturn-sequencesโ€ refer to the chapter โ€œDimensionโ€ of this documentation.

 

LSTM layer, batch and dimension

1 โ€“ Generate a set of data

We generate an array of data of type single and shape [number of batch = 9, batch_size = 10, timesteps = 7, features = 5].

2 โ€“ Define graph

First, we define the first layer of the graph which is an Input layer (explicit input layer method). This layer is setup as an input array shaped [timesteps = 7, features = 5].
Then we add to the graph the LSTM layer.

3 โ€“ Run graph

We call the forward method and retrieve the result with the โ€œPrediction 2Dโ€ method.
This method returns two variables, the first one is the layer information (cluster composed of the layer name, the graph index and the shape of the output layer) and the second one is the prediction with a shape of [batch_size, units].
The output dimension depends on the parameters โ€œreturn-sequencesโ€ refer to the chapter โ€œDimensionโ€ of this documentation.

 

Table of Contents