# tf.contrib.rnn.PhasedLSTMCell

<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#L1915-L2064) |

Phased LSTM recurrent network cell.

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

    tf.contrib.rnn.PhasedLSTMCell(
        num_units, use_peepholes=False, leak=0.001, ratio_on=0.1,
        trainable_ratio_on=True, period_init_min=1.0, period_init_max=1000.0, reuse=None
    )

<https://arxiv.org/pdf/1610.09513v1.pdf>

<br />

<br />

<br />

| ## Args ||
|---|---|
| `num_units` | int, The number of units in the Phased LSTM cell. |
| `use_peepholes` | bool, set True to enable peephole connections. |
| `leak` | float or scalar float Tensor with value in \[0, 1\]. Leak applied during training. |
| `ratio_on` | float or scalar float Tensor with value in \[0, 1\]. Ratio of the period during which the gates are open. |
| `trainable_ratio_on` | bool, weather ratio_on is trainable. |
| `period_init_min` | float or scalar float Tensor. With value \> 0. Minimum value of the initialized period. The period values are initialized by drawing from the distribution: e\^U(log(period_init_min), log(period_init_max)) Where U(.,.) is the uniform distribution. |
| `period_init_max` | float or scalar float Tensor. With value \> period_init_min. Maximum value of the initialized period. |
| `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. |

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