MultiStepTransform

class torchrl.envs.transforms.rb_transforms.MultiStepTransform(n_steps, gamma, *, reward_keys: List[NestedKey] | None = None, done_key: NestedKey | None = None, done_keys: List[NestedKey] | None = None, mask_key: NestedKey | None = None)

ReplayBuffer 的多步转换。

此转换在本地缓冲区中保留之前的 n_steps 个观测值。逆转换（在 extend()期间调用）输出转换后的之前的 n_steps 和 T-n_steps 个当前帧。

输出 tensordict 中 "next" 中不属于 done_keys 或 reward_keys 的所有条目都将映射到它们各自的 t + n_steps - 1 对应项。

此转换是 MultiStep 的更具超参数鲁棒性的版本：回放缓冲区转换将使多步转换对收集器的超参数不敏感，而后处理版本将输出对这些超参数敏感的结果（因为收集器没有之前的输出的记忆）。

参数：

• n_steps (int) – 多步中的步数。步数可以通过更改此转换的 n_steps 属性来动态更改。

• gamma (float) – 折扣因子。

关键字参数：

• reward_keys (嵌套键列表, 可选) – 输入 tensordict 中的奖励键。这些键指示的奖励条目将在未来 n_steps 步内累积和折扣。相应的 <reward_key>_orig 条目将写入输出 tensordict 的 "next" 条目中，以跟踪奖励的原始值。默认为 ["reward"]。

• done_key (嵌套键, 可选) – 输入 tensordict 中的完成键，用于指示轨迹的结束。默认为 "done"。

• done_keys (嵌套键列表, 可选) – 输入 tensordict 中的结束键列表。这些键指示的所有条目都不会被转换修改。默认为 ["done", "truncated", "terminated"]。

• mask_key (嵌套键, 可选) – 输入 tensordict 中的掩码键。掩码表示输入 tensordict 中的有效帧，并且应该具有允许使用输入 tensordict 进行掩码的形状。默认为 "mask"。

示例

>>> from torchrl.envs import GymEnv, TransformedEnv, StepCounter, MultiStepTransform, SerialEnv
>>> from torchrl.data import ReplayBuffer, LazyTensorStorage
>>> rb = ReplayBuffer(
...     storage=LazyTensorStorage(100, ndim=2),
...     transform=MultiStepTransform(n_steps=3, gamma=0.95)
... )
>>> base_env = SerialEnv(2, lambda: GymEnv("CartPole"))
>>> env = TransformedEnv(base_env, StepCounter())
>>> _ = env.set_seed(0)
>>> _ = torch.manual_seed(0)
>>> tdreset = env.reset()
>>> for _ in range(100):
...     rollout = env.rollout(max_steps=50, break_when_any_done=False,
...         tensordict=tdreset, auto_reset=False)
...     indices = rb.extend(rollout)
...     tdreset = rollout[..., -1]["next"]
>>> print("step_count", rb[:]["step_count"][:, :5])
step_count tensor([[[ 9],
         [10],
         [11],
         [12],
         [13]],

        [[12],
         [13],
         [14],
         [15],
         [16]]])
>>> # The next step_count is 3 steps in the future
>>> print("next step_count", rb[:]["next", "step_count"][:, :5])
next step_count tensor([[[13],
         [14],
         [15],
         [16],
         [17]],

        [[16],
         [17],
         [18],
         [19],
         [20]]])

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

返回类型:

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

注意

此方法会就地修改模块。

返回:

self

返回类型:

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()。

property container

返回包含转换的环境。

示例

>>> from torchrl.envs import TransformedEnv, Compose, RewardSum, StepCounter
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = TransformedEnv(GymEnv("Pendulum-v1"), Compose(RewardSum(), StepCounter()))
>>> env.transform[0].container is env
True

cpu() → T

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

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

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

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

这还会使关联的参数和缓冲区成为不同的对象。因此，如果模块将在 GPU 上运行并进行优化，则应在构造优化器之前调用此方法。

注意

此方法会就地修改模块。

参数：

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

返回:

self

返回类型:

Module

double() → T

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

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

eval() → T

将模块设置为评估模式。

这仅对某些模块有效。有关特定模块在训练/评估模式下的行为详细信息（如果受影响），例如 Dropout、BatchNorm 等，请参阅其文档。

这等效于self.train(False)。

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

返回:

self

返回类型:

Module

extra_repr() → str

设置模块的额外表示。

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

float() → T

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

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

forward(tensordict: TensorDictBase) → TensorDictBase

读取输入 tensordict，并对选定的键应用转换。

get_buffer(target: str) → Tensor

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

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

参数：

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

返回:

由target引用的缓冲区

返回类型:

torch.Tensor

引发:

AttributeError – 如果目标字符串引用无效路径或解析为非缓冲区的内容

get_extra_state() → Any

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

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

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

返回:

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

返回类型:

object

get_parameter(target: str) → Parameter

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

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

参数：

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

返回:

由target引用的参数

返回类型:

torch.nn.Parameter

引发:

AttributeError – 如果目标字符串引用无效路径或解析为非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)，其中 N 是传递模块的数量。因此，对于简单的检查某个子模块是否存在的情况，应该始终使用 get_submodule。

参数：

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

返回:

由 target 引用的子模块

返回类型:

torch.nn.Module

引发:

AttributeError – 如果目标字符串引用无效路径或解析为非 nn.Module 的内容

