.. _cn_api_paddle_nn_SimpleRNN:

SimpleRNN
-------------------------------

.. py:class:: paddle.nn.SimpleRNN(input_size, hidden_size, num_layers=1, activation="tanh", direction="forward", dropout=0., time_major=False, weight_ih_attr=None, weight_hh_attr=None, bias_ih_attr=None, bias_hh_attr=None)



**简单循环神经网络**

简单循环神经网络（SimpleRNN），根据输出序列和给定的初始状态计算返回输出序列和最终状态。在该网络中的每一层对应输入的 step，每个 step 根据当前时刻输入 x（t）和上一时刻状态 h（t-1）计算当前时刻输出 y（t）并更新状态 h（t）。

状态更新公式如下：

..  math::

        h_{t} & = \mathrm{tanh}(W_{ih}x_{t} + b_{ih} + W_{hh}h_{t-1} + b_{hh})

        y_{t} & = h_{t}

参数
::::::::::::

    - **input_size** (int) - 输入 :math:`x` 的大小。
    - **hidden_size** (int) - 隐藏状态 :math:`h` 大小。
    - **num_layers** (int，可选) - 循环网络的层数。例如，将层数设为 2，会将两层 GRU 网络堆叠在一起，第二层的输入来自第一层的输出。默认为 1。
    - **direction** (str，可选) - 网络迭代方向，可设置为 forward 或 bidirect（或 bidirectional）。forward 指从序列开始到序列结束的单向 GRU 网络方向，bidirectional 指从序列开始到序列结束，又从序列结束到开始的双向 GRU 网络方向。默认为 forward。
    - **time_major** (bool，可选) - 指定 input 的第一个维度是否是 time steps。如果 time_major 为 True，则 Tensor 的形状为[time_steps,batch_size,input_size]，否则为[batch_size,time_steps,input_size]。`time_steps` 指输入序列的长度。默认为 False。
    - **dropout** (float，可选) - dropout 概率，指的是出第一层外每层输入时的 dropout 概率。范围为[0, 1]。默认为 0。
    - **activation** (str，可选) - 网络中每个单元的激活函数。可以是 tanh 或 relu。默认为 tanh。
    - **weight_ih_attr** (ParamAttr，可选) - weight_ih 的参数。默认为 None。
    - **weight_hh_attr** (ParamAttr，可选) - weight_hh 的参数。默认为 None。
    - **bias_ih_attr** (ParamAttr，可选) - bias_ih 的参数。默认为 None。
    - **bias_hh_attr** (ParamAttr，可选) - bias_hh 的参数。默认为 None。

输入
::::::::::::

    - **inputs** (Tensor) - 网络输入。如果 time_major 为 False，则 Tensor 的形状为[batch_size,time_steps,input_size]，如果 time_major 为 True，则 Tensor 的形状为[time_steps,batch_size,input_size]。  `time_steps` 指输入序列的长度。
    - **initial_states** (Tensor，可选) - 网络的初始状态，形状为[num_layers * num_directions, batch_size, hidden_size]。如果没有给出则会以全零初始化。
    - **sequence_length** (Tensor，可选) - 指定输入序列的实际长度，形状为[batch_size]，数据类型为 int64 或 int32。在输入序列中所有 time step 不小于 sequence_length 的元素都会被当作填充元素处理（状态不再更新）。

输出
::::::::::::

    - **outputs** (Tensor) - 输出，由前向和后向 cell 的输出拼接得到。如果 time_major 为 False，则 Tensor 的形状为[batch_size,time_steps,num_directions * hidden_size]，如果 time_major 为 True，则 Tensor 的形状为[time_steps,batch_size,num_directions * hidden_size]，当 direction 设置为 bidirectional 时，num_directions 等于 2，否则等于 1。 `time_steps` 指输出序列的长度。
    - **final_states** (Tensor) - 最终状态。形状为[num_layers * num_directions, batch_size, hidden_size]，当 direction 设置为 bidirectional 时，num_directions 等于 2，返回值的前向和后向的状态的索引是 0，2，4，6..。和 1，3，5，7...，否则等于 1。

变量
::::::::::::

        - **weight_ih_l[k]** (Parameter) - 第 k 层输入层到隐藏层变换矩阵的权重，如果 `k = 0`，形状为 `[hidden_size, input_size]`。否则，形状为 `[hidden_size, num_directions * hidden_size]` 。
        - **weight_hh_l[k]** (Parameter) - 第 k 层隐藏层到隐藏层变换矩阵的权重，形状为 `[hidden_size, hidden_size]` 。
        - **bias_ih_l[k]** (Parameter) -  第 k 层输入层到隐藏层的变换矩阵的偏置，形状为 `[hidden_size]` 。
        - **bias_hh_l[k]** (Parameter) - 第 k 层隐藏层到隐藏层的变换矩阵的偏置，形状为 `[hidden_size]` 。

代码示例
::::::::::::

COPY-FROM: paddle.nn.SimpleRNN
