LSTM¶
- class torchrl.modules.LSTM(input_size: int, hidden_size: int, num_layers: int = 1, batch_first: bool = True, bias: bool = True, dropout: float = 0.0, bidirectional: float = False, proj_size: int = 0, device=None, dtype=None)[源]¶
一個用於執行多層 LSTM 多步操作的 PyTorch 模組。該模組的行為與
torch.nn.LSTM完全相同，但此實現僅用 Python 編寫。注意
此類在不依賴 CuDNN 的情況下實現，這使其與
torch.vmap()和torch.compile()相容。示例
>>> import torch >>> from torchrl.modules.tensordict_module.rnn import LSTM
>>> device = torch.device("cuda") if torch.cuda.device_count() else torch.device("cpu") >>> B = 2 >>> T = 4 >>> N_IN = 10 >>> N_OUT = 20 >>> N_LAYERS = 2 >>> V = 4 # vector size >>> lstm = LSTM( ... input_size=N_IN, ... hidden_size=N_OUT, ... device=device, ... num_layers=N_LAYERS, ... )
# 單次呼叫 >>> x = torch.randn(B, T, N_IN, device=device) >>> h0 = torch.zeros(N_LAYERS, B, N_OUT, device=device) >>> c0 = torch.zeros(N_LAYERS, B, N_OUT, device=device) >>> with torch.no_grad(): … h1, c1 = lstm(x, (h0, c0))
# 向量化呼叫 - nn.LSTM 不支援 >>> def call_lstm(x, h, c): … h_out, c_out = lstm(x, (h, c)) … return h_out, c_out >>> batched_call = torch.vmap(call_lstm) >>> x = torch.randn(V, B, T, 10, device=device) >>> h0 = torch.zeros(V, N_LAYERS, B, N_OUT, device=device) >>> c0 = torch.zeros(V, N_LAYERS, B, N_OUT, device=device) >>> with torch.no_grad(): … h1, c1 = batched_call(x, h0, c0)
__init__(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{split}\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}\end{split}\]其中 \(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\) 是一個伯努利隨機變數，其機率為
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 的輸出並計算最終結果。預設為：1bias – 如果為
False，則該層不使用偏置權重 b_ih 和 b_hh。預設值：Truebatch_first – 如果為
True，則輸入和輸出張量以 (batch, seq, feature) 的形式提供，而不是 (seq, batch, feature)。請注意，這不適用於隱藏狀態或單元狀態。有關詳細資訊，請參閱下方的輸入/輸出部分。預設值：Falsedropout – 如果非零，則在除最後一層外的每個 LSTM 層的輸出上引入“Dropout”層，其 dropout 機率等於
dropout。預設為：0bidirectional – 如果為
True，則變為雙向 LSTM。預設為：Falseproj_size – 如果
> 0，則使用具有相應大小的投影的 LSTM。預設為：0
- 輸入：input, (h_0, c_0)
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()。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{split}\begin{aligned} N ={} & \text{batch size} \\ L ={} & \text{sequence length} \\ D ={} & 2 \text{ if bidirectional=True, otherwise } 1 \\ H_{in} ={} & \text{input\_size} \\ H_{cell} ={} & \text{hidden\_size} \\ H_{out} ={} & \text{proj\_size if } \text{proj\_size}>0 \text{, otherwise hidden\_size} \\ \end{aligned}\end{split}\]- 輸出：output, (h_n, c_n)
output: 形狀為 \((L, D * H_{out})\) 的張量（對於非批處理輸入），形狀為 \((L, N, D * H_{out})\)（當
batch_first=False時）或形狀為 \((N, L, D * H_{out})\)（當batch_first=True時），包含 LSTM 最內層每個 t 的輸出特徵 (h_t)。如果輸入是torch.nn.utils.rnn.PackedSequence，則輸出也將是打包序列。當bidirectional=True時，output 將包含序列中每個時間步的向前和向後隱藏狀態的連線。h_n: 形狀為 \((D * \text{num\_layers}, H_{out})\) 的張量（對於非批處理輸入）或形狀為 \((D * \text{num\_layers}, N, H_{out})\)，包含序列中每個元素的最終隱藏狀態。當
bidirectional=True時，h_n 將分別包含最終向前和向後隱藏狀態的連線。c_n: 形狀為 \((D * \text{num\_layers}, H_{cell})\) 的張量（對於非批處理輸入）或形狀為 \((D * \text{num\_layers}, N, H_{cell})\)，包含序列中每個元素的最終單元狀態。當
bidirectional=True時，c_n 將分別包含最終向前和向後單元狀態的連線。
- 變數:
weight_ih_l[k] – 第 \(\text{k}^{th}\) 層的可學習輸入-隱藏權重 (W_ii|W_if|W_ig|W_io)，形狀為 (4*hidden_size, input_size)（對於 k = 0）。否則，形狀為 (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。示例
>>> 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))
