LSTM

class torch.nn.LSTM(input_size, hidden_size, num_layers=1, bias=True, batch_first=False, dropout=0.0, bidirectional=False, proj_size=0, device=None, dtype=None)

将多层长短期记忆（LSTM）循环神经网络（RNN）应用于输入序列。对于输入序列中的每个元素，每一层计算以下函数：

$$\begin{array}{ll} \\ i_t = \sigma(W_{ii} x_t + b_{ii} + W_{hi} h_{t-1} + b_{hi}) \\ f_t = \sigma(W_{if} x_t + b_{if} + W_{hf} h_{t-1} + b_{hf}) \\ g_t = \tanh(W_{ig} x_t + b_{ig} + W_{hg} h_{t-1} + b_{hg}) \\ o_t = \sigma(W_{io} x_t + b_{io} + W_{ho} h_{t-1} + b_{ho}) \\ c_t = f_t \odot c_{t-1} + i_t \odot g_t \\ h_t = o_t \odot \tanh(c_t) \\ \end{array}$$

其中 $h_t$ 是时刻 t 的隐藏状态，$c_t$ 是时刻 t 的单元状态，$x_t$ 是时刻 t 的输入，$h_{t-1}$ 是该层在时刻 t-1 的隐藏状态，或者是在时刻 0 的初始隐藏状态，而 $i_t$、$f_t$、$g_t$、$o_t$ 分别是输入门、遗忘门、单元门和输出门。$\sigma$ 是 sigmoid 函数，而 $\odot$ 是 Hadamard 积。

在多层 LSTM 中，第 $l$ 层 ($l \ge 2$) 的输入 $x^{(l)}_t$ 是前一层的隐藏状态 $h^{(l-1)}_t$ 乘以 dropout $\delta^{(l-1)}_t$，其中每个 $\delta^{(l-1)}_t$ 都是一个 Bernoulli 随机变量，以概率 dropout 为 $0$。

如果指定了 proj_size > 0，则将使用带有投影的 LSTM。这将按如下方式改变 LSTM 单元。首先，$h_t$ 的维度将从 hidden_size 变为 proj_size ($W_{hi}$ 的维度也将相应改变)。其次，每层的输出隐藏状态将乘以一个可学习的投影矩阵：$h_t = W_{hr}h_t$。请注意，因此 LSTM 网络的输出形状也会不同。有关所有变量的精确维度，请参阅下面的输入/输出部分。更多详细信息请参阅 https://arxiv.org/abs/1402.1128。

参数

• input_size – 输入 x 中预期的特征数

• hidden_size – 隐藏状态 h 中的特征数

• num_layers – 循环层的数量。例如，设置 num_layers=2 意味着将两个 LSTM 堆叠在一起形成一个 堆叠式 LSTM，其中第二个 LSTM 接收第一个 LSTM 的输出并计算最终结果。默认值：1

• bias – 如果为 False，则该层不使用偏置权重 b_ih 和 b_hh。默认值：True

• batch_first – 如果为 True，则输入和输出张量以 (batch, seq, feature) 的形状提供，而不是 (seq, batch, feature)。注意，这不适用于隐藏状态或单元状态。详情请参阅下面的输入/输出部分。默认值：False

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

• bidirectional – 如果为 True，则变为双向 LSTM。默认值：False

• proj_size – 如果 > 0，则将使用具有相应大小投影的 LSTM。默认值：0

输入: input, (h_0, c_0)

