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)[来源][来源] ¬

将多层 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 中期望的特征数量
隐藏层大小 – 隐藏状态 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
双向 – 如果 True ，则变为双向 RNN。默认： False

输入：输入，hx

输入：形状为 $(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() 。
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

输出：对于未批处理的输入，形状为 $(L, D * H_{out})$ 的张量；当 batch_first=False 时，形状为 $(L, N, D * H_{out})$ ；当 batch_first=True 时，形状为 $(N, L, D * H_{out})$ ，包含 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 时，形状为(隐藏大小, 输入大小)。否则，形状为(隐藏大小, num_directions * 隐藏大小)
weight_hh_l[k] – 第 k 层的可学习隐藏-隐藏权重，形状为(隐藏大小, 隐藏大小)
bias_ih_l[k] – 第 k 层的可学习输入-隐藏偏置，形状为(隐藏大小)
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 ¬

文档

教程

资源