half() → T

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

注意

此方法会就地修改模块。

返回:

self

返回类型:

Module

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

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

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

注意

此方法会就地修改模块。

参数：

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

返回:

self

返回类型:

Module

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) – 包含参数和持久缓冲区的字典。

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

• assign (bool, optional) – 当 False 时，保留当前模块中张量的属性，而当 True 时，保留状态字典中张量的属性。唯一的例外是 requires_grad 字段 Default: ``False`

返回:

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

  但此模块在提供的 state_dict 中缺少。

• unexpected_keys 是一个包含不属于的键的 str 列表

  此模块的预期，但存在于提供的 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) – 如果指定，则所有参数都将复制到该设备

返回:

self

返回类型:

Module

property n_steps

转换的前瞻窗口。

此值可以在训练期间动态编辑。

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

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

参数：

• prefix (str) – 用于在所有缓冲区名称前添加的前缀。

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

• remove_duplicate (bool, optional) – 是否删除结果中的重复缓冲区。默认为 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, 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)

property parent: Optional[EnvBase]

返回转换的父环境。

父环境是包含所有转换（直到当前转换）的环境。

示例

>>> from torchrl.envs import TransformedEnv, Compose, RewardSum, StepCounter
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = TransformedEnv(GymEnv("Pendulum-v1"), Compose(RewardSum(), StepCounter()))
>>> env.transform[1].parent
TransformedEnv(
    env=GymEnv(env=Pendulum-v1, batch_size=torch.Size([]), device=cpu),
    transform=Compose(
            RewardSum(keys=['reward'])))

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() 后调用的。钩子应具有以下签名

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.modules.Module 上所有现有的 forward 钩子之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上所有现有的 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在通过此方法注册的所有钩子之前触发。默认值：False

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

• always_call (bool) – 如果为 True，则无论在调用模块时是否引发异常，都会运行 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.modules.Module 上所有现有的 forward_pre 钩子之前触发。否则，提供的 hook 将在该 torch.nn.modules.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[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 中的条目将为 None。

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

警告

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

参数：

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

• **prepend** (bool) – 如果为真，则提供的 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 中的条目将为 None。

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

警告

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

参数：

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

• **prepend** (bool) – 如果为真，则提供的 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 是一个包含缺失键的 list，unexpected_keys 是一个包含意外键的 list。

如果需要，可以就地修改给定的 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

返回类型:

Module

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_b 本身又包含两个子模块 net_c 和 linear。 net_c 接着包含一个子模块 conv。)

要使用新的子模块 Linear 覆盖 Conv2d，您将调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数：

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

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

引发:

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

• AttributeError – 如果目标字符串引用无效路径或解析为非 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 与自动梯度分离。如果将其设置为 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（如果给出），但数据类型保持不变。当设置 non_blocking 时，如果可能，它会尝试异步地转换/移动主机，例如，将具有固定内存的 CPU 张量移动到 CUDA 设备。

请参见下面的示例。

注意

此方法会就地修改模块。

参数：

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

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

• **tensor** (torch.Tensor) – 张量，其数据类型和设备是此模块中所有参数和缓冲区的目标数据类型和设备

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

返回:

self

返回类型:

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[device, str, int]], recurse: bool = True) → T

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

参数：

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

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

返回:

self

返回类型:

Module

train(mode: bool = True) → T

将模块设置为训练模式。

这仅对某些模块有效。有关特定模块在训练/评估模式下的行为详细信息（如果受影响），例如 Dropout、BatchNorm 等，请参阅其文档。

参数：

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

返回:

self

返回类型:

Module

transform_done_spec(done_spec: TensorSpec) → TensorSpec

转换 done 规范，使结果规范与转换映射匹配。

参数：

**done_spec** (TensorSpec) – 转换前的规范

返回:

转换后的预期规范

transform_env_batch_size(batch_size: Size)

转换父环境的批大小。

transform_env_device(device: device)

转换父环境的设备。

transform_input_spec(input_spec: TensorSpec) → TensorSpec

转换输入规范，使结果规范与转换映射匹配。

参数：

**input_spec** (TensorSpec) – 转换前的规范

返回:

转换后的预期规范

transform_observation_spec(observation_spec: TensorSpec) → TensorSpec

转换观察规范，使结果规范与转换映射匹配。

参数：

**observation_spec** (TensorSpec) – 转换前的规范

返回:

转换后的预期规范

transform_output_spec(output_spec: CompositeSpec) → CompositeSpec

转换输出规范，使结果规范与转换映射匹配。

此方法通常应保持不变。更改应使用 transform_observation_spec()、transform_reward_spec() 和 transformfull_done_spec() 实现。:param output_spec: 转换前的规范 :type output_spec: TensorSpec

返回:

转换后的预期规范

transform_reward_spec(reward_spec: TensorSpec) → TensorSpec

转换奖励规范，使结果规范与转换映射匹配。

参数：

**reward_spec** (TensorSpec) – 转换前的规范

返回:

转换后的预期规范

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

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

注意

此方法会就地修改模块。

参数：

**dst_type** (type 或 string) – 目标类型

返回:

self

返回类型:

Module

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

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

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

注意

此方法会就地修改模块。

参数：

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

返回:

self

返回类型:

Module

zero_grad(set_to_none: bool = True) → None

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

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

参数：

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