GRPOLoss

class torchrl.objectives.llm.GRPOLoss(*args, **kwargs)

GRPO 损失。

裁剪重要性加权损失的计算方法如下：

loss = -min( weight * advantage, min(max(weight, 1-eps), 1+eps) * advantage)

参数:

actor_network (LLMWrapperBase) – 策略算子。

注意

在 GRPO 训练期间保持模型处于 eval 模式至关重要，以确保确定性行为和正确的डून样。训练模式和评估模式之间的不匹配是 RL 后训练中不稳定性或学习失败的常见原因。

注意

有效样本数量（ESS）是 GRPO 中的一个关键诊断指标。ESS 衡量批次中有效样本的数量，计算方法是重要性权重平方和的倒数。值为 1 表示所有重要性权重均相等（理想情况）。如果 ESS 下降或显著增加，通常表示模型配置存在问题，例如训练/评估模式不匹配或策略更新过大。

注意

masking_strategy 参数对于 LLM 训练场景至关重要。它决定了哪些 token 被包含在损失计算中： - “sft”：仅响应 token（排除 prompt token） - 适用于单轮对话 - “rlhf”：仅 assistant token（排除 user/system token） - 适用于多轮对话 - “generic”：所有有效 token（排除 padding token） - 适用于通用场景

masking_strategy 必须与计算 advantage 时使用的策略匹配，以避免形状不匹配。

关键字参数:

• clip_epsilon (scalar, optional) – 裁剪 PPO 损失方程中的权重裁剪阈值。默认值：0.2

• entropy_bonus (bool, optional) – 如果为 True，将向损失添加熵奖励，以鼓励探索性策略。

• samples_mc_entropy (int, optional) – 如果从策略算子检索到的分布没有熵的封闭形式公式，则将使用蒙特卡洛估计。`samples_mc_entropy` 将控制用于计算此估计的样本数量。默认为 `1`。

• entropy_coeff (scalar, optional) – 计算总损失时的熵乘数。默认为 `0.01`。

• advantage_key (str, optional) – [已弃用，请改用 set_keys(advantage_key=advantage_key) ] 预期写入 advantage 的输入 tensordict 键。默认为 `"advantage"`。

• reduction (str, optional) – 指定应用于输出的归约： `"none"` | `"mean"` | `"sum"`。`"none"`：不应用归约，`"mean"`：输出总和除以输出中的元素数量，`"sum"`：输出将求和。默认：`"mean"`。

• clip_value (bool 或 float, optional) – 如果提供了一个 `float`，它将用于计算值预测的裁剪版本，该版本相对于输入 tensordict 的值估计，并用于计算值损失。裁剪的目的是限制极端值预测的影响，帮助稳定训练并防止大的更新。但是，如果值估计是由值估计器的当前版本完成的，它将不起作用。如果提供 `True`，则 `clip_epsilon` 参数将用作裁剪阈值。如果未提供或为 `False`，则不会执行裁剪。默认为 `False`。

• kl_to_ref_coeff (float, optional) – KL 散度到参考策略的系数。默认为 `None`（无 KL 散度）。

• kl_to_inference_coeff (float, optional) – KL 散度到推理策略的系数。默认为 `None`（无 KL 散度）。

• device (torch.device, optional) – 缓冲区的设备。默认为 `None`。

• masking_strategy (Literal["sft", "rlhf", "generic"], optional) –

  用于创建分布的掩码策略。 - “sft”：使用 prompt masking（仅响应 token，适用于单轮） - “rlhf”：使用 assistant masking（仅 assistant token，适用于多轮） - “generic”：使用 attention masking（所有有效 token） 默认为“sft”，因为我们无法保证 assistant masks 的可用性。

  注意

  策略/ critic 的参数和缓冲区不会被转换为该设备，以确保存储与传递给其他组件（如数据收集器）的存储匹配。

add_module(name: str, module: Optional[Module]) → None

将子模块添加到当前模块。

可以使用给定的名称作为属性访问该模块。

参数:

• name (str) – 子模块的名称。子模块可以通过给定名称从此模块访问

• module (Module) – 要添加到模块中的子模块。

apply(fn: Callable[[Module], None]) → T

将 fn 递归应用于每个子模块（由 .children() 返回）以及自身。

典型用法包括初始化模型的参数（另请参阅 torch.nn.init）。

参数:

fn (Module -> None) – 要应用于每个子模块的函数

返回:

self

返回类型:

模块

示例

>>> @torch.no_grad()
>>> def init_weights(m):
>>>     print(m)
>>>     if type(m) == nn.Linear:
>>>         m.weight.fill_(1.0)
>>>         print(m.weight)
>>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2))
>>> net.apply(init_weights)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)

bfloat16() → T

将所有浮点参数和缓冲区转换为 bfloat16 数据类型。

注意

此方法就地修改模块。

返回:

self

返回类型:

模块

buffers(recurse: bool = True) → Iterator[Tensor]

返回模块缓冲区的迭代器。

参数:

recurse (bool) – 如果为 True，则会产生此模块及其所有子模块的 buffer。否则，仅会产生此模块的直接成员 buffer。

