MultiStep

class torchrl.data.MultiStep(gamma: float, n_steps: int)

多步奖励转换。

介绍于

Sutton, R. S. 1988. 学习通过时间差分方法进行预测。机器学习 3(1):9–44。

此模块将“下一个”观察映射到 t + n“下一个”观察。当n_steps 为 0 时，它是一个恒等转换。

参数：

• gamma (float) – 返回计算的折扣因子

• n_steps (integer) – 最大前瞻步数。

注意

此类旨在在 DataCollector 中使用。它只会处理在收集结束时传递给它的数据，并忽略在此收集之前或在下一批中传入的数据。因此，批次最后几步的结果可能会因轨迹的早期截断而产生偏差。为了减轻这种影响，请改在回放缓冲区中使用 MultiStepTransform。

示例

>>> from torchrl.collectors import SyncDataCollector, RandomPolicy
>>> from torchrl.data.postprocs import MultiStep
>>> from torchrl.envs import GymEnv, TransformedEnv, StepCounter
>>> env = TransformedEnv(GymEnv("CartPole-v1"), StepCounter())
>>> env.set_seed(0)
>>> collector = SyncDataCollector(env, policy=RandomPolicy(env.action_spec),
...     frames_per_batch=10, total_frames=2000, postproc=MultiStep(n_steps=4, gamma=0.99))
>>> for data in collector:
...     break
>>> print(data["step_count"])
tensor([[0],
        [1],
        [2],
        [3],
        [4],
        [5],
        [6],
        [7],
        [8],
        [9]])
>>> # the next step count is shifted by 3 steps in the future
>>> print(data["next", "step_count"])
tensor([[ 5],
        [ 6],
        [ 7],
        [ 8],
        [ 9],
        [10],
        [10],
        [10],
        [10],
        [10]])

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

返回值：

自身

返回类型：

模块

示例

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

注意

此方法就地修改模块。

返回值：

自身

返回类型：

模块

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。

注意

此方法就地修改模块。

返回值：

自身

返回类型：

模块

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

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

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

注意

此方法就地修改模块。

参数：

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

返回值：

自身

返回类型：

模块

double() → T

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

注意

此方法就地修改模块。

返回值：

自身

返回类型：

模块

eval() → T

将模块设置为评估模式。

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

这等效于self.train(False)。

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

返回值：

自身

返回类型：

模块

extra_repr() → str

设置模块的额外表示。

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

float() → T

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

注意

此方法就地修改模块。

返回值：

自身

返回类型：

模块

forward(tensordict: TensorDictBase) → TensorDictBase

根据多步变换重写张量字典。

参数：

tensordict –

tensordict.TensorDictBase实例，具有[*Batch x Time-steps] shape。 TensorDict 必须 包含 a ``("next", "reward")和("next", "done")键。嵌套在“next”中的所有键都将最多移动n_steps帧。TensorDict也将更新新的键值对

• gamma：指示用于下一个奖励的折扣；

• nonterminal：布尔值，指示步骤是否是非终端步骤（未完成或不是轨迹的最后一步）；

• original_reward：环境中收集到的先前奖励（即多步之前）；

• “reward”值将被新计算的奖励替换。

“done”键可以具有tensordict的形状，也可以具有tensordict后跟单一维度的形状，或者具有tensordict后跟其他维度的形状。在后一种情况下，tensordict *必须*与遵循done形状的重塑兼容（即，它包含的每个张量的开头维度必须与“done”条目的形状匹配）。“reward”张量可以具有tensordict（或done状态）的形状，也可以具有该形状后跟单一维度的形状。

返回值：

输入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()时会调用此函数。

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

返回值：

要存储在模块的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_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 数据类型。

注意

此方法就地修改模块。

返回值：

自身

返回类型：

模块

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

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

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

注意

此方法就地修改模块。

参数：

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

返回值：

自身

返回类型：

模块

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

返回值：

自身

返回类型：

模块

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)

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，则前向钩子将传递给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，则无论在调用模块时是否引发异常，都会运行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 中的条目将为 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 参数是一个包含属性 missing_keys 和 unexpected_keys 的 NamedTuple。 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。

返回值：

自身

返回类型：

模块

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, 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 设备。

有关示例，请参见下文。

注意

此方法就地修改模块。

参数：

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

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

• 张量 (torch.Tensor) – 数据类型和设备分别为此模块中所有参数和缓冲区的目标数据类型和设备的张量

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

返回值：

自身

返回类型：

模块

示例

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

返回值：

自身

返回类型：

模块

train(mode: bool = True) → T

将模块设置为训练模式。

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

参数：

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

返回值：

自身

返回类型：

模块

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

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

注意

此方法就地修改模块。

参数：

dst_type (类型 或 字符串) – 目标类型

返回值：

自身

返回类型：

模块

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

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

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

注意

此方法就地修改模块。

参数：

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

返回值：

自身

返回类型：

模块

zero_grad(set_to_none: bool = True) → None

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

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

参数：

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