GRUCell¶
- class torchrl.modules.GRUCell(input_size: int, hidden_size: int, bias: bool = True, device=None, dtype=None)[source]¶
一个门控循环单元 (GRU) 单元,执行与 nn.LSTMCell 相同的操作,但完全用 Python 编写。
注意
此类在实现时不依赖于 CuDNN,这使其与
torch.vmap()
和torch.compile()
兼容。示例
>>> import torch >>> from torchrl.modules.tensordict_module.rnn import GRUCell >>> 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 >>> gru_cell = GRUCell(input_size=N_IN, hidden_size=N_OUT, device=device)
# 单次调用 >>> x = torch.randn(B, 10, device=device) >>> h0 = torch.zeros(B, 20, device=device) >>> with torch.no_grad(): … h1 = gru_cell(x, h0)
# 向量化调用 - nn.GRUCell 不支持 >>> def call_gru(x, h): … h_out = gru_cell(x, h) … return h_out >>> batched_call = torch.vmap(call_gru) >>> x = torch.randn(V, B, 10, device=device) >>> h0 = torch.zeros(V, B, 20, device=device) >>> with torch.no_grad(): … h1 = batched_call(x, h0)
门控循环单元 (GRU) 单元。
\[\begin{split}\begin{array}{ll} r = \sigma(W_{ir} x + b_{ir} + W_{hr} h + b_{hr}) \\ z = \sigma(W_{iz} x + b_{iz} + W_{hz} h + b_{hz}) \\ n = \tanh(W_{in} x + b_{in} + r \odot (W_{hn} h + b_{hn})) \\ h' = (1 - z) \odot n + z \odot h \end{array}\end{split}\]其中 \(\sigma\) 是 sigmoid 函数,\(\odot\) 是哈达玛积。
- 参数:
input_size – 输入 x 中预期特征的数量
hidden_size – 隐藏状态 h 中特征的数量
bias – 如果为
False
,则该层不使用偏差权重 b_ih 和 b_hh。默认值:True
- 输入:input、hidden
input : 包含输入特征的张量
hidden : 包含批次中每个元素的初始隐藏状态的张量。如果未提供,则默认为零。
- 输出:h’
h’ : 包含批次中每个元素的下一个隐藏状态的张量
- 形状
input: \((N, H_{in})\) 或 \((H_{in})\) 张量,包含输入特征,其中 \(H_{in}\) = input_size。
hidden: \((N, H_{out})\) 或 \((H_{out})\) 张量,包含初始隐藏状态,其中 \(H_{out}\) = hidden_size。如果未提供,则默认为零。
output: \((N, H_{out})\) 或 \((H_{out})\) 张量,包含下一个隐藏状态。
- 变量:
weight_ih (torch.Tensor) – 可学习的输入-隐藏权重,形状为 (3*hidden_size, input_size)
weight_hh (torch.Tensor) – 可学习的隐藏-隐藏权重,形状为 (3*hidden_size, hidden_size)
bias_ih – 可学习的输入-隐藏偏差,形状为 (3*hidden_size)
bias_hh – 可学习的隐藏-隐藏偏差,形状为 (3*hidden_size)
注意
所有权重和偏差均从 \(\mathcal{U}(-\sqrt{k}, \sqrt{k})\) 初始化,其中 \(k = \frac{1}{\text{hidden\_size}}\)
在某些 ROCm 设备上,当使用 float16 输入时,此模块将使用 不同的精度 进行反向传播。
示例
>>> rnn = nn.GRUCell(10, 20) >>> input = torch.randn(6, 3, 10) >>> hx = torch.randn(3, 20) >>> output = [] >>> for i in range(6): ... hx = rnn(input[i], hx) ... output.append(hx)