产生:

torch.Tensor – 模块缓冲区

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

children() → Iterator[Module]

返回直接子模块的迭代器。

产生:

Module – 子模块

compile(*args, **kwargs)

使用 `torch.compile()` 编译此 Module 的前向传播。

此 Module 的 `__call__` 方法已被编译，所有参数将按原样传递给 `torch.compile()`。

有关此函数的参数的详细信息，请参阅 `torch.compile()`。

convert_to_functional(module: TensorDictModule, module_name: str, expand_dim: int | None = None, create_target_params: bool = False, compare_against: list[Parameter] | None = None, **kwargs) → None

将模块转换为函数式以在损失中使用。

参数:

• module (TensorDictModule 或 兼容类型) – 一个有状态的 tensordict 模块。此模块的参数将隔离在 `_params` 属性中，并且该模块的无状态版本将注册在 `module_name` 属性下。

• module_name (str) – 模块将被找到的名称。模块的参数将在 `loss_module._params` 下找到，而模块将在 `loss_module.` 下找到。

• expand_dim (int, optional) –

  如果提供，则模块的参数

  将根据第一个维度扩展 `N` 次，其中 `N = expand_dim`。当使用具有多个配置的目标网络时，应使用此选项。

  注意

  如果提供了 `compare_against` 值列表，则生成的参数将只是原始参数的解耦扩展。如果未提供 `compare_against`，则参数的值将在参数内容的最小值和最大值之间均匀重采样。

  create_target_params (bool, optional): 如果为 True，则会创建一个解耦的

  参数的副本将可以在 `loss_module._target_params` 名称下提供给目标网络。如果为 `False`（默认值），则此属性仍然可用，但它将是参数的解耦实例，而不是副本。换句话说，对参数值的任何修改都将直接反映在目标参数中。

• compare_against (参数的可迭代对象, optional) – 如果提供，此参数列表将用作模块参数的比较集。如果参数被扩展（`expand_dim > 0`），则模块的生成参数将是原始参数的简单扩展。否则，生成参数将是原始参数的解耦版本。如果为 `None`，则生成参数将按预期携带梯度。

cpu() → T

将所有模型参数和缓冲区移动到 CPU。

注意

此方法就地修改模块。

返回:

self

返回类型:

模块

cuda(device: Optional[Union[int, device]] = None) → T

将所有模型参数和缓冲区移动到 GPU。

这也会使相关的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 GPU 上，则应在构建优化器之前调用此函数。

注意

此方法就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将复制到该设备

返回:

self

返回类型:

模块

default_keys

别名：_AcceptedKeys

double() → T

将所有浮点参数和缓冲区转换为 double 数据类型。

注意

此方法就地修改模块。

返回:

self

返回类型:

模块

eval() → T

将模块设置为评估模式。

这只对某些模块有影响。有关其在训练/评估模式下行为的详细信息，例如它们是否受影响，请参阅特定模块的文档，例如 `Dropout`、`BatchNorm` 等。

这等同于 `self.train(False)`。

有关 `.eval()` 和几个可能与之混淆的类似机制之间的比较，请参阅 “局部禁用梯度计算”。

返回:

self

返回类型:

模块

extra_repr() → str

返回模块的额外表示。

要打印自定义额外信息，您应该在自己的模块中重新实现此方法。单行和多行字符串均可接受。

float() → T

将所有浮点参数和缓冲区转换为 float 数据类型。

注意

此方法就地修改模块。

返回:

self

返回类型:

模块

forward(tensordict: TensorDictBase) → GRPOLossOutput

它旨在读取一个输入的 TensorDict 并返回另一个包含名为“loss*”的损失键的 tensordict。

将损失分解为其组成部分可以被训练器用于在训练过程中记录各种损失值。输出 tensordict 中存在的其他标量也将被记录。

参数:

tensordict – 一个输入的 tensordict，包含计算损失所需的值。

返回:

一个没有批处理维度的新 tensordict，其中包含各种损失标量，这些标量将被命名为“loss*”。重要的是，损失必须以这个名称返回，因为它们将在反向传播之前被训练器读取。

from_stateful_net(network_name: str, stateful_net: Module)

根据有状态的网络版本填充模型的参数。

有关如何收集有状态的网络版本，请参阅 `get_stateful_net()` 的文档。

参数:

• network_name (str) – 要重置的网络名称。

• stateful_net (nn.Module) – 应从中收集参数的状态化网络。

property functional

模块是否功能化。

除非经过专门设计使其不具有功能性，否则所有损失都具有功能性。

get_buffer(target: str) → Tensor

返回由 target 给定的缓冲区（如果存在），否则抛出错误。

有关此方法的详细说明以及如何正确指定 `target`，请参阅 `get_submodule` 的文档字符串。

参数:

target – 要查找的 buffer 的完全限定字符串名称。（要指定完全限定字符串，请参阅 get_submodule。）

返回:

由 target 引用的缓冲区

返回类型:

torch.Tensor

抛出:

AttributeError – 如果目标字符串引用了无效路径或解析为非 buffer 对象。

