TensorDictMap

class torchrl.data.TensorDictMap(*args, **kwargs)

TensorDict 的映射存储。

此模块类似于存储。它接受 tensordict 作为输入，并返回另一个 tensordict 作为输出，类似于 TensorDictModuleBase。然而，它提供了额外的功能，例如 Python 映射。

关键词参数：

• query_module (TensorDictModuleBase) – 一个查询模块，通常是 QueryModule 的实例，用于将一组 tensordict 条目映射到哈希键。

• storage (Dict[NestedKey, TensorMap[torch.Tensor, torch.Tensor]]) – 一个字典，表示从索引键到张量存储的映射。

• collate_fn (callable, optional) – 一个函数，用于从存储中整理（collate）样本。对于每种已知的存储类型，默认值不同（ListStorage 为 stack，TensorStorage 子类型及其他为 identity）。

示例

>>> import torch
>>> from tensordict import TensorDict
>>> from typing import cast
>>> from torchrl.data import LazyTensorStorage
>>> query_module = QueryModule(
...     in_keys=["key1", "key2"],
...     index_key="index",
... )
>>> embedding_storage = LazyTensorStorage(1000)
>>> tensor_dict_storage = TensorDictMap(
...     query_module=query_module,
...     storage={"out": embedding_storage},
... )
>>> index = TensorDict(
...     {
...         "key1": torch.Tensor([[-1], [1], [3], [-3]]),
...         "key2": torch.Tensor([[0], [2], [4], [-4]]),
...     },
...     batch_size=(4,),
... )
>>> value = TensorDict(
...     {"out": torch.Tensor([[10], [20], [30], [40]])}, batch_size=(4,)
... )
>>> tensor_dict_storage[index] = value
>>> tensor_dict_storage[index]
TensorDict(
    fields={
        out: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([4]),
    device=None,
    is_shared=False)
>>> assert torch.sum(tensor_dict_storage.contains(index)).item() == 4
>>> new_index = index.clone(True)
>>> new_index["key3"] = torch.Tensor([[4], [5], [6], [7]])
>>> retrieve_value = tensor_dict_storage[new_index]
>>> assert cast(torch.Tensor, retrieve_value["index"] == value["index"]).all()

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) – 要应用于每个子模块的函数

返回：

自身

返回类型：

Module

示例

>>> @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 数据类型。

注意

此方法会就地修改模块。

返回：

自身

返回类型：

Module

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

返回一个遍历模块缓冲区的迭代器。

参数：

recurse (bool) – 如果为 True，则生成此模块及其所有子模块的缓冲区。否则，仅生成直接属于此模块的缓冲区。

生成：

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() 编译此模块的前向传播。

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

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

cpu() → T

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

注意

此方法会就地修改模块。

返回：

自身

返回类型：

Module

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

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

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

注意

此方法会就地修改模块。

参数：

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

返回：

自身

返回类型：

Module

double() → T

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

注意

此方法会就地修改模块。

返回：

自身

返回类型：

Module

eval() → T

将模块设置为评估模式。

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

这等同于 self.train(False)。

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

返回：

自身

返回类型：

Module

extra_repr() → str

返回模块的额外表示。

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

float() → T

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

注意

此方法会就地修改模块。

返回：

自身

返回类型：

Module

forward(*input: Any) → None

定义每次调用时执行的计算。

应被所有子类覆盖（override）。

注意

虽然需要在函数内定义前向传播（forward pass）的实现，但之后应该调用 Module 实例而不是直接调用此方法，因为前者负责运行已注册的钩子（hooks），而后者则会静默忽略它们。

classmethod from_tensordict_pair(source, dest, in_keys: List[NestedKey], out_keys: List[NestedKey] | None = None, max_size: int = 1000, storage_constructor: type | None = None, hash_module: Callable | None = None, collate_fn: Callable[[Any], Any] | None = None, write_fn: Callable[[Any, Any], Any] | None = None, consolidated: bool | None = None) → TensorDictMap

使用预定义的经验法则，从一对 tensordict（source 和 dest）创建一个新的 TensorDictStorage。

参数：

• source (TensorDict) – source tensordict 的示例，用作存储中的索引。

• dest (TensorDict) – dest tensordict 的示例，用作存储中的数据。

• in_keys (List[NestedKey]) – 在映射中使用的键列表。

• out_keys (List[NestedKey]) – 在输出 tensordict 中返回的键列表。out_keys 中不存在的键，即使存在于 dest 中，也不会存储在存储中。默认为 None（所有键都注册）。

• max_size (int, optional) – 存储中的最大元素数量。如果传递了 storage_constructor 则忽略。默认为 1000。

• storage_constructor (Type, optional) – 张量存储的类型。默认为 LazyDynamicStorage。其他选项包括 FixedStorage。

• hash_module (Callable, optional) – 在 QueryModule 中使用的哈希函数。对于低维输入，默认为 SipHash，对于较大输入，默认为 RandomProjectionHash。

