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)[source][source]¶

对输入序列应用具有 $\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$ 。

# Efficient implementation equivalent to the following with bidirectional=False
def forward(x, hx=None):
    if batch_first:
        x = x.transpose(0, 1)
    seq_len, batch_size, _ = x.size()
    if hx is None:
        hx = torch.zeros(num_layers, batch_size, hidden_size)
    h_t_minus_1 = hx
    h_t = hx
    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

参数

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

输入：input, hx

input: 对于非批次输入，形状为 $(L, H_{in})$ 的张量；当 batch_first=False 时，形状为 $(L, N, H_{in})$ 的张量；当 batch_first=True 时，形状为 $(N, L, H_{in})$ 的张量，包含输入序列的特征。输入也可以是 packed variable length sequence（打包的可变长度序列）。详情请参阅 torch.nn.utils.rnn.pack_padded_sequence() 或 torch.nn.utils.rnn.pack_sequence()。
hx: 对于非批次输入，形状为 $(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}

输出：output, h_n

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

变量

weight_ih_l[k] – 第 k 层的可学习的输入-隐藏权重，当 k = 0 时形状为 (hidden_size, input_size)。否则，形状为 (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}}$ 。

注

对于双向 RNN，前向和后向分别为方向 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)

RNN¶

文档

教程

资源