get_extra_state() → Any

返回要包含在模块 state_dict 中的任何额外状态。

实现此函数以及相应的 `set_extra_state()` 函数，以存储额外状态。在构建模块的 `state_dict()` 时会调用此函数。

请注意，额外状态应该是可序列化的，以确保 state_dict 的序列化正常工作。我们仅为序列化 Tensor 提供向后兼容性保证；其他对象的序列化可能因其序列化后的形式发生变化而破坏向后兼容性。

返回:

要存储在模块 state_dict 中的任何额外状态

返回类型:

对象

get_parameter(target: str) → Parameter

如果存在，返回由 target 给定的参数，否则抛出错误。

有关此方法的详细说明以及如何正确指定 `target`，请参阅 `get_submodule` 的文档字符串。

参数:

target – 要查找的 Parameter 的完全限定字符串名称。（要指定完全限定字符串，请参阅 get_submodule。）

返回:

由 target 引用的参数

返回类型:

torch.nn.Parameter

抛出:

AttributeError – 如果目标字符串引用了无效路径或解析为非 nn.Parameter 的对象。

get_stateful_net(network_name: str, copy: bool | None = None)

返回网络的状态化版本。

这可用于初始化参数。

这些网络通常开箱即用，无法调用，需要调用 vmap 才能执行。

参数:

• network_name (str) – 要收集的网络名称。

• copy (bool, optional) –

  如果为 True，则会进行网络的深拷贝。默认为 True。

  注意

  如果模块不是函数式的，则不会进行复制。

get_submodule(target: str) → Module

如果存在，返回由 target 给定的子模块，否则抛出错误。

例如，假设您有一个 nn.Module A，它看起来像这样

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

(图示了一个 `nn.Module` `A`。`A` 包含一个嵌套的子模块 `net_b`，该子模块本身有两个子模块 `net_c` 和 `linear`。`net_c` 然后有一个子模块 `conv`。)

要检查我们是否拥有 `linear` 子模块，我们将调用 `get_submodule("net_b.linear")`。要检查我们是否拥有 `conv` 子模块，我们将调用 `get_submodule("net_b.net_c.conv")`。

`get_submodule` 的运行时界限由 `target` 字符串路径中的模块嵌套深度决定。对 `named_modules` 的查询可以达到相同的结果，但其时间复杂度为 O(N)，其中 N 是传递模块的数量。因此，对于检查某个子模块是否存在，应始终使用 `get_submodule`。

参数:

target – 要查找的子模块的完全限定字符串名称。（要指定完全限定字符串，请参阅上面的示例。）

返回:

由 target 引用的子模块

返回类型:

torch.nn.Module

抛出:

AttributeError – 如果在 `target` 字符串解析的任何路径中，(子)路径解析为不存在的属性名或不是 `nn.Module` 实例的对象。

half() → T

将所有浮点参数和缓冲区转换为 half 数据类型。

注意

此方法就地修改模块。

返回:

self

返回类型:

模块

ipu(device: Optional[Union[int, device]] = None) → T

将所有模型参数和缓冲区移动到 IPU。

这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 IPU 上，则应在构建优化器之前调用它。

注意

此方法就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将复制到该设备

返回:

self

返回类型:

模块

static is_tdmodule_compatible(module)

检查模块是否与 TensorDictModule API 兼容。

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)

将参数和缓冲区从 `state_dict` 复制到此模块及其后代。

如果 `strict` 为 `True`，则 `state_dict` 的键必须精确匹配此模块的 `state_dict()` 函数返回的键。

警告

如果 `assign` 为 `True`，则优化器必须在调用 `load_state_dict` 之后创建，除非 `get_swap_module_params_on_conversion()` 为 `True`。

参数:

• state_dict (dict) – 包含参数和持久 buffer 的字典。

• strict (bool, optional) – 是否严格强制 `state_dict` 中的键与此模块的 `state_dict()` 函数返回的键匹配。默认值：`True`

• assign (bool, optional) – 当设置为 `False` 时，将保留当前模块中张量的属性；当设置为 `True` 时，将保留 state dict 中张量的属性。唯一的例外是 `requires_grad` 字段。默认值：``False``

返回:

• missing_keys 是一个包含任何预期键的 str 列表。

  在提供的 state_dict 中缺失的任何键的字符串列表。

• unexpected_keys 是一个包含不匹配的键的 str 列表。

  不期望但在提供的 state_dict 中存在的键。

返回类型:

`NamedTuple`，包含 `missing_keys` 和 `unexpected_keys` 字段

注意

如果参数或缓冲区注册为 `None` 且其对应的键存在于 `state_dict` 中，则 `load_state_dict()` 将引发 `RuntimeError`。

loss_critic(tensordict: TensorDictBase) → tuple[torch.Tensor | TensorDict, ...]

如果 `critic_coeff` 不是 `None`，则返回乘以 `critic_coeff` 的 critic 损失。

make_value_estimator(value_type: Optional[ValueEstimators] = None, **hyperparams)

值函数构造函数。

如果需要非默认值函数，必须使用此方法构建。

参数:

