SFTLoss

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

监督微调损失。

参数:

• actor_network (TensorDictModule) – actor 网络。通常是一个 TransformersWrapper 实例，其中 return_log_prob=True 且 from_text=True。

• tokenizer (Tokenizer) – 用于对输入进行标记和计算助手掩码的分词器。如果未提供，则会从 actor_network 中推断分词器。

• tokenizer_kwargs (dict, optional) – 在调用 apply_chat_template() 时传递给分词器的关键字参数。这可用于覆盖 chat_template 或 chat_template_name 等参数。

• reduction (Literal["mean", "sum", "none"], optional) –应用于损失的归约方式。默认为 “mean”。

• normalize_by_seq_length (bool, optional) – 是否按序列长度对损失进行归一化。默认为 True。

• kl_to_ref_coeff (float | None, optional) – KL 散度相对于参考模型的系数。默认为 None。

• loss_function (Literal["sft", "minor_sft"], optional) – 使用的损失函数。默认为 “sft”。

• beta (float, optional) –

  MinorSFT 损失的 beta 参数。仅当 loss_function 为 “minor_sft” 时使用。beta 值越高，损失就越激进（促使模型生成与参考模型更不同的响应）。

  \[\text{loss} = -\log\sigma(\beta \cdot (\text{log_probs} - \text{ref_log_probs}))\]

  默认为 0.1。

• device (torch.device | None, optional) – 用于损失的设备，在对输入进行分词时使用。默认为 None。

注意

默认情况下，输入 tensordict 预计包含以下键：

• ("next", "history"): 对话历史记录

• ("next", "ref_log_prob") (可选): 参考模型 log 概率，如果设置了 kl_to_ref_coeff 则需要。

这些键可以通过 set_keys() 方法进行自定义。

另请参阅

RetrieveLogProb 用于 KL 散度计算。

参考文献

• Shiming Xie, Hong Chen, Fred Yu, Zeye Sun, Xiuyu Wu, 2024. “Minor SFT loss for LLM fine-tune to increase performance and reduce model deviation”

示例

>>> from torchrl.data.llm.chat import History, _CHAT_TEMPLATES
>>> from torchrl.modules.llm import TransformersWrapper
>>> from torchrl.objectives.llm.sft import SFTLoss
>>> from transformers import AutoTokenizer, OPTConfig, OPTForCausalLM
>>> from tensordict import TensorDict, lazy_stack
>>> import torch
>>>
>>> # Create chat data
>>> chats = [
...     [
...         {"role": "system", "content": "You are a helpful assistant."},
...         {"role": "user", "content": "Hello, how are you?"},
...         {"role": "assistant", "content": "I'm doing well, thank you!"},
...     ],
...     [
...         {"role": "system", "content": "You are a helpful assistant."},
...         {"role": "user", "content": "What's the weather like?"},
...         {"role": "assistant", "content": "I can't check the weather for you."},
...     ],
... ]
>>> history = History.from_chats(chats)
>>>
>>> # Setup tokenizer and model
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/opt-125m")
>>> tokenizer.pad_token = tokenizer.eos_token
>>> tokenizer.chat_template = _CHAT_TEMPLATES["chatml_format"]
>>> model = OPTForCausalLM(OPTConfig()).eval()
>>>
>>> # Create training and reference policies
>>> policy_train = TransformersWrapper(
...     model,
...     tokenizer=tokenizer,
...     generate=False,
...     from_text=True,
...     chat_template_name="qwen",
... )
>>> policy_ref = TransformersWrapper(
...     model,
...     tokenizer=tokenizer,
...     generate=False,
...     from_text=True,
...     return_log_probs=True,
...     chat_template_name="qwen",
... )
>>>
>>> # Create the RetrieveLogProb transform
>>> transform = RetrieveLogProb(
...     policy_ref,
...     assistant_only=True,
...     tokenizer_kwargs={"chat_template_name": "qwen"},
...     tokenizer=tokenizer,
... )
>>>
>>> # Prepare data
>>> text = history[:, :-1].apply_chat_template(
...     tokenizer=tokenizer, chat_template_name="qwen", add_generation_prompt=True
... )
>>> text_response = history.apply_chat_template(
...     tokenizer=tokenizer, chat_template_name="qwen", add_generation_prompt=False
... )
>>> text_response = [
...     txt[len(txt_start):] for txt, txt_start in zip(text_response, text)
... ]
>>> td = TensorDict(
...     text=text,
...     text_response=text_response,
...     history=history,
...     next=TensorDict(
...         reward=torch.randn(2, 1),
...         done=torch.zeros(2, dtype=torch.bool),
...         history=history,
...     ),
...     batch_size=(2,),
... )
>>> data = lazy_stack(list(td.unbind(0)))
>>>
>>> # Apply the transform to get reference log probabilities
>>> data = transform(data)
>>> assert "ref_log_prob" in data["next"].keys()
>>>
>>> # Use with SFTLoss for KL regularization
>>> loss = SFTLoss(
...     actor_network=policy_train,
...     tokenizer=tokenizer,
...     reduction="mean",
...     normalize_by_seq_length=True,
...     kl_to_ref_coeff=0.1,
...     tokenizer_kwargs={"chat_template_name": "qwen"},
...     loss_function="sft",
... )
>>> loss_vals = loss(data)
>>> print(f"SFT Loss: {loss_vals.loss_sft.item():.4f}")
>>> print(f"KL to Reference Loss: {loss_vals.loss_kl_to_ref.item():.4f}")

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 模块。此模块的参数将在 <module_name>_params 属性中隔离，而该模块的无状态版本将在 module_name 属性下注册。

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

