LSTMCell¶
- class torchrl.modules.LSTMCell(input_size: int, hidden_size: int, bias: bool = True, device=None, dtype=None)[源代码]¶
长短期记忆 (LSTM) 单元,执行与 nn.LSTMCell 相同的操作,但完全用 Python 代码编写。
注意
此类在不依赖 CuDNN 的情况下实现,这使其与
torch.vmap()
和torch.compile()
兼容。示例
>>> import torch >>> from torchrl.modules.tensordict_module.rnn import LSTMCell >>> device = torch.device("cuda") if torch.cuda.device_count() else torch.device("cpu") >>> B = 2 >>> N_IN = 10 >>> N_OUT = 20 >>> V = 4 # vector size >>> lstm_cell = LSTMCell(input_size=N_IN, hidden_size=N_OUT, device=device)
# 单次调用 >>> x = torch.randn(B, 10, device=device) >>> h0 = torch.zeros(B, 20, device=device) >>> c0 = torch.zeros(B, 20, device=device) >>> with torch.no_grad(): … (h1, c1) = lstm_cell(x, (h0, c0))
# 向量化调用 - nn.LSTMCell 不支持 >>> def call_lstm(x, h, c): … h_out, c_out = lstm_cell(x, (h, c)) … return h_out, c_out >>> batched_call = torch.vmap(call_lstm) >>> x = torch.randn(V, B, 10, device=device) >>> h0 = torch.zeros(V, B, 20, device=device) >>> c0 = torch.zeros(V, B, 20, device=device) >>> with torch.no_grad(): … (h1, c1) = batched_call(x, h0, c0)
长短期记忆 (LSTM) 单元。
\[\begin{split}\begin{array}{ll} i = \sigma(W_{ii} x + b_{ii} + W_{hi} h + b_{hi}) \\ f = \sigma(W_{if} x + b_{if} + W_{hf} h + b_{hf}) \\ g = \tanh(W_{ig} x + b_{ig} + W_{hg} h + b_{hg}) \\ o = \sigma(W_{io} x + b_{io} + W_{ho} h + b_{ho}) \\ c' = f \odot c + i \odot g \\ h' = o \odot \tanh(c') \\ \end{array}\end{split}\]其中 \(\sigma\) 是 sigmoid 函数,\(\odot\) 是哈达玛积。
- 参数:
input_size – 输入 x 中预期特征的数量
hidden_size – 隐藏状态 h 中特征的数量
bias – 如果为
False
,则该层不使用偏差权重 b_ih 和 b_hh。默认值:True
- 输入:input、(h_0, c_0)
input 形状为 (batch, input_size) 或 (input_size):包含输入特征的张量
h_0 形状为 (batch, hidden_size) 或 (hidden_size):包含初始隐藏状态的张量
c_0 形状为 (batch, hidden_size) 或 (hidden_size):包含初始单元状态的张量
如果没有提供 (h_0, c_0),则 h_0 和 c_0 默认为零。
- 输出: (h_1, c_1)
h_1 形状为 (batch, hidden_size) 或 (hidden_size):包含下一个隐藏状态的张量
c_1 形状为 (batch, hidden_size) 或 (hidden_size):包含下一个单元状态的张量
- 变量:
weight_ih (torch.Tensor) – 可学习的输入-隐藏权重,形状为 (4*hidden_size, input_size)
weight_hh (torch.Tensor) – 可学习的隐藏-隐藏权重,形状为 (4*hidden_size, hidden_size)
bias_ih – 可学习的输入-隐藏偏差,形状为 (4*hidden_size)
bias_hh – 可学习的隐藏-隐藏偏差,形状为 (4*hidden_size)
注意
所有权重和偏差都从 \(\mathcal{U}(-\sqrt{k}, \sqrt{k})\) 初始化,其中 \(k = \frac{1}{\text{hidden\_size}}\)
在某些 ROCm 设备上,当使用 float16 输入时,此模块将使用 不同的精度 进行反向传播。
示例
>>> rnn = nn.LSTMCell(10, 20) # (input_size, hidden_size) >>> input = torch.randn(2, 3, 10) # (time_steps, batch, input_size) >>> hx = torch.randn(3, 20) # (batch, hidden_size) >>> cx = torch.randn(3, 20) >>> output = [] >>> for i in range(input.size()[0]): ... hx, cx = rnn(input[i], (hx, cx)) ... output.append(hx) >>> output = torch.stack(output, dim=0)