GRU

class torch.nn.GRU(input_size, hidden_size, num_layers=1, bias=True, batch_first=False, dropout=0.0, bidirectional=False, device=None, dtype=None)

将多层门控循环单元 (GRU) RNN 应用于输入序列。对于输入序列中的每个元素，每一层计算以下函数：

$$\begin{array}{ll} r_t = \sigma(W_{ir} x_t + b_{ir} + W_{hr} h_{(t-1)} + b_{hr}) \\ z_t = \sigma(W_{iz} x_t + b_{iz} + W_{hz} h_{(t-1)} + b_{hz}) \\ n_t = \tanh(W_{in} x_t + b_{in} + r_t \odot (W_{hn} h_{(t-1)}+ b_{hn})) \\ h_t = (1 - z_t) \odot n_t + z_t \odot h_{(t-1)} \end{array}$$

其中 $h_t$ 是时间 t 处的隐藏状态，$x_t$ 是时间 t 处的输入，$h_{(t-1)}$ 是上一时刻 t-1 的层隐藏状态或 0 时刻的初始隐藏状态，而 $r_t$, $z_t$, $n_t$ 分别是重置门、更新门和候选隐藏状态。 $\sigma$ 是 sigmoid 函数，$\odot$ 是 Hadamard 积。

在多层 GRU 中，第 $l$ 层的输入 $x^{(l)}_t$ ($l \ge 2$) 是上一层隐藏状态 $h^{(l-1)}_t$ 乘以 dropout $\delta^{(l-1)}_t$ 其中每个 $\delta^{(l-1)}_t$ 是一个 Bernoulli 随机变量，其值为 $0$ 的概率为 dropout。

参数

• input_size – 输入 x 中预期特征的数量

• hidden_size – 隐藏状态 h 中的特征数量

• num_layers – 循环层数。例如，设置 num_layers=2 将意味着堆叠两个 GRU 来形成一个 堆叠 GRU，第二个 GRU 接收第一个 GRU 的输出并计算最终结果。默认值：1

• bias – 如果为 False，则该层不使用偏置权重 b_ih 和 b_hh。默认值：True

• batch_first – 如果为 True，则输入和输出张量以 (batch, seq, feature) 的形式提供，而不是 (seq, batch, feature)。请注意，这不适用于隐藏状态或单元状态。有关详细信息，请参阅下方的输入/输出部分。默认值：False

• dropout – 如果非零，则在除最后一层外的每个 GRU 层的输出上引入 Dropout 层，dropout 概率等于 dropout。默认值：0

• bidirectional – 如果为 True，则成为双向 GRU。默认值：False

输入：input, h_0

• input: 对于未批量的输入，形状为 $(L, H_{in})$ 的张量；当 batch_first=False 时，形状为 $(L, N, H_{in})$；当 batch_first=True 时，形状为 $(N, L, H_{in})$，包含输入序列的特征。输入也可以是打包的变长序列。有关详细信息，请参阅 torch.nn.utils.rnn.pack_padded_sequence() 或 torch.nn.utils.rnn.pack_sequence()。

• h_0: 形状为 $(D * \text{num\_layers}, H_{out})$ 的张量；当 batch_first=False 时，形状为 $(D * \text{num\_layers}, N, H_{out})$ 的张量，包含输入序列的初始隐藏状态。如果未提供，则默认为零。

其中

$$\begin{array}{rl}{\displaystyle N=}& {\displaystyle \text{batch size}}\\ {\displaystyle L=}& {\displaystyle \text{sequence length}}\\ {\displaystyle D=}& {\displaystyle 2\text{ if bidirectional=True otherwise }1}\\ {\displaystyle H_{in}=}\end{array}$$

input_sizeHout=hidden_size\begin{aligned} N ={} & \text{batch size} \\ L ={} & \text{sequence length} \\ D ={} & 2 \text{ if bidirectional=True otherwise } 1 \\ H_{in} ={} & \text{input\_size} \\ H_{out} ={} & \text{hidden\_size} \end{aligned}

输出：output, h_n

• output: 对于未批量的输入，形状为 $(L, D * H_{out})$ 的张量；当 batch_first=False 时，形状为 $(L, N, D * H_{out})$；当 batch_first=True 时，形状为 $(N, L, D * H_{out})$ 的张量，包含 GRU 最后一层每个 t 的输出特征 (h_t)。如果输入是 torch.nn.utils.rnn.PackedSequence，则输出也将是打包序列。

• h_n: 形状为 $(D * \text{num\_layers}, H_{out})$ 的张量；当 batch_first=False 时，形状为 $(D * \text{num\_layers}, N, H_{out})$ 的张量，包含输入序列的最终隐藏状态。

变量

• weight_ih_l[k] – 第 $\text{k}^{th}$ 层（W_ir|W_iz|W_in）的可学习输入-隐藏权重，对于 k = 0，形状为 (3*hidden_size, input_size)；否则，形状为 (3*hidden_size, num_directions * hidden_size)

• weight_hh_l[k] – 第 $\text{k}^{th}$ 层（W_hr|W_hz|W_hn）的可学习隐藏-隐藏权重，形状为 (3*hidden_size, hidden_size)

• bias_ih_l[k] – 第 $\text{k}^{th}$ 层（b_ir|b_iz|b_in）的可学习输入-隐藏偏置，形状为 (3*hidden_size)

• bias_hh_l[k] – 第 $\text{k}^{th}$ 层（b_hr|b_hz|b_hn）的可学习隐藏-隐藏偏置，形状为 (3*hidden_size)

注意

所有权重和偏置都从 $\mathcal{U}(-\sqrt{k}, \sqrt{k})$ 中进行采样，其中 $k = \frac{1}{\text{hidden\_size}}$

注意

对于双向 GRU，前向和后向分别为方向 0 和 1。例如，当 batch_first=False 时，分割输出层的方式为：output.view(seq_len, batch, num_directions, hidden_size)。

注意

对于未批处理的输入，batch_first 参数被忽略。

注意

新门 $n_t$ 的计算与原始论文和其他框架略有不同。在原始实现中，$r_t$ 和上一隐藏状态 $h_{(t-1)}$ 之间的 Hadamard 积 $(\odot)$ 在与权重矩阵 W 相乘和加上偏置之前进行。

$$\begin{aligned} n_t = \tanh(W_{in} x_t + b_{in} + W_{hn} ( r_t \odot h_{(t-1)} ) + b_{hn}) \end{aligned}$$

这与 PyTorch 实现不同，PyTorch 实现是在 $W_{hn} h_{(t-1)}$之后完成的。

$$\begin{aligned} n_t = \tanh(W_{in} x_t + b_{in} + r_t \odot (W_{hn} h_{(t-1)}+ b_{hn})) \end{aligned}$$

为了效率，此实现方式特意有所不同。

注意

如果满足以下条件：1) 启用了 cudnn，2) 输入数据在 GPU 上 3) 输入数据的 dtype 为 torch.float16 4) 使用 V100 GPU，5) 输入数据不是 PackedSequence 格式，则可以选择持久化算法来提高性能。

示例

>>> rnn = nn.GRU(10, 20, 2)
>>> input = torch.randn(5, 3, 10)
>>> h0 = torch.randn(2, 3, 20)
>>> output, hn = rnn(input, h0)