• expand_dim (int, optional) –

  如果提供，则模块的参数

  将被展开 N 次，其中 N = expand_dim 沿第一个维度。当使用具有多个配置的目标网络时，可以使用此选项。

  注意

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

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

  参数副本，用于为 loss_module.<module_name>_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) → TensorDictBase

它旨在读取一个输入的 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 提供向后兼容性保证；其他对象的序列化 pickle 形式如果发生更改，可能会破坏向后兼容性。

返回:

要存储在模块 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_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 – 如果沿目标字符串路径的任何位置，(子)路径解析为一个不存在的属性名或一个不是 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。

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

值函数构造函数。

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

参数:

• value_type (ValueEstimators) – 一个 ValueEstimators 枚举类型，指示要使用的价值函数。如果未提供，将使用存储在 default_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]]) → 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() 计算出输出后，将每次调用该钩子。

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

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

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

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

参数:

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

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

• with_kwargs (bool) – 如果为 True，则 hook 将接收传递给前向函数的 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() 之前，都会调用该钩子。

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

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

如果 with_kwargs 为 true，则前向预钩子将接收传递给前向函数的 kwargs，如果钩子修改了输入，则应同时返回 args 和 kwargs。钩子的签名应为

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 将在此 torch.nn.Module 的所有现有 forward_pre 钩子之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre 钩子将在通过此方法注册的所有钩子之前触发。默认为 False

• with_kwargs (bool) – 如果为 True，则 hook 将接收传递给前向函数的 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]], prepend: bool = False) → RemovableHandle

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

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

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

grad_input 和 grad_output 是包含输入和输出的梯度的元组。钩子不应修改其参数，但可以根据需要返回新的输入梯度，该梯度将在后续计算中替换 grad_input。 grad_input 将仅对应于作为位置参数给出的输入，所有关键字参数将被忽略。对于所有非 Tensor 参数，grad_input 和 grad_output 中的条目将为 None。

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

警告

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

参数:

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

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

返回:

一个句柄，可用于通过调用 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 之前触发。否则，提供的 hook 将在当前 torch.nn.Module 的所有现有 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在通过此方法注册的所有 hook 之前触发。

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

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

它应该具有以下签名：

hook(module, incompatible_keys) -> None

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

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

请注意，当使用 strict=True 调用 load_state_dict() 时执行的检查会受到 hook 对 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 or None) – 要添加到模块中的参数。如果为 None，则会忽略在参数上运行的操作，例如 cuda。如果为 None，则该参数 **不** 包含在模块的 state_dict 中。

register_state_dict_post_hook(hook)

为 state_dict() 方法注册一个后置 hook。

它应该具有以下签名：

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

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

register_state_dict_pre_hook(hook)

为 state_dict() 方法注册一个前置 hook。

它应该具有以下签名：

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 中的任何额外状态。如果需要存储额外状态，请为您模块实现此函数和相应的 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_c 和 linear。net_c 然后有一个子模块 conv。)

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

要向现有 net_b 模块添加新的 Conv2d 子模块，您可以调用 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) – 默认情况下，state_dict 中返回的 Tensors 将从 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()，但只接受浮点或复数 dtypes。此外，此方法只会将浮点或复数参数和缓冲区转换为 dtype（如果已提供）。整数参数和缓冲区将被移动到 device（如果已提供），但 dtype 保持不变。当设置 non_blocking 时，它会尝试在可能的情况下异步（相对于主机）进行转换/移动，例如将具有固定内存的 CPU Tensor 移动到 CUDA 设备。

有关示例，请参阅下文。

注意

此方法就地修改模块。

参数:

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

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

• tensor (torch.Tensor) – dtype 和设备与此模块中所有参数和缓冲区的目标 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) – 不设置为零，而是将梯度设置为 None。请参阅 torch.optim.Optimizer.zero_grad() 以获取详细信息。