# tf.contrib.rnn.BidirectionalGridLSTMCell

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/rnn/python/ops/rnn_cell.py#L966-L1106) |

Bidirectional GridLstm cell.

Inherits From: [`GridLSTMCell`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/contrib/rnn/GridLSTMCell)

    tf.contrib.rnn.BidirectionalGridLSTMCell(
        num_units, use_peepholes=False, share_time_frequency_weights=False,
        cell_clip=None, initializer=None, num_unit_shards=1, forget_bias=1.0,
        feature_size=None, frequency_skip=None, num_frequency_blocks=None,
        start_freqindex_list=None, end_freqindex_list=None,
        couple_input_forget_gates=False, backward_slice_offset=0, reuse=None
    )

The bidirection connection is only used in the frequency direction, which
hence doesn't affect the time direction's real-time processing that is
required for online recognition systems.
The current implementation uses different weights for the two directions.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `num_units` | int, The number of units in the LSTM cell |
| `use_peepholes` | (optional) bool, default False. Set True to enable diagonal/peephole connections. |
| `share_time_frequency_weights` | (optional) bool, default False. Set True to enable shared cell weights between time and frequency LSTMs. |
| `cell_clip` | (optional) A float value, default None, if provided the cell state is clipped by this value prior to the cell output activation. |
| `initializer` | (optional) The initializer to use for the weight and projection matrices, default None. |
| `num_unit_shards` | (optional) int, default 1, How to split the weight matrix. If \> 1, the weight matrix is stored across num_unit_shards. |
| `forget_bias` | (optional) float, default 1.0, The initial bias of the forget gates, used to reduce the scale of forgetting at the beginning of the training. |
| `feature_size` | (optional) int, default None, The size of the input feature the LSTM spans over. |
| `frequency_skip` | (optional) int, default None, The amount the LSTM filter is shifted by in frequency. |
| `num_frequency_blocks` | \[required\] A list of frequency blocks needed to cover the whole input feature splitting defined by start_freqindex_list and end_freqindex_list. |
| `start_freqindex_list` | \[optional\], list of ints, default None, The starting frequency index for each frequency block. |
| `end_freqindex_list` | \[optional\], list of ints, default None. The ending frequency index for each frequency block. |
| `couple_input_forget_gates` | (optional) bool, default False, Whether to couple the input and forget gates, i.e. f_gate = 1.0 - i_gate, to reduce model parameters and computation cost. |
| `backward_slice_offset` | (optional) int32, default 0, the starting offset to slice the feature for backward processing. |
| `reuse` | (optional) Python boolean describing whether to reuse variables in an existing scope. If not `True`, and the existing scope already has the given variables, an error is raised. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `graph` | DEPRECATED FUNCTION <br /> > [!WARNING] > **Warning:** THIS FUNCTION IS DEPRECATED. It will be removed in a future version. Instructions for updating: Stop using this property because tf.layers layers no longer track their graph. |
| `output_size` | Integer or TensorShape: size of outputs produced by this cell. |
| `scope_name` | <br /> |
| `state_size` | size(s) of state(s) used by this cell. <br /> It can be represented by an Integer, a TensorShape or a tuple of Integers or TensorShapes. |
| `state_tuple_type` | <br /> <br /> |

<br />

## Methods

### `get_initial_state`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/ops/rnn_cell_impl.py#L281-L309)

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

### `zero_state`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/ops/rnn_cell_impl.py#L311-L340)

    zero_state(
        batch_size, dtype
    )

Return zero-filled state tensor(s).

<br />

<br />

<br />

| Args ||
|---|---|
| `batch_size` | int, float, or unit Tensor representing the batch size. |
| `dtype` | the data type to use for the state. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| If `state_size` is an int or TensorShape, then the return value is a `N-D` tensor of shape `[batch_size, state_size]` filled with zeros. <br /> If `state_size` is a nested list or tuple, then the return value is a nested list or tuple (of the same structure) of `2-D` tensors with the shapes `[batch_size, s]` for each s in `state_size`. ||

<br />