模块

class torch.nn.Module(*args, **kwargs)

所有神经网络模块的基类。

您的模型也应继承此类别。

模块也可以包含其他模块，允许它们以树状结构嵌套。您可以将子模块作为常规属性进行分配

import torch.nn as nn
import torch.nn.functional as F

class Model(nn.Module):
    def __init__(self) -> None:
        super().__init__()
        self.conv1 = nn.Conv2d(1, 20, 5)
        self.conv2 = nn.Conv2d(20, 20, 5)

    def forward(self, x):
        x = F.relu(self.conv1(x))
        return F.relu(self.conv2(x))

以这种方式分配的子模块将被注册，并且在调用 to() 等方法时，它们的参数也将被转换。

注意

如上例所示，在子类中进行属性分配之前，必须调用父类的 __init__() 方法。

变量

training (bool) – 布尔值，表示此模块处于训练模式还是评估模式。

add_module(name, module)

向当前模块添加一个子模块。

可以使用给定的名称作为属性访问该模块。

参数

• name (str) – 子模块的名称。可以使用给定名称从当前模块访问该子模块

• module (Module) – 要添加到当前模块的子模块。

apply(fn)

递归地将函数 fn 应用于每个子模块（由 .children() 返回）以及自身。

典型用法包括初始化模型的参数（另请参阅 torch.nn.init）。

参数

fn (Module -> None) – 将应用于每个子模块的函数

返回

self

返回类型

模块

示例

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

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

注意

此方法会就地修改模块。

返回

self

返回类型

模块

buffers(recurse=True)

返回模块缓冲区的迭代器。

参数

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

Yields

torch.Tensor – 模块缓冲区

返回类型

Iterator[Tensor]

示例

>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

children()

返回直接子模块的迭代器。

Yields

Module – 一个子模块

返回类型

Iterator[Module]

compile(*args, **kwargs)

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

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

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

cpu()

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

注意

此方法会就地修改模块。

返回

self

返回类型

模块

cuda(device=None)

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

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

注意

此方法会就地修改模块。

参数

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

返回

self

返回类型

模块

double()

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

注意

此方法会就地修改模块。

返回

self

返回类型

模块

eval()

将模块设置为评估模式。

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

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

关于 .eval() 与其他几个可能与之混淆的机制的比较，请参阅 局部禁用梯度计算。

返回

self

返回类型

模块

extra_repr()

返回模块的额外表示。

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

返回类型

str

float()

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

注意

此方法会就地修改模块。

返回

self

返回类型

模块

forward(*input)

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

应由所有子类覆盖。

注意

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

get_buffer(target)

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

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

参数

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

返回

target 引用的缓冲区

返回类型

torch.Tensor

抛出

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

get_extra_state()

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

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

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

返回

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

返回类型

object

get_parameter(target)

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

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

参数

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

返回

target 引用的 Parameter

返回类型

torch.nn.Parameter

抛出

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

get_submodule(target)

