BinaryToDecimal

类 torchrl.data.BinaryToDecimal(num_bits: int, device: device, dtype: dtype, convert_to_binary: bool = False)

一个用于将二进制编码张量转换为十进制的模块。

这是一个工具类，可以将二进制编码张量（例如 1001）转换为其十进制值（例如 9）。

参数：

• num_bits (int) – 用于基数表的位数。位数必须小于或等于输入长度，并且输入长度必须能被 num_bits 整除。如果 num_bits 小于输入中的位数，最终结果将使用 sum() 在最后一个维度上进行聚合。

• device (torch.device) – 期望输入和输出所在的设备。

• dtype (torch.dtype) – 输出的数据类型。

• convert_to_binary (bool, optional) – 如果为 True，则传递给 forward 方法的输入将使用 heavyside() 被转换为二进制输入。默认为 False。

示例

>>> binary_to_decimal = BinaryToDecimal(
...    num_bits=4, device="cpu", dtype=torch.int32, convert_to_binary=True
... )
>>> binary = torch.Tensor([[0, 0, 1, 0, 0, 0, 0, 1], [0, 0, 0, 0, 0, 0, 10, 0]])
>>> decimal = binary_to_decimal(binary)
>>> assert decimal.shape == (2,)
>>> assert (decimal == torch.Tensor([3, 2])).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) – 要应用于每个子模块的函数

返回：

自身

返回类型：

模块

示例

>>> @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]

返回一个遍历直接子模块的迭代器。

生成：

模块 – 子模块

compile(*args, **kwargs)

使用 torch.compile() 编译此模块的 forward 方法。

此模块的 __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(features: Tensor) → Tensor

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

应由所有子类重写。

注意

虽然正向传播的逻辑需要在本函数中定义，但应该在之后调用 Module 实例而不是直接调用此函数，因为前者负责运行已注册的钩子，而后者会静默忽略它们。

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 中的任何额外状态

返回类型：

对象

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)。因此，对于检查某个子模块是否存在这种简单情况，应始终使用 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，则除非 get_swap_module_params_on_conversion() 为 True，否则必须在调用 load_state_dict 之后创建优化器。

参数：

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

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

• assign (bool, optional) – 设置为 False 时，将保留当前模块中张量的属性，而设置为 True 时，将保留 state dict 中张量的属性。唯一的例外是 requires_grad 字段。

返回：

• missing_keys 是一个 str 列表，包含此模块期望但缺失的任何键。

  （在提供的 state_dict 中缺失）。

• unexpected_keys 是一个 str 列表，包含此模块不期望但存在的键

  （在提供的 state_dict 中存在）。

返回类型：

带有 missing_keys 和 unexpected_keys 字段的 NamedTuple

注意

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

modules() → 迭代器[模块]

返回网络中所有模块的迭代器。

生成：

模块 – 网络中的一个模块

注意

重复的模块仅返回一次。在以下示例中，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: 可选[联合[整型, device]] = None) → T

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

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

注意

此方法就地修改模块。

参数：

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

返回：

自身

返回类型：

模块

named_buffers(prefix: 字符串 = '', recurse: 布尔值 = True, remove_duplicate: 布尔值 = True) → 迭代器[元组[字符串, 张量]]

返回模块缓冲区的迭代器，生成缓冲区名称及其本身。

参数：

• prefix (`字符串`) – 加在所有缓冲区名称前面的前缀。

• recurse (`布尔值`，*可选*) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，仅生成直接属于此模块的缓冲区。默认为 True。

• remove_duplicate (`布尔值`，*可选*) – 是否删除结果中的重复缓冲区。默认为 True。

生成：

(`字符串`, `torch.张量`) – 包含名称和缓冲区的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children() → 迭代器[元组[字符串, 模块]]

返回直接子模块的迭代器，生成模块名称及其本身。

生成：

(`字符串`, 模块) – 包含名称和子模块的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo: 可选[集合[模块]] = None, prefix: 字符串 = '', remove_duplicate: 布尔值 = True)

返回网络中所有模块的迭代器，生成模块名称及其本身。

参数：

• memo – 用于存储已添加到结果中的模块集合的备忘录。

• prefix – 将添加到模块名称中的前缀。

• remove_duplicate – 是否移除结果中的重复模块实例。

生成：

(`字符串`, 模块) – 包含名称和模块的元组。

注意

重复的模块仅返回一次。在以下示例中，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: 字符串 = '', recurse: 布尔值 = True, remove_duplicate: 布尔值 = True) → 迭代器[元组[字符串, 参数]]

返回模块参数的迭代器，生成参数名称及其本身。

参数：

• prefix (`字符串`) – 加在所有参数名称前面的前缀。

• recurse (`布尔值`) – 如果为 True，则生成此模块和所有子模块的参数。否则，仅生成直接属于此模块的参数。

• remove_duplicate (`布尔值`，*可选*) – 是否移除结果中的重复参数。默认为 True。

生成：

(`字符串`, 参数) – 包含名称和参数的元组。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

parameters(recurse: 布尔值 = True) → 迭代器[参数]

返回模块参数的迭代器。

这通常会传递给优化器。

参数：

recurse (`布尔值`) – 如果为 True，则生成此模块和所有子模块的参数。否则，仅生成直接属于此模块的参数。