• value_type (ValueEstimators) – 一个 `ValueEstimators` 枚举类型，指示要使用的值函数。如果未提供，将使用 `default_value_estimator` 属性中存储的默认值。生成的 value estimator 类将注册在 `self.value_type` 中，允许后续的改进。

• \*\*hyperparams – 用于值函数的超参数。如果未提供，将使用 `default_value_kwargs()` 指示的值。

示例

>>> from torchrl.objectives import DQNLoss
>>> # initialize the DQN loss
>>> actor = torch.nn.Linear(3, 4)
>>> dqn_loss = DQNLoss(actor, action_space="one-hot")
>>> # updating the parameters of the default value estimator
>>> dqn_loss.make_value_estimator(gamma=0.9)
>>> dqn_loss.make_value_estimator(
...     ValueEstimators.TD1,
...     gamma=0.9)
>>> # if we want to change the gamma value
>>> dqn_loss.make_value_estimator(dqn_loss.value_type, gamma=0.9)

modules() → Iterator[Module]

返回网络中所有模块的迭代器。

产生:

Module – 网络中的一个模块

注意

重复的模块只返回一次。在以下示例中，l 只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.modules()):
...     print(idx, '->', m)

0 -> Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)
1 -> Linear(in_features=2, out_features=2, bias=True)

mtia(device: Optional[Union[int, device]] = None) → T

将所有模型参数和缓冲区移动到 MTIA。

这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 MTIA 上，则应在构建优化器之前调用它。

注意

此方法就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将复制到该设备

返回:

self

返回类型:

模块

named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[tuple[str, torch.Tensor]]

返回模块缓冲区上的迭代器，同时生成缓冲区的名称和缓冲区本身。

参数:

• prefix (str) – 为所有 buffer 名称添加前缀。

• recurse (bool, optional) – 如果为 True，则会生成此模块及其所有子模块的 buffers。否则，仅生成此模块直接成员的 buffers。默认为 True。

• remove_duplicate (bool, optional) – 是否在结果中删除重复的 buffers。默认为 True。

产生:

(str, torch.Tensor) – 包含名称和缓冲区的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children() → Iterator[tuple[str, 'Module']]

返回对直接子模块的迭代器，生成模块的名称和模块本身。

产生:

(str, Module) – 包含名称和子模块的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo: Optional[set['Module']] = None, prefix: str = '', remove_duplicate: bool = True)

返回网络中所有模块的迭代器，同时生成模块的名称和模块本身。

参数:

• memo – 用于存储已添加到结果中的模块集合的 memo

• prefix – 将添加到模块名称的名称前缀

• remove_duplicate – 是否从结果中删除重复的模块实例

产生:

(str, Module) – 名称和模块的元组

注意

重复的模块只返回一次。在以下示例中，l 只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.named_modules()):
...     print(idx, '->', m)

0 -> ('', Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
))
1 -> ('0', Linear(in_features=2, out_features=2, bias=True))

named_parameters(prefix: str = '', recurse: bool = True) → Iterator[tuple[str, torch.nn.parameter.Parameter]]

返回模块参数的迭代器，同时生成参数的名称和参数本身。

参数:

• prefix (str) – 为所有参数名称添加前缀。

• recurse (bool) – 如果为 True，则会生成此模块及其所有子模块的参数。否则，仅生成此模块直接成员的参数。

• remove_duplicate (bool, optional) – 是否在结果中删除重复的参数。默认为 True。

产生:

(str, Parameter) – 包含名称和参数的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

parameters(recurse: bool = True) → Iterator[Parameter]

返回模块参数的迭代器。

这通常传递给优化器。

参数:

recurse (bool) – 如果为 True，则会生成此模块及其所有子模块的参数。否则，仅生成此模块直接成员的参数。

产生:

Parameter – 模块参数

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for param in model.parameters():
>>>     print(type(param), param.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

register_backward_hook(hook: Callable[[Module, Union[tuple[torch.Tensor, ...], Tensor], Union[tuple[torch.Tensor, ...], Tensor]], Union[None, tuple[torch.Tensor, ...], Tensor]]) → RemovableHandle

在模块上注册一个反向传播钩子。

此函数已弃用，推荐使用 `register_full_backward_hook()`，并且此函数行为将在未来版本中发生更改。

返回:

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) → None

向模块添加一个缓冲区。

这通常用于注册一个不应被视为模型参数的缓冲区。例如，BatchNorm 的 `running_mean` 不是参数，但它是模块状态的一部分。缓冲区默认是持久的，并将与参数一起保存。可以通过将 `persistent` 设置为 `False` 来更改此行为。持久缓冲区和非持久缓冲区之间的唯一区别是后者不会成为此模块 `state_dict` 的一部分。

可以使用给定名称作为属性访问缓冲区。

参数:

• name (str) – buffer 的名称。可以使用给定的名称从此模块访问 buffer

• tensor (Tensor 或 None) – 要注册的缓冲区。如果为 `None`，则在缓冲区上运行的操作，例如 `cuda()`，将被忽略。如果为 `None`，则缓冲区 **不** 包含在此模块的 `state_dict` 中。