返回由 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 (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上例。）

返回

target 引用的子模块

返回类型

torch.nn.Module

抛出

AttributeError – 如果目标字符串产生的路径上的任何一点（子路径）解析到不存在的属性名称或不是 nn.Module 实例的对象。

half()

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

注意

此方法会就地修改模块。

返回

self

返回类型

模块

ipu(device=None)

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

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

注意

此方法会就地修改模块。

参数

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

返回

self

返回类型

模块

load_state_dict(state_dict, strict=True, assign=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 是一个 str 列表，包含任何期望的键

  由此模块期望但提供的 state_dict 中缺失的键。

• unexpected_keys 是一个 str 列表，包含未被期望的键

  由此模块期望但却存在于提供的 state_dict 中的键。

返回类型

带有 missing_keys 和 unexpected_keys 字段的 NamedTuple

注意

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

modules()

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

Yields

Module – 网络中的一个模块

返回类型

Iterator[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=None)

将所有模型参数和 buffers 移动到 MTIA。

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

注意

此方法会就地修改模块。

参数

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

返回

self

返回类型

模块

named_buffers(prefix='', recurse=True, remove_duplicate=True)

返回模块 buffers 的迭代器，同时产生 buffer 的名称及其 buffer 本身。

参数

• prefix (str) – 添加到所有 buffer 名称前的字符串。

• recurse (bool, optional) – 如果为 True，则产生当前模块及其所有子模块的 buffers。否则，仅产生当前模块的直接成员 buffers。默认为 True。

• remove_duplicate (bool, optional) – 是否移除结果中的重复 buffers。默认为 True。

Yields

(str, torch.Tensor) – 包含名称和 buffer 的元组

返回类型

Iterator[tuple[str, torch.Tensor]]

示例

>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children()

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

Yields

(str, Module) – 包含名称和子模块的元组

返回类型

Iterator[tuple[str, ‘Module’]]

示例

>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo=None, prefix='', remove_duplicate=True)

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

参数

• memo (Optional[set['Module']]) – 一个备忘录，用于存储已添加到结果中的模块集合

• prefix (str) – 将添加到模块名称中的前缀

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

Yields

(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='', recurse=True, remove_duplicate=True)

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

参数

• prefix (str) – 添加到所有参数名称前的字符串。

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

• remove_duplicate (bool, optional) – 是否移除结果中的重复参数。默认为 True。

Yields

(str, Parameter) – 包含名称和参数的元组

返回类型

Iterator[tuple[str, torch.nn.parameter.Parameter]]

示例

>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

parameters(recurse=True)

返回模块参数的迭代器。

这通常会传递给优化器。

参数

recurse (bool) – 如果为 True，则产生当前模块及其所有子模块的参数。否则，仅产生当前模块的直接成员参数。

Yields

Parameter – 模块参数

返回类型

Iterator[Parameter]

示例

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

在模块上注册一个 backward 钩子。

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

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_buffer(name, tensor, persistent=True)

向模块添加一个 buffer。

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

Buffers 可以通过给定的名称作为属性访问。

参数

• name (str) – buffer 的名称。可以通过给定的名称从此模块访问该 buffer。

• tensor (Tensor or None) – 要注册的 buffer。如果为 None，则忽略在 buffers 上运行的操作（例如 cuda）。如果为 None，则该 buffer 不包含在模块的 state_dict 中。

• persistent (bool) – buffer 是否是此模块 state_dict 的一部分。

示例

>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook, *, prepend=False, with_kwargs=False, always_call=False)

在模块上注册一个 forward 钩子。

每次 forward() 计算出输出后，将调用此钩子。

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

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

如果 with_kwargs 为 True，则 forward 钩子将接收传递给 forward 函数的 kwargs，并且应返回可能已修改的输出。钩子应具有以下签名：

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

参数

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

• prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.Module 上所有现有 forward 钩子之前触发。否则，提供的 hook 将在此 torch.nn.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, *, prepend=False, with_kwargs=False)

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

每次 forward() 被调用之前，将调用此钩子。

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

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

如果 with_kwargs 为 true，则 forward pre-hook 将接收传递给 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.Module 上所有现有 forward_pre 钩子之前触发。否则，提供的 hook 将在此 torch.nn.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, prepend=False)

在模块上注册一个 backward 钩子。

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

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

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

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

警告

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

参数

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

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

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)

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

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

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

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

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

警告

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

参数

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

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

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

注册一个 post-hook，在模块的 load_state_dict() 调用后运行。

它应具有以下签名：

hook(module, incompatible_keys) -> None

module 参数是注册此钩子的当前模块，而 incompatible_keys 参数是一个 NamedTuple，包含属性 missing_keys 和 unexpected_keys。missing_keys 是一个包含缺失键的 list（元素为 str），unexpected_keys 是一个包含意外键的 list（元素为 str）。

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

注册一个 pre-hook，在模块的 load_state_dict() 调用前运行。

它应具有以下签名：

hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

参数

hook (Callable) – 在加载 state dict 之前将被调用的可调用钩子。

register_module(name, module)

add_module() 的别名。

register_parameter(name, param)

向模块添加一个参数。

该参数可以通过给定的名称作为属性访问。

参数

• name (str) – 参数的名称。可以使用给定的名称从此模块访问该参数。

• param (Parameter 或 None) – 要添加到模块的参数。如果为 None，则对参数运行的操作（例如 cuda）将被忽略。如果为 None，则参数不会包含在模块的 state_dict 中。

register_state_dict_post_hook(hook)

为 state_dict() 方法注册一个后置钩子 (post-hook)。

它应具有以下签名：

hook(module, state_dict, prefix, local_metadata) -> None

注册的钩子可以就地修改 state_dict。

register_state_dict_pre_hook(hook)

为 state_dict() 方法注册一个前置钩子 (pre-hook)。

它应具有以下签名：

hook(module, prefix, keep_vars) -> None

注册的钩子可用于在调用 state_dict 之前执行预处理。

requires_grad_(requires_grad=True)

更改 autograd 是否应在此模块的参数上记录操作。

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

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

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

参数

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

返回

self

返回类型

模块

set_extra_state(state)

设置加载的 state_dict 中包含的额外状态。