生成：

参数 – 模块参数。

示例

>>> # 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: 可调用对象[[模块, 联合[元组[张量, ...], 张量], 联合[元组[张量, ...], 张量], 联合[None, 元组[张量, ...], 张量]]) → 可移除句柄

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

此函数已被弃用，推荐使用 register_full_backward_hook()。此函数的行为将在未来版本中更改。

返回：

一个句柄，可以通过调用 handle.remove() 来移除已添加的 hook。

返回类型：

torch.utils.hooks.可移除句柄

register_buffer(name: 字符串, tensor: 可选[张量], persistent: 布尔值 = True) → None

向模块添加一个缓冲区。

这通常用于注册不应被视为模型参数的缓冲区。例如，BatchNorm 的 running_mean 不是参数，但属于模块状态的一部分。缓冲区默认是持久的，并且会与参数一起保存。通过将 persistent 设置为 False 可以更改此行为。持久缓冲区和非持久缓冲区之间的唯一区别在于，后者不会成为此模块的 state_dict 的一部分。

可以使用给定名称作为属性访问缓冲区。

参数：

• name (`字符串`) – 缓冲区的名称。可以使用给定名称从此模块访问缓冲区。

• tensor (`张量` 或 `None`) – 要注册的缓冲区。如果为 None，则运行在缓冲区上的操作（例如 cuda）将被忽略。如果为 None，则缓冲区将**不**包含在模块的 state_dict 中。

• persistent (`布尔值`) – 缓冲区是否为此模块的 state_dict 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook: 联合[可调用对象[[T, 元组[任意类型, ...], 任意类型], 可选[任意类型]], 可调用对象[[T, 元组[任意类型, ...], 字典[字符串, 任意类型], 任意类型], 可选[任意类型]]], *, prepend: 布尔值 = False, with_kwargs: 布尔值 = False, always_call: 布尔值 = False) → 可移除句柄

在模块上注册一个前向传播 hook。

在每次 forward() 计算出输出后，都会调用此 hook。

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

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

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

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

参数：

• hook (`可调用对象`) – 要注册的用户定义 hook。

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

• with_kwargs (`布尔值`) – 如果为 True，则会向 hook 传递给 forward 函数的 kwargs。默认值：False。

• always_call (`布尔值`) – 如果为 True，则无论调用 Module 时是否引发异常，都将运行 hook。默认值：False。

返回：

一个句柄，可以通过调用 handle.remove() 来移除已添加的 hook。

返回类型：

torch.utils.hooks.可移除句柄

register_forward_pre_hook(hook: 联合[可调用对象[[T, 元组[任意类型, ...]], 可选[任意类型]], 可调用对象[[T, 元组[任意类型, ...], 字典[字符串, 任意类型]], 可选[元组[任意类型, 字典[字符串, 任意类型]]]]], *, prepend: 布尔值 = False, with_kwargs: 布尔值 = False) → 可移除句柄

在模块上注册一个前向传播预 hook。

在每次调用 forward() 之前，都会调用此 hook。

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

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

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

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

参数：

• hook (`可调用对象`) – 要注册的用户定义 hook。

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

• with_kwargs (`布尔值`) – 如果为 true，则会向 hook 传递给 forward 函数的 kwargs。默认值：False。

返回：

一个句柄，可以通过调用 handle.remove() 来移除已添加的 hook。

返回类型：

torch.utils.hooks.可移除句柄

register_full_backward_hook(hook: 可调用对象[[模块, 联合[元组[张量, ...], 张量], 联合[元组[张量, ...], 张量], 联合[None, 元组[张量, ...], 张量]], prepend: 布尔值 = False) → 可移除句柄

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

每当计算相对于模块的梯度时，都会调用此 hook；也就是说，仅当计算相对于模块输出的梯度时，此 hook 才会执行。hook 应具有以下签名：

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

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

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

警告

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

参数：

• hook (`可调用对象`) – 要注册的用户定义 hook。

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

返回：

一个句柄，可以通过调用 handle.remove() 来移除已添加的 hook。

返回类型：

torch.utils.hooks.可移除句柄

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 应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图（view）。类似地，调用者将接收 Module 的 forward 函数返回的每个 Tensor 的视图（view）。

警告

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

参数：

• hook (`可调用对象`) – 要注册的用户定义 hook。

• 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() 来移除已添加的 hook。

返回类型：

torch.utils.hooks.可移除句柄

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。

请注意，在 `strict=True` 模式下调用 load_state_dict() 时执行的检查会受到钩子对 missing_keys 或 unexpected_keys 的修改的影响，这符合预期。向任一键集添加内容都会在 strict=True 时导致错误，而清除所有缺失键和意外键则可以避免错误。

返回：

一个句柄，可以通过调用 handle.remove() 来移除已添加的 hook。

返回类型：

torch.utils.hooks.可移除句柄

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。

返回：

自身

返回类型：

模块

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。）

要将 Conv2d 替换为新的子模块 Linear，可以调用 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 会从 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 张量移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法就地修改模块。

参数：

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

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

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

• memory_format (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[int, str, device]], 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 (type or string) – 期望的类型。

返回：

自身

返回类型：

模块

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