# tf.contrib.rnn.IntersectionRNNCell

<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#L1716-L1843) |

Intersection Recurrent Neural Network (+RNN) cell.

Inherits From: [`RNNCell`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/nn/rnn_cell/RNNCell)

    tf.contrib.rnn.IntersectionRNNCell(
        num_units, num_in_proj=None, initializer=None, forget_bias=1.0,
        y_activation=tf.nn.relu, reuse=None
    )

Architecture with coupled recurrent gate as well as coupled depth
gate, designed to improve information flow through stacked RNNs. As the
architecture uses depth gating, the dimensionality of the depth
output (y) also should not change through depth (input size == output size).
To achieve this, the first layer of a stacked Intersection RNN projects
the inputs to N (num units) dimensions. Therefore when initializing an
IntersectionRNNCell, one should set `num_in_proj = N` for the first layer
and use default settings for subsequent layers.

This implements the recurrent cell from the paper:

<https://arxiv.org/abs/1611.09913>

Jasmine Collins, Jascha Sohl-Dickstein, and David Sussillo.
"Capacity and Trainability in Recurrent Neural Networks" Proc. ICLR 2017.

The Intersection RNN is built for use in deeply stacked
RNNs so it may not achieve best performance with depth 1.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `num_units` | int, The number of units in the +RNN cell |
| `num_in_proj` | (optional) int, The input dimensionality for the RNN. If creating the first layer of an +RNN, this should be set to `num_units`. Otherwise, this should be set to `None` (default). If `None`, dimensionality of `inputs` should be equal to `num_units`, otherwise ValueError is thrown. |
| `initializer` | (optional) The initializer to use for the weight matrices. |
| `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. |
| `y_activation` | (optional) Activation function of the states passed through depth. Default is 'tf.nn.relu`. </td> </tr><tr> <td>`reuse`</td> <td> (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. |

<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 />