此函数由 load_state_dict() 调用，用于处理 state_dict 中找到的任何额外状态。如果您需要在模块的 state_dict 中存储额外状态，请为您自己的模块实现此函数和相应的 get_extra_state()。

参数

state (dict) – 来自 state_dict 的额外状态

set_submodule(target, module, strict=False)

设置由 target 给定的子模块（如果存在），否则抛出错误。

注意

如果 strict 设置为 False（默认值），该方法将替换现有子模块，或者在父模块存在的情况下创建新的子模块。如果 strict 设置为 True，该方法将仅尝试替换现有子模块，并且如果子模块不存在，则抛出错误。

例如，假设您有一个 nn.Module A 如下所示

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(3, 3, 3)
        )
        (linear): Linear(3, 3)
    )
)

（该图显示了一个 nn.Module A。A 有一个嵌套的子模块 net_b，它本身有两个子模块 net_c 和 linear。net_c 然后有一个子模块 conv。）

要用新的子模块 Linear 覆盖 Conv2d，您可以调用 set_submodule("net_b.net_c.conv", nn.Linear(1, 1))，其中 strict 可以是 True 或 False。

要向现有 net_b 模块添加新的子模块 Conv2d，您将调用 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1))。

在上述情况下，如果您设置 strict=True 并调用 set_submodule("net_b.conv", nn.Conv2d(1, 1, 1), strict=True)，则会引发 AttributeError，因为 net_b 没有名为 conv 的子模块。

参数

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

• module (Module) – 要设置子模块的模块。

• strict (bool) – 如果为 False，该方法将替换现有子模块，或者在父模块存在的情况下创建新的子模块。如果为 True，该方法将仅尝试替换现有子模块，并且如果子模块尚不存在，则抛出错误。

抛出

• ValueError – 如果 target 字符串为空，或者 module 不是 nn.Module 的实例。

• AttributeError – 如果在由 target 字符串产生的路径中的任何一点，(子)路径解析为不存在的属性名，或不是 nn.Module 的实例对象。

share_memory()

请参阅 torch.Tensor.share_memory_()。

返回类型

T

state_dict(*, destination: T_destination, prefix: str = '', keep_vars: bool = False) → T_destination

state_dict(*, prefix: str = '', keep_vars: bool = False) → dict[str, Any]

返回一个字典，其中包含对模块整个状态的引用。

包含参数和持久缓冲区（例如，运行平均值）。键是相应的参数和缓冲区名称。设置为 None 的参数和缓冲区不包含在内。

注意

返回的对象是浅拷贝。它包含对模块参数和缓冲区的引用。

警告

目前 state_dict() 也按顺序接受用于 destination、prefix 和 keep_vars 的位置参数。但是，此用法正在被弃用，未来版本将强制使用关键字参数。

警告

请避免使用参数 destination，因为它不是为最终用户设计的。

参数

• destination (dict, optional) – 如果提供，模块的状态将更新到字典中，并返回同一个对象。否则，将创建并返回一个 OrderedDict。默认值：None。

• prefix (str, optional) – 添加到参数和缓冲区名称的前缀，用于构成 state_dict 中的键。默认值：''。

• keep_vars (bool, optional) – 默认情况下，在状态字典中返回的 Tensor 与 autograd 分离。如果将其设置为 True，则不会执行分离。默认值：False。

返回

包含模块整个状态的字典

返回类型

dict

示例

>>> module.state_dict().keys()
['bias', 'weight']

to(device: Optional[Union[str, device, int]] = ..., dtype: Optional[dtype] = ..., non_blocking: bool = ...) → Self

to(dtype: dtype, non_blocking: bool = ...) → Self

to(tensor: Tensor, non_blocking: bool = ...) → Self

移动和/或转换参数和缓冲区的数据类型。

可以如下调用：

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 Tensor 移动到 CUDA 设备。

请参见下面的示例。

注意

此方法会就地修改模块。

参数

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

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

• tensor (torch.Tensor) – 其数据类型和设备为此模块中所有参数和缓冲区的期望数据类型和设备的 Tensor。

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

返回

self

返回类型

模块

示例

>>> 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)
>>> 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, recurse=True)

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

参数

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

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

返回

self

返回类型

模块

train(mode=True)

将模块设置为训练模式。

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

参数

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

返回

self

返回类型

模块

type(dst_type)

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

注意

此方法会就地修改模块。

参数

dst_type (type 或 string) – 期望的类型

返回

self

返回类型

模块

xpu(device=None)

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

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

注意

此方法会就地修改模块。

参数

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

返回

self

返回类型

模块

zero_grad(set_to_none=True)

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

更多背景信息请参见 torch.optim.Optimizer 下的类似函数。

参数

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