评价此页

★ ★ ★ ★ ★

模块#

class torch.nn.Module(*args, **kwargs)[source]#

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

您的模型也应该继承这个类。

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

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)[source]#

将子模块添加到当前模块。

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

参数

name (str) – 子模块的名称。可以使用给定的名称从此模块访问子模块
module (Module) – 要添加到模块的子模块。

apply(fn)[source]#

将 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()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

buffers(recurse=True)[source]#

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

参数: 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()[source]#

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

生成: Module – 子模块
返回类型: Iterator[Module]

compile(*args, **kwargs)[source]#

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

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

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

cpu()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

cuda(device=None)[source]#

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

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

注意

此方法就地修改模块。

参数: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回: self
返回类型: 模块

double()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

eval()[source]#

将模块设置为评估模式。

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

这等同于 self.train(False)。

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

返回: self
返回类型: 模块

extra_repr()[source]#

返回模块的额外表示。

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

返回类型: str

float()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

forward(*input)[source]#

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

所有子类都应重写此方法。

注意

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

get_buffer(target)[source]#

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

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。(有关如何指定完全限定字符串的信息，请参阅 get_submodule。)
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
引发: AttributeError – 如果目标字符串引用了无效路径或解析为非缓冲区的内容

get_extra_state()[source]#

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

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

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: 对象

get_parameter(target)[source]#

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。(有关如何指定完全限定字符串的信息，请参阅 get_submodule。)
返回: 由 target 引用的参数
返回类型: torch.nn.Parameter
引发: AttributeError – 如果目标字符串引用了无效路径或解析为非 nn.Parameter 的内容

get_submodule(target)[source]#

如果存在，返回由 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()[source]#

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

注意

此方法就地修改模块。

返回: self
返回类型: 模块

ipu(device=None)[source]#

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

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

注意

此方法就地修改模块。

参数: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回: self
返回类型: 模块

load_state_dict(state_dict, strict=True, assign=False)[source]#

将参数和缓冲区从 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 则保留状态字典中张量的属性。唯一的例外是 Parameter 的 requires_grad 字段，其值将保留自模块。默认值：False

返回

missing_keys 是一个包含此模块期望但
在提供的 state_dict 中缺失的任何键的字符串列表。
unexpected_keys 是一个字符串列表，包含此模块
不期望但在提供的 state_dict 中存在的键。

返回类型

具有 missing_keys 和 unexpected_keys 字段的 NamedTuple

注意

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

modules()[source]#

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

生成: 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)[source]#

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

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

注意

此方法就地修改模块。

参数: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回: self
返回类型: 模块

named_buffers(prefix='', recurse=True, remove_duplicate=True)[source]#

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

参数

prefix (str) – 要添加到所有缓冲区名称前的前缀。
recurse (bool, optional) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，仅生成此模块的直接成员缓冲区。默认为 True。
remove_duplicate (bool, optional) – 是否移除结果中的重复缓冲区。默认为 True。

生成

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

返回类型

Iterator[tuple[str, torch.Tensor]]

示例

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

named_children()[source]#

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

生成: (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)[source]#

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

参数

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

返回模块参数的迭代器，同时生成参数的名称和参数本身。

参数

prefix (str) – 要添加到所有参数名称前的前缀。
recurse (bool) – 如果为 True，则生成此模块和所有子模块的参数。否则，仅生成此模块的直接成员参数。
remove_duplicate (bool, optional) – 是否移除结果中的重复参数。默认为 True。

生成

(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)[source]#

返回模块参数的迭代器。

这通常传递给优化器。

参数: 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)[source]#

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

此函数已弃用，取而代之的是 register_full_backward_hook()，此函数的行为将在未来版本中更改。

返回: 一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子
返回类型: torch.utils.hooks.RemovableHandle

register_buffer(name, tensor, persistent=True)[source]#

向模块添加一个缓冲区。

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

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

参数

name (str) – 缓冲区的名称。可以使用给定名称从此模块访问缓冲区
tensor (Tensor or 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)[source]#

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

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

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

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

如果 with_kwargs 为 True，则前向钩子将传递给前向函数提供的 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 将接收传递给前向函数的 kwargs。默认值：False
always_call (bool) – 如果为 True，则无论调用模块时是否引发异常，都会运行 hook。默认值：False

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook, *, prepend=False, with_kwargs=False)[source]#

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

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

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

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

如果 with_kwargs 为 true，则前向预钩子将传递给前向函数提供的 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 将接收传递给前向函数的 kwargs。默认值：False

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)[source]#

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

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

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

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

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

钩子应具有以下签名

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) – 如果为 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)[source]#

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

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

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

grad_output 是一个元组。钩子不应修改其参数，但可以选择返回相对于输出的新梯度，该梯度将用于后续计算中的 grad_output。 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)[source]#

注册一个后钩子，用于在模块的 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)[source]#

注册一个预钩子，用于在模块的 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)[source]#

add_module() 的别名。

register_parameter(name, param)[source]#

向模块添加一个参数。

可以使用给定名称作为属性访问该参数。

参数

name (str) – 参数的名称。可以使用给定名称从此模块访问该参数
param (Parameter or None) – 要添加到模块的参数。如果为 None，则忽略在参数上运行的操作，例如 cuda。如果为 None，则参数不包含在模块的 state_dict 中。

register_state_dict_post_hook(hook)[source]#

为 state_dict() 方法注册一个后钩子。

它应该具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

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

register_state_dict_pre_hook(hook)[source]#

为 state_dict() 方法注册一个预钩子。

它应该具有以下签名：: hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)[source]#

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

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

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

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

参数: requires_grad (bool) – 自动梯度是否应记录此模块中参数的操作。默认值：True。
返回: self
返回类型: 模块

set_extra_state(state)[source]#

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

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

参数: state (dict) – state_dict 中的额外状态

set_submodule(target, module, strict=False)[source]#

如果存在，设置由 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()[source]#

请参阅 torch.Tensor.share_memory_()。

返回类型: 自我

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

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 与自动梯度分离。如果将其设置为 True，则不会执行分离。默认值：False。

返回

包含模块整体状态的字典

返回类型

dict

示例

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

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

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

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

移动和/或转换参数和缓冲区。

这可以这样调用

to(device=None, dtype=None, non_blocking=False)[source]

to(dtype, non_blocking=False)[source]

to(tensor, non_blocking=False)[source]

to(memory_format=torch.channels_last)[source]

它的签名类似于 torch.Tensor.to()，但只接受浮点或复数 dtype。此外，此方法只会将浮点或复数参数和缓冲区转换为 dtype（如果给定）。整数参数和缓冲区将移动到 device（如果给定），但 dtype 不变。当设置 non_blocking 时，如果可能，它会尝试相对于主机异步转换/移动，例如，将具有固定内存的 CPU 张量移动到 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)[source]#

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

参数

device (torch.device) – 此模块中参数和缓冲区的所需设备。
recurse (bool) – 子模块的参数和缓冲区是否应递归移动到指定设备。

返回

self

返回类型

模块

train(mode=True)[source]#

将模块设置为训练模式。

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

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值：True。
返回: self
返回类型: 模块

type(dst_type)[source]#

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

注意

此方法就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: self
返回类型: 模块

xpu(device=None)[source]#

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

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

注意

此方法就地修改模块。

参数: device (int, optional) – 如果指定，所有参数都将复制到该设备
返回: self
返回类型: 模块

zero_grad(set_to_none=True)[source]#

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

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

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

模块#

文档

教程

资源