# tf.compat.v1.keras.layers.LSTMCell

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/keras-team/keras/tree/v2.13.1/keras/layers/rnn/lstm_v1.py#L32-L123) |

Cell class for the LSTM layer.

Inherits From: [`LSTMCell`](https://www.tensorflow.org/versions/r2.13/api_docs/python/tf/keras/layers/LSTMCell), [`Layer`](https://www.tensorflow.org/versions/r2.13/api_docs/python/tf/keras/layers/Layer), [`Module`](https://www.tensorflow.org/versions/r2.13/api_docs/python/tf/Module)

    tf.compat.v1.keras.layers.LSTMCell(
        units,
        activation='tanh',
        recurrent_activation='hard_sigmoid',
        use_bias=True,
        kernel_initializer='glorot_uniform',
        recurrent_initializer='orthogonal',
        bias_initializer='zeros',
        unit_forget_bias=True,
        kernel_regularizer=None,
        recurrent_regularizer=None,
        bias_regularizer=None,
        kernel_constraint=None,
        recurrent_constraint=None,
        bias_constraint=None,
        dropout=0.0,
        recurrent_dropout=0.0,
        **kwargs
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `units` | Positive integer, dimensionality of the output space. |
| `activation` | Activation function to use. Default: hyperbolic tangent (`tanh`). If you pass `None`, no activation is applied (ie. "linear" activation: `a(x) = x`). |
| `recurrent_activation` | Activation function to use for the recurrent step. Default: hard sigmoid (`hard_sigmoid`). If you pass `None`, no activation is applied (ie. "linear" activation: `a(x) = x`). |
| `use_bias` | Boolean, whether the layer uses a bias vector. |
| `kernel_initializer` | Initializer for the `kernel` weights matrix, used for the linear transformation of the inputs. |
| `recurrent_initializer` | Initializer for the `recurrent_kernel` weights matrix, used for the linear transformation of the recurrent state. |
| `bias_initializer` | Initializer for the bias vector. |
| `unit_forget_bias` | Boolean. If True, add 1 to the bias of the forget gate at initialization. Setting it to true will also force `bias_initializer="zeros"`. This is recommended in [Jozefowicz et al., 2015](http://www.jmlr.org/proceedings/papers/v37/jozefowicz15.pdf) |
| `kernel_regularizer` | Regularizer function applied to the `kernel` weights matrix. |
| `recurrent_regularizer` | Regularizer function applied to the `recurrent_kernel` weights matrix. |
| `bias_regularizer` | Regularizer function applied to the bias vector. |
| `kernel_constraint` | Constraint function applied to the `kernel` weights matrix. |
| `recurrent_constraint` | Constraint function applied to the `recurrent_kernel` weights matrix. |
| `bias_constraint` | Constraint function applied to the bias vector. |
| `dropout` | Float between 0 and 1. Fraction of the units to drop for the linear transformation of the inputs. |
| `recurrent_dropout` | Float between 0 and 1. Fraction of the units to drop for the linear transformation of the recurrent state. |

<br />

<br />

<br />

<br />

| ## Call arguments ||
|---|---|
| `inputs` | A 2D tensor. |
| `states` | List of state tensors corresponding to the previous timestep. |
| `training` | Python boolean indicating whether the layer should behave in training mode or in inference mode. Only relevant when `dropout` or `recurrent_dropout` is used. |

<br />

## Methods

### `get_dropout_mask_for_cell`

[View source](https://github.com/keras-team/keras/tree/v2.13.1/keras/layers/rnn/dropout_rnn_cell_mixin.py#L110-L129)

    get_dropout_mask_for_cell(
        inputs, training, count=1
    )

Get the dropout mask for RNN cell's input.

It will create mask based on context if there isn't any existing cached
mask. If a new mask is generated, it will update the cache in the cell.

<br />

<br />

<br />

| Args ||
|---|---|
| `inputs` | The input tensor whose shape will be used to generate dropout mask. |
| `training` | Boolean tensor, whether its in training mode, dropout will be ignored in non-training mode. |
| `count` | Int, how many dropout mask will be generated. It is useful for cell that has internal weights fused together. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| List of mask tensor, generated or cached mask based on context. ||

<br />

### `get_initial_state`

[View source](https://github.com/keras-team/keras/tree/v2.13.1/keras/layers/rnn/lstm.py#L374-L379)

    get_initial_state(
        inputs=None, batch_size=None, dtype=None
    )

### `get_recurrent_dropout_mask_for_cell`

[View source](https://github.com/keras-team/keras/tree/v2.13.1/keras/layers/rnn/dropout_rnn_cell_mixin.py#L131-L150)

    get_recurrent_dropout_mask_for_cell(
        inputs, training, count=1
    )

Get the recurrent dropout mask for RNN cell.

It will create mask based on context if there isn't any existing cached
mask. If a new mask is generated, it will update the cache in the cell.

<br />

<br />

<br />

| Args ||
|---|---|
| `inputs` | The input tensor whose shape will be used to generate dropout mask. |
| `training` | Boolean tensor, whether its in training mode, dropout will be ignored in non-training mode. |
| `count` | Int, how many dropout mask will be generated. It is useful for cell that has internal weights fused together. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| List of mask tensor, generated or cached mask based on context. ||

<br />

### `reset_dropout_mask`

[View source](https://github.com/keras-team/keras/tree/v2.13.1/keras/layers/rnn/dropout_rnn_cell_mixin.py#L70-L79)

    reset_dropout_mask()

Reset the cached dropout masks if any.

This is important for the RNN layer to invoke this in it `call()` method
so that the cached mask is cleared before calling the `cell.call()`. The
mask should be cached across the timestep within the same batch, but
shouldn't be cached between batches. Otherwise it will introduce
unreasonable bias against certain index of data within the batch.

### `reset_recurrent_dropout_mask`

[View source](https://github.com/keras-team/keras/tree/v2.13.1/keras/layers/rnn/dropout_rnn_cell_mixin.py#L81-L90)

    reset_recurrent_dropout_mask()

Reset the cached recurrent dropout masks if any.

This is important for the RNN layer to invoke this in it call() method
so that the cached mask is cleared before calling the cell.call(). The
mask should be cached across the timestep within the same batch, but
shouldn't be cached between batches. Otherwise it will introduce
unreasonable bias against certain index of data within the batch.