MultiStepTransform

类 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 的 MultiStep 转换。

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

"next" tensordict 中所有不属于 done_keys 或 reward_keys 的条目将被映射到其对应的 t + n_steps - 1 条目。

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

参数:

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

• gamma (float) – 折扣因子。

关键字参数:

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

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

• done_keys (list of NestedKey, 可选) – 输入 tensordict 中的结束键列表。由这些键指示的所有条目将不会被转换触动。默认为 ["done", "truncated", "terminated"]。

• mask_key (NestedKey, 可选) – 输入 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) – 应用于每个子模块的函数。

返回值:

自身

返回类型:

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() 编译此模块的 forward 方法。

此模块的 __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。

注意

此方法会就地修改模块。

返回值:

自身

返回类型:

Module

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

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

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

注意

此方法会就地修改模块。

参数:

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

返回值:

自身

返回类型:

Module

double() → T

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

注意

此方法会就地修改模块。

返回值:

自身

返回类型:

Module

eval() → T

将模块设置为评估模式。

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

这等同于调用 self.train(False)。

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

返回值:

自身

返回类型:

Module

extra_repr() → str

返回模块的额外表示。

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

float() → T

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

注意

此方法会就地修改模块。

返回值:

自身

返回类型:

Module

forward(tensordict: TensorDictBase = None) → 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() 时调用。

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

返回值:

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

返回类型:

object

get_parameter(target: str) → Parameter

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

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

参数:

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

返回值:

由 target 引用的 Parameter。

返回类型:

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_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 – 如果目标字符串引用了无效路径或解析为非 nn.Module 的内容。

half() → T

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

注意

此方法会就地修改模块。

返回值:

自身

返回类型:

Module

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

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

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

注意

此方法会就地修改模块。

参数:

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

返回值:

自身

返回类型:

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 时将保留 state dict 中张量的属性。唯一的例外是 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, 可选) – 如果指定，所有参数将被复制到该设备。

返回值:

自身

返回类型:

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]

返回转换的父环境（env）。

父环境是包含从开始直到当前转换的所有转换的环境。

示例

>>> 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，因为此钩子是在 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，钩子将接收传递给 forward 函数的 kwargs。默认值： False

• always_call (bool) – 如果为 True，无论调用模块时是否抛出异常，钩子都将运行。默认值： 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 钩子将在通过此方法注册的所有 forward_pre 钩子之前触发。默认值： False

• with_kwargs (bool) – 如果为 True，钩子将接收传递给 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 的视图。

警告

使用 backward 钩子时，不允许原位修改输入或输出，否则会引发错误。

参数:

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

• prepend (bool) – 如果为 true，则提供的 hook 将在该 torch.nn.modules.Module 上所有现有 backward 钩子之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上所有现有 backward 钩子之后触发。请注意，使用 register_module_full_backward_pre_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

在模块上注册一个 backward pre-hook。

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

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

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

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

警告

使用 backward 钩子时，不允许原位修改输入，否则会引发错误。

参数:

• 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 或 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 训练）。

请参阅 `Locally disabling gradient computation` 以比较 `.requires_grad_()` 与可能与之混淆的几种类似机制。

参数:

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

返回值:

自身

返回类型:

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_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, 可选) – 如果提供，模块的状态将更新到该字典中，并返回相同的对象。否则，将创建并返回一个 OrderedDict。默认值：None。

• prefix (str, 可选) – 添加到参数和缓冲区名称以组成 state_dict 中键的前缀。默认值：''。

• keep_vars (bool, 可选) – 默认情况下，state dict 中返回的 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) – 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

transform_action_spec(action_spec: TensorSpec) → TensorSpec

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

参数:

action_spec (TensorSpec) – 转换前的规范

返回值:

转换后预期的规范

transform_done_spec(done_spec: TensorSpec) → TensorSpec

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

参数:

done_spec (TensorSpec) – 转换前的规范

返回值:

转换后预期的规范

transform_env_batch_size(batch_size: Size)

转换父环境的 batch-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: Composite) → Composite

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

此方法通常应保持原样。更改应通过 transform_observation_spec()、transform_reward_spec() 和 transform_full_done_spec() 实现。 :param output_spec: 变换前的规范 :type output_spec: TensorSpec

返回值:

转换后预期的规范

transform_reward_spec(reward_spec: TensorSpec) → TensorSpec

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

参数:

reward_spec (TensorSpec) – 变换前的规范

返回值:

转换后预期的规范

transform_state_spec(state_spec: TensorSpec) → TensorSpec

根据变换映射转换状态规范，使结果规范与之匹配。

参数:

state_spec (TensorSpec) – 变换前的规范

返回值:

转换后预期的规范

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

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

注意

此方法会就地修改模块。

参数:

dst_type (type 或 string) – 目标类型

返回值:

自身

返回类型:

Module

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

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

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

注意

此方法会就地修改模块。

参数:

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

返回值:

自身

返回类型:

Module

zero_grad(set_to_none: bool = True) → None

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

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

参数:

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