• collate_fn (callable, optional) – 一个函数，用于从存储中整理（collate）样本。对于每种已知的存储类型，默认值不同（ListStorage 为 stack，TensorStorage 子类型及其他为 identity）。

• consolidated (bool, optional) – 是否将存储合并到一个单独的存储张量中。默认为 False。

示例

>>> # The following example requires torchrl and gymnasium to be installed
>>> from torchrl.envs import GymEnv
>>> torch.manual_seed(0)
>>> env = GymEnv("CartPole-v1")
>>> env.set_seed(0)
>>> rollout = env.rollout(100)
>>> source, dest = rollout.exclude("next"), rollout.get("next")
>>> storage = TensorDictMap.from_tensordict_pair(
...     source, dest,
...     in_keys=["observation", "action"],
... )
>>> # maps the (obs, action) tuple to a corresponding next state
>>> storage[source] = dest
>>> print(source["_index"])
tensor([ 0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13])
>>> storage[source]
TensorDict(
    fields={
        done: Tensor(shape=torch.Size([14, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        observation: Tensor(shape=torch.Size([14, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        reward: Tensor(shape=torch.Size([14, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([14, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([14, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([14]),
    device=None,
    is_shared=False)

get_buffer(target: str) → Tensor

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

有关此方法的更多功能详情以及如何正确指定 target，请参见 get_submodule 的文档字符串。

参数：

target – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参见 get_submodule。）

返回：

由 target 引用的缓冲区

返回类型：

torch.Tensor

引发：

AttributeError – 如果 target 字符串引用了无效路径或解析到的对象不是缓冲区。

get_extra_state() → Any

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

如果您需要存储额外状态，请为您自己的模块实现此方法以及相应的 set_extra_state()。构建模块 state_dict() 时会调用此函数。

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

返回：

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

返回类型：

object

get_parameter(target: str) → Parameter

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

有关此方法的更多功能详情以及如何正确指定 target，请参见 get_submodule 的文档字符串。

参数：

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

返回：

由 target 引用的 Parameter

返回类型：

torch.nn.Parameter

引发：

AttributeError – 如果 target 字符串引用了无效路径或解析到的对象不是 nn.Parameter。

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) 时间复杂度。因此，对于检查某个子模块是否存在这样的简单操作，应始终使用 get_submodule。

参数：

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

返回：

由 target 引用的子模块

返回类型：

torch.nn.Module

引发：

AttributeError – 如果 target 字符串引用了无效路径或解析到的对象不是 nn.Module。

half() → T

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

注意

此方法会就地修改模块。

返回：

自身

返回类型：

Module

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

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

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

注意

此方法会就地修改模块。

参数：

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

返回：

自身

返回类型：

Module

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，则除非 get_swap_module_params_on_conversion() 为 True，否则必须在调用 load_state_dict 后创建优化器。

参数：

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

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

• assign (bool, 可选) – 当设置为 False 时，当前模块中张量的属性将被保留；而设置为 True 时，则保留状态字典中张量的属性。唯一的例外是 requires_grad 字段。 默认值： ``False`

返回：

• missing_keys 是一个字符串列表，包含此模块预期

  但提供的 state_dict 中缺失的所有键。

• unexpected_keys 是一个字符串列表，包含此模块不

  预期但提供的 state_dict 中存在的所有键。

返回类型：

NamedTuple，包含 missing_keys 和 unexpected_keys 字段。

注意

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

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) – 如果指定，所有参数将被复制到该设备

返回：

自身

返回类型：

Module

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

返回一个遍历模块缓冲区的迭代器，同时返回缓冲区的名称及其本身。

参数：

• prefix (str) – 要前置到所有缓冲区名称的前缀。

• recurse (bool, 可选) – 如果为 True，则返回此模块及其所有子模块的缓冲区。否则，仅返回此模块的直接成员缓冲区。默认为 True。

• remove_duplicate (bool, 可选) – 是否移除结果中重复的缓冲区。默认为 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 – 用于存储已添加到结果中的模块集合的备忘录。

• 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, remove_duplicate: bool = True) → Iterator[Tuple[str, Parameter]]

返回一个遍历模块参数的迭代器，同时返回参数的名称及其本身。

参数：

• prefix (str) – 要前置到所有参数名称的前缀。

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

• remove_duplicate (bool, 可选) – 是否移除结果中重复的参数。默认为 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[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[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) – 缓冲区的名称。可以使用给定名称从此模块访问缓冲区。

• 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() 之后调用的，因此不会影响 forward。钩子应具有以下签名：

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

如果 with_kwargs 为 True，前向传播钩子将被传递给 forward 函数的 kwargs，并期望返回可能已修改的输出。钩子应具有以下签名：

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

参数：

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

• prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在此方法注册的所有钩子之前触发。默认值：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() 之前，都会调用此钩子。

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

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

如果 with_kwargs 为 true，前向传播预钩子将被传递给 forward 函数的 kwargs。如果钩子修改输入，则应返回 args 和 kwargs。钩子应具有以下签名：

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

参数：

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

• prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward_pre 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 forward_pre 钩子之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre 钩子将在此方法注册的所有钩子之前触发。默认值：False

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

返回：

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

返回类型：

torch.utils.hooks.RemovableHandle

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

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

每次计算相对于模块的梯度时，都会调用此钩子，即仅当计算相对于模块输出的梯度时，钩子才会执行。钩子应具有以下签名：

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

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

出于技术原因，当此钩子应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。类似地，调用者将接收 Module 的 forward 函数返回的每个 Tensor 的视图。

警告

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

参数：

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

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

返回：

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

返回类型：

torch.utils.hooks.RemovableHandle

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

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

每次计算模块的梯度时都会调用此钩子。该钩子应具有以下签名：

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

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

出于技术原因，当此钩子应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。类似地，调用者将接收 Module 的 forward 函数返回的每个 Tensor 的视图。

警告

使用反向钩子时不允许原地（inplace）修改输入，否则会引发错误。

参数：

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

• prepend (bool) – 如果为 True，提供的 hook 将在此 torch.nn.modules.Module 上所有现有 backward_pre 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.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 是一个包含缺失键的 str list，unexpected_keys 是一个包含意外键的 str list。

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

请注意，当调用 load_state_dict() 并设置 strict=True 时执行的检查会受到钩子对 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(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

更改 Autograd 是否应该记录此模块中参数上的操作。

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

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

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

参数：

requires_grad (bool) – Autograd 是否应记录此模块中参数上的操作。默认值: True。

返回：

自身

返回类型：

Module

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(parameters: Optional[TensorDictBase] = None) → Optional[TensorDictBase]

递归重置模块及其子模块的参数。

参数：

parameters (TensorDict of parameters, optional) – 如果设置为 None，模块将使用 self.parameters() 进行重置。否则，我们将原地重置 tensordict 中的参数。这对于参数不存储在模块本身中的函数式模块（functional modules）非常有用。

返回：

新的参数 tensordict，仅当 parameters 不为 None 时返回。

示例

>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> net = nn.Sequential(nn.Linear(2,3), nn.ReLU())
>>> old_param = net[0].weight.clone()
>>> module = TensorDictModule(net, in_keys=['bork'], out_keys=['dork'])
>>> module.reset_parameters()
>>> (old_param == net[0].weight).any()
tensor(False)

此方法还支持函数式参数采样（functional parameter sampling）

>>> from tensordict import TensorDict
>>> from tensordict.nn import TensorDictModule
>>> from torch import nn
>>> net = nn.Sequential(nn.Linear(2,3), nn.ReLU())
>>> module = TensorDictModule(net, in_keys=['bork'], out_keys=['dork'])
>>> params = TensorDict.from_module(module)
>>> old_params = params.clone(recurse=True)
>>> module.reset_parameters(params)
>>> (old_params == params).any()
False

select_out_keys(*out_keys) → TensorDictModuleBase

选择将包含在输出 tensordict 中的键。

当需要清除复杂图中的中间键，或者当这些键的存在可能引发意外行为时，此功能非常有用。

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

参数：

*out_keys (a sequence of strings or tuples of strings) – 应包含在输出 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)

此功能也适用于分派的参数 (dispatched arguments)：.. 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_submodule(target: str, module: Module) → None

设置由 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 覆盖 Conv2d，你可以调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数：

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

• module – 要将子模块设置为的模块。

引发：

• ValueError – 如果目标字符串为空

• 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) – 添加到参数和缓冲区名称前缀，用于构成 state_dict 中的键。默认值: ''。

• keep_vars (bool, optional) – 默认情况下，state dict 中返回的 Tensor 与 autograd 分离（detached）。如果设置为 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 后，如果可能，会尝试相对于主机异步进行转换/移动，例如，将具有固定内存（pinned memory）的 CPU 张量移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法会就地修改模块。

参数：

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

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

• tensor (torch.Tensor) – 一个张量，其 dtype 和 device 是此模块中所有参数和缓冲区的目标 dtype 和 device。

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

返回：

自身

返回类型：

Module

示例

>>> # 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) – 子模块的参数和缓冲区是否应递归移动到指定设备。

返回：

自身

返回类型：

Module

train(mode: bool = True) → T

将模块设置为训练模式。

此操作仅对某些模块有效。有关它们在训练/评估模式下的行为细节，即它们是否受到影响，请参阅特定模块的文档，例如 Dropout、BatchNorm 等。

参数：

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

返回：

自身

返回类型：

Module

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

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

注意

此方法会就地修改模块。

参数：

dst_type (type or string) – 目标类型

返回：

自身

返回类型：

Module

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

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

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

注意

此方法会就地修改模块。

参数：

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

返回：

自身

返回类型：

Module

zero_grad(set_to_none: bool = True) → None

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

更多上下文，请参阅 torch.optim.Optimizer 下的类似函数。

参数：

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