评价此页
★ ★ ★ ★ ★

Module#

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) is 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，则会生成此模块及所有子模块的缓冲区。否则，只生成此模块的直接成员缓冲区。

产生:

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()[源代码]#

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

产生:

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

注意，为了保证 state_dict 的序列化工作正常，额外状态应该是可被 pickle 的。我们仅为 Tensors 的序列化提供向后兼容性保证；其他对象的序列化形式若发生变化，可能导致向后兼容性中断。

返回:

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

返回类型:

对象

get_parameter(target)[源代码]#

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

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

参数:

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

返回:

由 target 引用的参数

返回类型:

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 – 如果在 target 字符串解析出的路径中的任何一点，(子)路径解析为一个不存在的属性名或一个非 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 中张量的属性。唯一的例外是 Parameter 的 requires_grad 字段，此时将保留模块中的值。默认为 False。

返回:

  • missing_keys 是一个包含此模块期望但

    在提供的 state_dict 中缺失的任何键的字符串列表。

  • unexpected_keys 是一个字符串列表，包含此模块

    不期望但在提供的 state_dict 中存在的键。

返回类型:

NamedTuple，包含 missing_keys 和 unexpected_keys 字段。

注意

如果某个参数或缓冲区被注册为 None 并且在 state_dict 中存在对应的键，则 load_state_dict() 将引发 RuntimeError。

modules()[源代码]#

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

产生:

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)[源代码]#

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

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

注意

此方法就地修改模块。

参数:

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

返回:

self

返回类型:

模块

named_buffers(prefix='', recurse=True, remove_duplicate=True)[源代码]#

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

参数:

  • prefix (str) – 要添加到所有缓冲区名称的前缀。

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

  • remove_duplicate (bool, optional) – 是否在结果中删除重复的缓冲区。默认为 True。

产生:

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

返回类型:

Iterator[tuple[str, Tensor]]

示例

>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())
named_children()[源代码]#

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

产生:

(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 (set[Module] | None) – 用于存储已添加到结果中的模块集合的备忘录

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

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

产生:

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

产生:

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

返回类型:

Iterator[tuple[str, Parameter]]

示例

>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())
parameters(recurse=True)[源代码]#

返回模块参数的迭代器。

这通常传递给优化器。

参数:

recurse (bool) – 如果为 True，则会生成此模块及所有子模块的参数。否则，只生成此模块的直接成员参数。

产生:

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)[源代码]#

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

此函数已弃用，请使用 register_full_backward_hook()，并且此函数在未来版本中的行为将会改变。

返回:

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

返回类型:

torch.utils.hooks.RemovableHandle

register_buffer(name, tensor, persistent=True)[源代码]#

向模块添加一个缓冲区。

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

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

参数:

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

  • tensor (Tensor 或 None) – 要注册的缓冲区。如果为 None，则将忽略对缓冲区运行的操作，例如 cuda。如果为 None，则该缓冲区 **不** 包含在模块的 state_dict 中。

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

示例

>>> self.register_buffer('running_mean', torch.zeros(num_features))
register_forward_hook(hook, *, prepend=False, with_kwargs=False, always_call=False)[源代码]#

在模块上注册一个前向钩子。

在 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.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() 之前，将每次调用此钩子。

如果 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.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)[源代码]#

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

每次计算相对于模块的梯度时，将调用此钩子，其触发规则如下：

  1. 通常，钩子在计算相对于模块输入的梯度时触发。

  2. 如果模块输入都不需要梯度，则在计算相对于模块输出的梯度时触发钩子。

  3. 如果模块输出都不需要梯度，则钩子将不触发。

钩子应具有以下签名

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

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

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

警告

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

参数:

  • 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)[源代码]#

在模块上注册一个反向预钩子。

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

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

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

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

警告

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

参数:

  • 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)[源代码]#

注册一个后钩子，用于在模块的 load_state_dict() 被调用后运行。

它应该具有以下签名：

hook(module, incompatible_keys) -> None

参数 module 是当前调用此钩子函数的模块，参数 incompatible_keys 是一个 NamedTuple，包含 missing_keys 和 unexpected_keys 属性。 missing_keys 是一个包含缺失键的 list of str，而 unexpected_keys 是一个包含意外键的 list of 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)[源代码]#

注册一个预钩子，用于在模块的 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, 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() 方法注册一个后置钩子。

它应该具有以下签名：

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=True)[源代码]#

更改自动梯度是否应记录此模块中参数的操作。

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

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

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

参数:

requires_grad (bool) – 是否应为此模块中的参数启用自动求导。默认为 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。

要将一个新的 Conv2d 子模块添加到现有的 net_b 模块中，可以调用 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_()。

返回类型:

自我

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) – 默认情况下，state_dict 中返回的 Tensor s 会从自动求导中分离。如果设置为 True，则不会进行分离。默认为 False。

返回:

包含模块整体状态的字典

返回类型:

dict

示例

>>> module.state_dict().keys()
['bias', 'weight']
to(device: str | device | int | None = ..., dtype: dtype | None = ..., 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（如果已给出），但 dtype 保持不变。当 non_blocking 设置为 True 时，它会尝试与主机进行异步转换/移动（如果可能），例如将具有固定内存的 CPU Tensor 移动到 CUDA 设备。

有关示例，请参阅下文。

注意

此方法就地修改模块。

参数:

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

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

  • tensor (torch.Tensor) – 张量，其 dtype 和设备是此模块中所有参数和缓冲区的所需 dtype 和设备

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

在此页面上
显示源代码
PyTorch 库