RNN¶

class torch.nn.RNN(input_size, hidden_size, num_layers=1, nonlinearity='tanh', bias=True, batch_first=False, dropout=0.0, bidirectional=False, device=None, dtype=None)[源代码]¶

应用一个具有 $\tanh$ 或 $\text{ReLU}$ 非线性的多层 Elman RNN 到输入序列。对于输入序列中的每个元素，每一层计算以下函数：

h_t = \tanh(x_t W_{ih}^T + b_{ih} + h_{t-1}W_{hh}^T + b_{hh})

其中 $h_t$ 是时间 t 的隐藏状态， $x_t$ 是时间 t 的输入，并且 $h_{(t-1)}$ 是时间 t-1 的前一层的隐藏状态或时间 0 的初始隐藏状态。如果 nonlinearity 是 'relu'，则使用 $\text{ReLU}$ 代替 $\tanh$ 。

# 高效的实现等同于以下内容，其中bidirectional=False
def forward(x, h_0=None):
    if batch_first:
        x = x.transpose(0, 1)
    seq_len, batch_size, _ = x.size()
    if h_0 is None:
        h_0 = torch.zeros(num_layers, batch_size, hidden_size)
    h_t_minus_1 = h_0
    h_t = h_0
    output = []
    for t in range(seq_len):
        for layer in range(num_layers):
            h_t[layer] = torch.tanh(
                x[t] @ weight_ih[layer].T
                + bias_ih[layer]
                + h_t_minus_1[layer] @ weight_hh[layer].T
                + bias_hh[layer]
            )
        output.append(h_t[-1])
        h_t_minus_1 = h_t
    output = torch.stack(output)
    if batch_first:
        output = output.transpose(0, 1)
    return output, h_t

Parameters

input_size – 输入 x 中预期的特征数量
hidden_size – 隐藏状态 h 中的特征数量
num_layers – 循环层的数量。例如，设置 num_layers=2 意味着将两个RNN堆叠在一起形成一个堆叠RNN，第二个RNN接收第一个RNN的输出并计算最终结果。默认值：1
非线性 – 使用的非线性函数。可以是 'tanh' 或 'relu'。默认值：'tanh'
偏置 – 如果 False，则该层不使用偏置权重 b_ih 和 b_hh。默认值：True
batch_first – 如果 True，则输入和输出张量以 (batch, seq, feature) 形式提供，而不是 (seq, batch, feature)。请注意，这不适用于隐藏状态或单元状态。有关详细信息，请参阅下面的输入/输出部分。默认值：False
dropout – 如果非零，则在每个RNN层的输出上引入一个Dropout层，除了最后一层，dropout概率等于 dropout。默认值：0
双向 – 如果 True，则变为双向RNN。默认值：False

Inputs: input, h_0

输入：形状为 $(L, H_{in})$ 的未批量输入张量， $(L, N, H_{in})$ 当 batch_first=False 或 $(N, L, H_{in})$ 当 batch_first=True 包含输入序列的特征。输入也可以是打包的可变长度序列。参见 torch.nn.utils.rnn.pack_padded_sequence() 或 torch.nn.utils.rnn.pack_sequence() 了解更多详情。
h_0: 形状为 $(D * \text{num\_layers}, H_{out})$ 的张量，用于未批处理的输入，或 $(D * \text{num\_layers}, N, H_{out})$ 的张量，包含输入序列批次的初始隐藏状态。如果未提供，则默认为零。

其中：

\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}

Outputs: output, h_n

输出：形状为 $(L, D * H_{out})$ 的张量，用于非批量输入， $(L, N, D * H_{out})$ 当 batch_first=False 或 $(N, L, D * H_{out})$ 当 batch_first=True 包含来自RNN最后一层的输出特征 (h_t)，对于每个 t。如果输入是 torch.nn.utils.rnn.PackedSequence，则输出也将是一个打包序列。
h_n: 形状为 $(D * \text{num\_layers}, H_{out})$ 的张量，用于未批处理的输入或 $(D * \text{num\_layers}, N, H_{out})$ 的张量，包含批处理中每个元素的最终隐藏状态。

Variables

weight_ih_l[k] – 第 k 层的可学习的输入-隐藏权重，形状为 (hidden_size, input_size) 当 k = 0 时。否则，形状为 (hidden_size, num_directions * hidden_size)
weight_hh_l[k] – 第 k 层的可学习的隐藏-隐藏权重，形状为 (hidden_size, hidden_size)
bias_ih_l[k] – 第 k 层的可学习的输入-隐藏偏置，形状为 (hidden_size)
bias_hh_l[k] – 第 k 层的可学习的隐藏-隐藏偏置，形状为 (hidden_size)

注意

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

注意

对于双向RNNs，正向和反向分别是方向0和1。当batch_first=False时，分割输出层的示例： output.view(seq_len, batch, num_directions, hidden_size)。

注意

batch_first 参数在未批处理的输入中被忽略。

警告

在某些版本的 cuDNN 和 CUDA 上，RNN 函数存在已知的非确定性问题。您可以通过设置以下环境变量来强制执行确定性行为：

在CUDA 10.1上，设置环境变量 CUDA_LAUNCH_BLOCKING=1。这可能会影响性能。

在 CUDA 10.2 或更高版本上，设置环境变量（注意前导冒号符号） CUBLAS_WORKSPACE_CONFIG=:16:8 或 CUBLAS_WORKSPACE_CONFIG=:4096:2。

请参阅cuDNN 8 发布说明以获取更多信息。

注意

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

示例：

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