• persistent (bool) – 缓冲区是否是此模块 `state_dict` 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook: Union[Callable[[T, tuple[Any, ...], Any], Optional[Any]], Callable[[T, tuple[Any, ...], dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) → RemovableHandle

在模块上注册一个前向钩子。

每次调用 `forward()` 计算输出后，都会调用该 hook。

如果 `with_kwargs` 为 `False` 或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hook，只传递给 `forward`。hook 可以修改输出。它可以原地修改输入，但不会影响前向传播，因为这是在 `forward()` 调用后调用的。hook 的签名应为：

hook(module, args, output) -> None or modified output

如果 `with_kwargs` 为 `True`，则前向 hook 将接收传递给 forward 函数的 `kwargs`，并有望返回可能已修改的输出。hook 的签名应为：

hook(module, args, kwargs, output) -> None or modified output

参数:

• hook (Callable) – 用户定义的待注册钩子。

• prepend (bool) – 如果为 `True`，则提供的 `hook` 将在当前 `torch.nn.Module` 的所有现有 `forward` hook 之前执行。否则，提供的 `hook` 将在当前 `torch.nn.Module` 的所有现有 `forward` hook 之后执行。请注意，使用 `register_module_forward_hook()` 注册的全局 `forward` hook 将在由此方法注册的所有 hook 之前执行。默认为 `False`

• with_kwargs (bool) – 如果为 `True`，则 `hook` 将接收传递给 forward 函数的 kwargs。默认为 `False`

• always_call (bool) – 如果为 `True`，即使在调用 Module 时引发异常，也将运行 `hook`。默认为 `False`

返回:

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook: Union[Callable[[T, tuple[Any, ...]], Optional[Any]], Callable[[T, tuple[Any, ...], dict[str, Any]], Optional[tuple[Any, dict[str, Any]]]], *, prepend: bool = False, with_kwargs: bool = False) → RemovableHandle

在模块上注册一个前向预钩子。

每次调用 `forward()` 之前都会调用该 hook。

如果 `with_kwargs` 为 false 或未指定，则输入仅包含传递给模块的位置参数。关键字参数不会传递给 hook，只传递给 `forward`。hook 可以修改输入。用户可以返回一个元组或 hook 中的单个修改值。我们将返回单个值的元组（除非该值已经是元组）。hook 的签名应为：

hook(module, args) -> None or modified input

如果 `with_kwargs` 为 true，则前向 pre-hook 将接收传递给 forward 函数的 kwargs，如果 hook 修改了输入，则应返回 args 和 kwargs。hook 的签名应为：

hook(module, args, kwargs) -> None or a tuple of modified input and kwargs

参数:

• hook (Callable) – 用户定义的待注册钩子。

• prepend (bool) – 如果为 true，则提供的 `hook` 将在当前 `torch.nn.Module` 的所有现有 `forward_pre` hook 之前执行。否则，提供的 `hook` 将在当前 `torch.nn.Module` 的所有现有 `forward_pre` hook 之后执行。请注意，使用 `register_module_forward_pre_hook()` 注册的全局 `forward_pre` hook 将在由此方法注册的所有 hook 之前执行。默认为 `False`

• with_kwargs (bool) – 如果为 true，则 `hook` 将接收传递给 forward 函数的 kwargs。默认为 `False`

返回:

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook: Callable[[Module, Union[tuple[torch.Tensor, ...], Tensor], Union[tuple[torch.Tensor, ...], Tensor]], Union[None, tuple[torch.Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle

在模块上注册一个反向传播钩子。

hook 将在计算模块的梯度时被调用，即只有在计算模块输出的梯度时 hook 才会执行。hook 应具有以下签名

hook(module, grad_input, grad_output) -> tuple(Tensor) or None

`grad_input` 和 `grad_output` 是包含相对于输入和输出的梯度的元组。hook 不应修改其参数，但可以选择返回相对于输入的新的梯度，该梯度将用于替换后续计算中的 `grad_input`。`grad_input` 只对应作为位置参数给出的输入，所有关键字参数将被忽略。对于所有非 Tensor 参数，`grad_input` 和 `grad_output` 中的条目将为 `None`。

由于技术原因，当此钩子应用于模块时，其前向函数将接收传递给模块的每个张量的视图。类似地，调用者将接收模块前向函数返回的每个张量的视图。

警告

使用反向传播钩子时不允许就地修改输入或输出，否则将引发错误。

参数:

• hook (Callable) – 要注册的用户定义钩子。

• prepend (bool) – 如果为 true，则提供的 `hook` 将在当前 `torch.nn.Module` 的所有现有 `backward` hook 之前执行。否则，提供的 `hook` 将在当前 `torch.nn.Module` 的所有现有 `backward` hook 之后执行。请注意，使用 `register_module_full_backward_hook()` 注册的全局 `backward` hook 将在由此方法注册的所有 hook 之前执行。

返回:

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook: Callable[[Module, Union[tuple[torch.Tensor, ...], Tensor]], Union[None, tuple[torch.Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle

在模块上注册一个反向预钩子。

每次计算模块的梯度时，将调用此钩子。钩子应具有以下签名

hook(module, grad_output) -> tuple[Tensor] or None

grad_output 是一个元组。钩子不应修改其参数，但可以选择返回一个关于输出的新梯度，该梯度将用于后续计算中替代 `grad_output`。对于所有非 Tensor 参数，`grad_output` 中的条目将为 `None`。

由于技术原因，当此钩子应用于模块时，其前向函数将接收传递给模块的每个张量的视图。类似地，调用者将接收模块前向函数返回的每个张量的视图。

警告

使用反向传播钩子时不允许就地修改输入，否则将引发错误。

参数:

• hook (Callable) – 要注册的用户定义钩子。

• prepend (bool) – 如果为 True，则提供的 `hook` 将在当前 `torch.nn.Module` 上的所有现有 `backward_pre` 钩子之前触发。否则，提供的 `hook` 将在当前 `torch.nn.Module` 上的所有现有 `backward_pre` 钩子之后触发。请注意，使用 `register_module_full_backward_pre_hook()` 注册的全局 `backward_pre` 钩子将在通过此方法注册的所有钩子之前触发。

返回:

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

注册一个后钩子，用于在模块的 load_state_dict() 被调用后运行。

它应该具有以下签名：

hook(module, incompatible_keys) -> None

module 参数是当前注册此钩子的模块，而 `incompatible_keys` 参数是一个 `NamedTuple`，包含 `missing_keys` 和 `unexpected_keys` 属性。`missing_keys` 是一个包含缺失键的 `list` of `str`，而 `unexpected_keys` 是一个包含意外键的 `list` of `str`。

如果需要，可以就地修改给定的 incompatible_keys。

请注意，当以 `strict=True` 调用 `load_state_dict()` 时执行的检查会受到钩子对 `missing_keys` 或 `unexpected_keys` 的修改的影响，正如预期的那样。向任一键集合添加元素将在 `strict=True` 时引发错误，而清空缺失和意外键将避免错误。

返回:

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)

注册一个预钩子，用于在模块的 load_state_dict() 被调用之前运行。

它应该具有以下签名：

hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

参数:

hook (Callable) – 在加载状态字典之前将调用的可调用钩子。

register_module(name: str, module: Optional[Module]) → None

`add_module()` 的别名。

register_parameter(name: str, param: Optional[Parameter]) → None

向模块添加一个参数。

可以使用给定名称作为属性访问该参数。

参数:

• name (str) – 参数的名称。可以通过给定名称从该模块访问该参数。

• param (Parameter 或 None) – 要添加到模块的参数。如果为 `None`，则忽略在参数上运行的操作，例如 `cuda`。如果为 `None`，则该参数 **不** 包含在模块的 `state_dict` 中。

register_state_dict_post_hook(hook)

为 `state_dict()` 方法注册一个后钩子。

它应该具有以下签名：

hook(module, state_dict, prefix, local_metadata) -> None

注册的钩子可以就地修改 state_dict。

register_state_dict_pre_hook(hook)

为 `state_dict()` 方法注册一个前钩子。

它应该具有以下签名：

hook(module, prefix, keep_vars) -> None

注册的钩子可用于在进行 state_dict 调用之前执行预处理。

requires_grad_(requires_grad: bool = True) → T

更改自动梯度是否应记录此模块中参数的操作。

此方法就地设置参数的 requires_grad 属性。

此方法有助于冻结模块的一部分以进行微调或单独训练模型的一部分（例如，GAN 训练）。

有关 `requires_grad_()` 和几个可能与之混淆的类似机制的比较，请参阅 局部禁用梯度计算。

参数:

requires_grad (bool) – 自动求导是否应记录此模块上的参数操作。默认为 True。

返回:

self

返回类型:

模块

reset_out_keys()

将 out_keys 属性重置为其原始值。

返回: 相同的模块，但 out_keys 值已重置。

示例

>>> from tensordict import TensorDict
>>> from tensordict.nn import TensorDictModule, TensorDictSequential
>>> import torch
>>> mod = TensorDictModule(lambda x, y: (x+2, y+2), in_keys=["a", "b"], out_keys=["c", "d"])
>>> mod.select_out_keys("d")
>>> td = TensorDict({"a": torch.zeros(()), "b": torch.ones(())}, [])
>>> mod(td)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> mod.reset_out_keys()
>>> mod(td)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

reset_parameters_recursive()

重置模块的参数。

select_out_keys(*out_keys) → TensorDictModuleBase

选择将在输出 tensordict 中找到的键。

当一个人想丢弃复杂图中的中间键，或者当这些键的存在可能触发意外行为时，这很有用。

原始 out_keys 仍然可以通过 module.out_keys_source 访问。

参数:

*out_keys (字符串序列 或 字符串元组) – 应在输出 tensordict 中找到的 out_keys。

返回: 相同的模块，以就地修改方式返回，并更新了 out_keys。

最简单的用法是与 TensorDictModule 一起使用。

示例

>>> from tensordict import TensorDict
>>> from tensordict.nn import TensorDictModule, TensorDictSequential
>>> import torch
>>> mod = TensorDictModule(lambda x, y: (x+2, y+2), in_keys=["a", "b"], out_keys=["c", "d"])
>>> td = TensorDict({"a": torch.zeros(()), "b": torch.ones(())}, [])
>>> mod(td)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> mod.select_out_keys("d")
>>> td = TensorDict({"a": torch.zeros(()), "b": torch.ones(())}, [])
>>> mod(td)
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

此功能也将适用于分派的参数： .. rubric:: 示例

>>> mod(torch.zeros(()), torch.ones(()))
tensor(2.)

此更改将就地发生（即，将返回相同的模块，并更新 out_keys 列表）。可以使用 `TensorDictModuleBase.reset_out_keys()` 方法恢复此更改。

示例

>>> mod.reset_out_keys()
>>> mod(TensorDict({"a": torch.zeros(()), "b": torch.ones(())}, []))
TensorDict(
    fields={
        a: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        c: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        d: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

这也将适用于其他类，例如 Sequential： .. rubric:: 示例

>>> from tensordict.nn import TensorDictSequential
>>> seq = TensorDictSequential(
...     TensorDictModule(lambda x: x+1, in_keys=["x"], out_keys=["y"]),
...     TensorDictModule(lambda x: x+1, in_keys=["y"], out_keys=["z"]),
... )
>>> td = TensorDict({"x": torch.zeros(())}, [])
>>> seq(td)
TensorDict(
    fields={
        x: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        y: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        z: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)
>>> seq.select_out_keys("z")
>>> td = TensorDict({"x": torch.zeros(())}, [])
>>> seq(td)
TensorDict(
    fields={
        x: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False),
        z: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([]),
    device=None,
    is_shared=False)

set_extra_state(state: Any) → None

设置加载的 state_dict 中包含的额外状态。

此函数由 `load_state_dict()` 调用，用于处理 `state_dict` 中的任何额外状态。如果需要将额外状态存储在模块的 `state_dict` 中，请实现此函数和相应的 `get_extra_state()`。

参数:

state (dict) – 来自 state_dict 的额外状态

set_keys(**kwargs) → None

设置 tensordict 键名。

示例

>>> from torchrl.objectives import DQNLoss
>>> # initialize the DQN loss
>>> actor = torch.nn.Linear(3, 4)
>>> dqn_loss = DQNLoss(actor, action_space="one-hot")
>>> dqn_loss.set_keys(priority_key="td_error", action_value_key="action_value")

set_submodule(target: str, module: Module, strict: bool = False) → None

如果存在，设置由 target 给定的子模块，否则抛出错误。

注意

如果 `strict` 设置为 `False`（默认），该方法将替换现有子模块或在父模块存在时创建新子模块。如果 `strict` 设置为 `True`，该方法将仅尝试替换现有子模块，并在子模块不存在时引发错误。

例如，假设您有一个 nn.Module A，它看起来像这样

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(3, 3, 3)
        )
        (linear): Linear(3, 3)
    )
)

(图示显示了一个 `nn.Module` `A`。`A` 拥有一个嵌套子模块 `net_b`，`net_b` 本身有两个子模块 `net_c` 和 `linear`。`net_c` 然后拥有一个子模块 `conv`。)

要用新的 `Linear` 子模块覆盖 `Conv2d`，你可以调用 `set_submodule("net_b.net_c.conv", nn.Linear(1, 1))`，其中 `strict` 可以是 `True` 或 `False`。

要将新的 `Conv2d` 子模块添加到现有的 `net_b` 模块中，你可以调用 `set_submodule("net_b.conv", nn.Conv2d(1, 1, 1))`。

在上述情况下，如果你设置 `strict=True` 并调用 `set_submodule("net_b.conv", nn.Conv2d(1, 1, 1), strict=True)`，则会引发 AttributeError，因为 `net_b` 没有名为 `conv` 的子模块。

参数:

• target – 要查找的子模块的完全限定字符串名称。（要指定完全限定字符串，请参阅上面的示例。）

• module – 要设置子模块的对象。

• strict – 如果为 `False`，该方法将替换现有子模块或在父模块存在时创建新子模块。如果为 `True`，该方法将仅尝试替换现有子模块，并在子模块不存在时引发错误。

抛出:

• ValueError – 如果 `target` 字符串为空，或者 `module` 不是 `nn.Module` 的实例。

• AttributeError – 如果沿 `target` 字符串产生的路径中的任何点解析为不存在的属性名或不是 `nn.Module` 实例的对象。

share_memory() → T

请参阅 torch.Tensor.share_memory_()。

state_dict(*args, destination=None, prefix='', keep_vars=False)

返回一个字典，其中包含对模块整个状态的引用。

参数和持久缓冲区（例如，运行平均值）都包含在内。键是相应的参数和缓冲区名称。设置为 None 的参数和缓冲区不包含在内。

注意

返回的对象是浅拷贝。它包含对模块参数和缓冲区的引用。

警告

目前，`state_dict()` 也按顺序接受 `destination`、`prefix` 和 `keep_vars` 的位置参数。但是，这正在被弃用，并且在未来版本中将强制使用关键字参数。

警告

请避免使用参数 destination，因为它不是为最终用户设计的。

参数:

• destination (dict, optional) – 如果提供，模块的状态将被更新到字典中，并返回相同的对象。否则，将创建一个 `OrderedDict` 并返回。默认为 `None`。

• prefix (str, optional) – a prefix added to parameter and buffer names to compose the keys in state_dict. Default: ''。

• keep_vars (bool, optional) – 默认情况下，返回状态字典中的 `Tensor` 会与 autograd 分离。如果设置为 `True`，则不会执行分离。默认为 `False`。

返回:

包含模块整体状态的字典

返回类型:

dict

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']

to(*args, **kwargs)

移动和/或转换参数和缓冲区。

这可以这样调用

to(device=None, dtype=None, non_blocking=False)

to(dtype, non_blocking=False)

to(tensor, non_blocking=False)

to(memory_format=torch.channels_last)

其签名类似于 `torch.Tensor.to()`，但仅接受浮点或复数 `dtype`。此外，此方法只会将浮点或复数参数和缓冲区转换为 `dtype`（如果已给出）。整数参数和缓冲区将移动到 `device`（如果已给出），但 `dtype` 保持不变。当设置 `non_blocking` 时，它会尝试异步（相对于主机）进行转换/移动（如果可能），例如将具有固定内存的 CPU Tensor 移动到 CUDA 设备。

有关示例，请参阅下文。

注意

此方法就地修改模块。

参数:

• device (torch.device) – 此模块中参数和缓冲区的目标设备

• dtype (torch.dtype) – 此模块中参数和缓冲区的目标浮点或复数 dtype

• tensor (torch.Tensor) – 具有作为此模块所有参数和缓冲区的目标 dtype 和设备的 Tensor

• memory_format (torch.memory_format) – 4D 参数和缓冲区的目标内存格式（仅关键字参数）

返回:

self

返回类型:

模块

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> linear = nn.Linear(2, 2)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]])
>>> linear.to(torch.double)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]], dtype=torch.float64)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> gpu1 = torch.device("cuda:1")
>>> linear.to(gpu1, dtype=torch.half, non_blocking=True)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1')
>>> cpu = torch.device("cpu")
>>> linear.to(cpu)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16)

