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]¶

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

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})$ 的张量，用于非批量输入；形状为 $(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()。
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})$ 的张量，用于非批量输入；形状为 $(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})$ 的张量，用于批量输入，包含批次中每个元素的最终隐藏状态。

变量

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) 输入数据的数据类型为 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¶

文档

教程

资源