GRU

class torch.ao.nn.quantized.dynamic.GRU(*args, **kwargs)

将多层门控循环单元 (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$ 层 ($l >= 2$) 的输入 $x^{(l)}_t$ 是前一层的隐藏状态 $h^{(l-1)}_t$ 乘以 dropout $\delta^{(l-1)}_t$，其中每个 $\delta^{(l-1)}_t$ 都是一个伯努利随机变量，其为 $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)。默认值：False

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

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

输入：input, h_0

• input 形状为 (seq_len, batch, input_size)：包含输入序列特征的张量。输入也可以是打包的变长序列。详情请参见 torch.nn.utils.rnn.pack_padded_sequence()。

• h_0 形状为 (num_layers * num_directions, batch, hidden_size)：包含批次中每个元素的初始隐藏状态的张量。如果未提供，默认为零。如果 RNN 是双向的，则 num_directions 应为 2，否则应为 1。

输出：output, h_n

• output 形状为 (seq_len, batch, num_directions * hidden_size)：包含 GRU 最后一层在每个时间步 t 的输出特征 h_t 的张量。如果输入是 torch.nn.utils.rnn.PackedSequence，则输出也将是打包序列。对于未打包的情况，可以使用 output.view(seq_len, batch, num_directions, hidden_size) 分离方向，其中前向是方向 0，后向是方向 1。

  类似地，在打包的情况下也可以分离方向。

• h_n 形状为 (num_layers * num_directions, batch, hidden_size)：包含时间步 t = seq_len 时的隐藏状态的张量。

  类似于 output，可以使用 h_n.view(num_layers, num_directions, batch, hidden_size) 分离层。

形状

• 输入 1: $(L, N, H_{in})$ 包含输入特征的张量，其中 $H_{in}=\text{input\_size}$ 且 L 表示序列长度。

• 输入 2: $(S, N, H_{out})$ 包含批次中每个元素的初始隐藏状态的张量。$H_{out}=\text{hidden\_size}$ 如果未提供，默认为零。其中 $S=\text{num\_layers} * \text{num\_directions}$。如果 RNN 是双向的，则 num_directions 应为 2，否则应为 1。

• 输出 1: $(L, N, H_{all})$ 其中 $H_{all}=\text{num\_directions} * \text{hidden\_size}$

• 输出 2: $(S, 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}}$

注意

新门 $n_t$ 的计算与原始论文及其他框架略有不同。在原始实现中，$r_t$ 与前一隐藏状态 $h_{(t-1)}$ 之间的哈达玛积 $(\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 实现形成对比，后者的计算是在 $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) 输入数据的数据类型为 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)