• input: 对于非批量输入，形状为 $(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()。

• h_0: 对于非批量输入，形状为 $(D * \text{num\_layers}, H_{out})$ 的张量，或形状为 $(D * \text{num\_layers}, N, H_{out})$ 的张量，包含输入序列中每个元素的初始隐藏状态。如果未提供 (h_0, c_0)，则默认为零张量。

• c_0: 对于非批量输入，形状为 $(D * \text{num\_layers}, H_{cell})$ 的张量，或形状为 $(D * \text{num\_layers}, N, H_{cell})$ 的张量，包含输入序列中每个元素的初始单元状态。如果未提供 (h_0, c_0)，则默认为零张量。

其中

$$\begin{aligned} N ={} & \text{批量大小} \\ L ={} & \text{序列长度} \\ D ={} & \text{如果 bidirectional=True 则为 } 2 \text{ 否则为 } 1 \\ H_{in} ={} & \text{input\_size} \\ H_{cell} ={} & \text{hidden\_size} \\ H_{out} ={} & \text{如果 proj\_size > 0 则为 proj\_size 否则为 hidden\_size} \\ \end{aligned}$$

输出: output, (h_n, c_n)

• output: 形状为 $(L, D * H_{out})$ 的 tensor（针对未批处理输入），在 batch_first=False 时形状为 $(L, N, D * H_{out})$ 或在 batch_first=True 时形状为 $(N, L, D * H_{out})$，包含 LSTM 最后一层在每个时间步 t 的输出特征 (h_t)。如果输入是 torch.nn.utils.rnn.PackedSequence，则输出也将是 packed sequence。当 bidirectional=True 时，output 将包含序列中每个时间步的正向和反向隐藏状态的拼接。

• h_n: 形状为 $(D * \text{num\_layers}, H_{out})$ 的 tensor（针对未批处理输入）或形状为 $(D * \text{num\_layers}, N, H_{out})$，包含序列中每个元素的最终隐藏状态。当 bidirectional=True 时，h_n 将分别包含最终正向和反向隐藏状态的拼接。

• c_n: 形状为 $(D * \text{num\_layers}, H_{cell})$ 的 tensor（针对未批处理输入）或形状为 $(D * \text{num\_layers}, N, H_{cell})$，包含序列中每个元素的最终 cell 状态。当 bidirectional=True 时，c_n 将分别包含最终正向和反向 cell 状态的拼接。

变量

• weight_ih_l[k] – 第 $\text{k}^{th}$ 层的可学习输入-隐藏权重 (W_ii|W_if|W_ig|W_io)，对于 k = 0，其形状为 (4*hidden_size, input_size)。否则，形状为 (4*hidden_size, num_directions * hidden_size)。如果指定了 proj_size > 0，则对于 k > 0，形状将为 (4*hidden_size, num_directions * proj_size)

• weight_hh_l[k] – 第 $\text{k}^{th}$ 层的可学习隐藏-隐藏权重 (W_hi|W_hf|W_hg|W_ho)，形状为 (4*hidden_size, hidden_size)。如果指定了 proj_size > 0，则形状将为 (4*hidden_size, proj_size)。

• bias_ih_l[k] – 第 $\text{k}^{th}$ 层的可学习输入-隐藏偏置 (b_ii|b_if|b_ig|b_io)，形状为 (4*hidden_size)

• bias_hh_l[k] – 第 $\text{k}^{th}$ 层的可学习隐藏-隐藏偏置 (b_hi|b_hf|b_hg|b_ho)，形状为 (4*hidden_size)

• weight_hr_l[k] – 第 $\text{k}^{th}$ 层的可学习投影权重，形状为 (proj_size, hidden_size)。仅在指定了 proj_size > 0 时存在。

• weight_ih_l[k]_reverse – 反向的 weight_ih_l[k] 的对应项。仅在 bidirectional=True 时存在。

• weight_hh_l[k]_reverse – 反向的 weight_hh_l[k] 的对应项。仅在 bidirectional=True 时存在。

• bias_ih_l[k]_reverse – 反向的 bias_ih_l[k] 的对应项。仅在 bidirectional=True 时存在。

• bias_hh_l[k]_reverse – 反向的 bias_hh_l[k] 的对应项。仅在 bidirectional=True 时存在。

• weight_hr_l[k]_reverse – 反向的 weight_hr_l[k] 的对应项。仅在 bidirectional=True 和指定了 proj_size > 0 时存在。

注意

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

注意

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

注意

对于双向 LSTM，h_n 与 output 的最后一个元素不等价；前者包含最终的正向和反向隐藏状态，而后者包含最终的正向隐藏状态和初始的反向隐藏状态。

注意

对于未批处理输入，batch_first 参数将被忽略。

注意

proj_size 应小于 hidden_size。

警告

在某些版本的 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.LSTM(10, 20, 2)
>>> input = torch.randn(5, 3, 10)
>>> h0 = torch.randn(2, 3, 20)
>>> c0 = torch.randn(2, 3, 20)
>>> output, (hn, cn) = rnn(input, (h0, c0))