>>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble)
>>> linear.weight
Parameter containing:
tensor([[ 0.3741+0.j,  0.2382+0.j],
        [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128)
>>> linear(torch.ones(3, 2, dtype=torch.cdouble))
tensor([[0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)

to_empty(*, device: Optional[Union[int, str, device]], recurse: bool = True) → T

将参数和缓冲区移动到指定设备，而不复制存储。

参数:

• device (torch.device) – 此模块中参数和缓冲区的目标设备。

• recurse (bool) – 是否递归地将子模块的参数和缓冲区移动到指定设备。

返回:

self

返回类型:

模块

train(mode: bool = True) → T

将模块设置为训练模式。

这只对某些模块有影响。有关它们在训练/评估模式下的行为，例如它们是否受影响（例如 `Dropout`、`BatchNorm` 等），请参阅特定模块的文档。

参数:

mode (bool) – 设置训练模式（`True`）或评估模式（`False`）。默认为 `True`。

返回:

self

返回类型:

模块

type(dst_type: Union[dtype, str]) → T

将所有参数和缓冲区转换为 dst_type。

注意

此方法就地修改模块。

参数:

dst_type (type or string) – 目标类型

返回:

self

返回类型:

模块

property value_estimator: ValueEstimatorBase

价值函数将奖励和即将到来的状态/状态-动作对的价值估计值融合到价值网络的目标价值估计中。

property vmap_randomness

Vmap 随机模式。

vmap 随机模式控制 `vmap()` 在处理具有随机结果的函数（如 `randn()` 和 `rand()`）时应做什么。如果为 `"error"`，任何随机函数都会引发一个异常，表明 `vmap` 不知道如何处理随机调用。

如果设置为 “different”，则 vmap 正在调用的批次中的每个元素将表现不同。如果设置为 “same”，则 vmap 会将相同的结果复制到所有元素。

`vmap_randomness` 默认为 `"error"`（如果未检测到随机模块），在其他情况下为 `"different"`。默认情况下，只有有限数量的模块被列为随机模块，但可以使用 `add_random_module()` 函数扩展列表。

此属性支持设置其值。

xpu(device: Optional[Union[int, device]] = None) → T

将所有模型参数和缓冲区移动到 XPU。

这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块在优化时将驻留在 XPU 上，则应在构建优化器之前调用它。

注意

此方法就地修改模块。

参数:

device (int, optional) – 如果指定，所有参数将复制到该设备

返回:

self

返回类型:

模块

zero_grad(set_to_none: bool = True) → None

重置所有模型参数的梯度。

有关更多背景信息，请参阅 `torch.optim.Optimizer` 下的类似函数。

参数:

set_to_none (bool) – 不设置为零，而是将 grad 设置为 None。有关详细信息，请参阅 `torch.optim.Optimizer.zero_grad()`。