AveragedModel¶

class torch.optim.swa_utils.AveragedModel(model, device=None, avg_fn=None, multi_avg_fn=None, use_buffers=False)[source][source]¶

实现了用于随机权重平均 (SWA) 和指数移动平均 (EMA) 的平均模型。

随机权重平均由 Pavel Izmailov, Dmitrii Podoprikhin, Timur Garipov, Dmitry Vetrov 和 Andrew Gordon Wilson (UAI 2018) 在平均权重导致更广阔的局部最优解和更好的泛化能力一文中提出。

指数移动平均是 Polyak 平均的一种变体，但在迭代过程中使用指数权重而非相等权重。

AveragedModel 类在设备 device 上创建所提供的模块 model 的一个副本，并允许计算 model 参数的运行平均值。

参数

model (torch.nn.Module) – 用于 SWA/EMA 的模型
device (torch.device, 可选) – 如果提供，平均模型将存储在 device 上
avg_fn (function, 可选) – 用于更新参数的平均函数；该函数必须接受 AveragedModel 参数的当前值，model 参数的当前值，以及已平均的模型数量作为输入；如果为 None，则使用等权平均 (默认值: None)
multi_avg_fn (function, 可选) – 用于原地更新参数的平均函数；该函数必须接受 AveragedModel 参数的当前值列表，model 参数的当前值列表，以及已平均的模型数量作为输入；如果为 None，则使用等权平均 (默认值: None)
use_buffers (bool) – 如果为 True，它将计算模型参数和 buffers 的运行平均值。(默认值: False)

示例

>>> loader, optimizer, model, loss_fn = ...
>>> swa_model = torch.optim.swa_utils.AveragedModel(model)
>>> scheduler = torch.optim.lr_scheduler.CosineAnnealingLR(optimizer,
>>>                                     T_max=300)
>>> swa_start = 160
>>> swa_scheduler = SWALR(optimizer, swa_lr=0.05)
>>> for i in range(300):
>>>      for input, target in loader:
>>>          optimizer.zero_grad()
>>>          loss_fn(model(input), target).backward()
>>>          optimizer.step()
>>>      if i > swa_start:
>>>          swa_model.update_parameters(model)
>>>          swa_scheduler.step()
>>>      else:
>>>          scheduler.step()
>>>
>>> # Update bn statistics for the swa_model at the end
>>> torch.optim.swa_utils.update_bn(loader, swa_model)

您也可以使用自定义平均函数配合 avg_fn 或 multi_avg_fn 参数。如果未提供平均函数，默认会计算权重的等权平均 (SWA)。

示例

>>> # Compute exponential moving averages of the weights and buffers
>>> ema_model = torch.optim.swa_utils.AveragedModel(model,
>>>             torch.optim.swa_utils.get_ema_multi_avg_fn(0.9), use_buffers=True)

注意

当将 SWA/EMA 与包含 Batch Normalization 的模型一起使用时，您可能需要更新 Batch Normalization 的激活统计信息。这可以通过使用 torch.optim.swa_utils.update_bn() 或将 use_buffers 设置为 True 来完成。第一种方法通过将数据传递给模型在训练后阶段更新统计信息。第二种方法通过平均所有 buffers 在参数更新阶段完成。经验证据表明，更新归一化层中的统计信息会提高准确性，但您可能希望通过实验测试哪种方法在您的问题中能产生最佳结果。

注意

avg_fn 和 multi_avg_fn 不会保存在模型的 state_dict() 中。

注意

当首次调用 update_parameters() 时 (即 n_averaged 为 0)，model 的参数会被复制到 AveragedModel 的参数。对于后续每一次调用 update_parameters()，都会使用函数 avg_fn 来更新参数。

add_module(name, module)[source]¶

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

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

参数

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

apply(fn)[source]¶

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

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

参数: fn (Module -> None) – 应用于每个子模块的函数
返回值: 自身
返回类型: Module

示例

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

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

注意

此方法会原地修改模块。

返回值: 自身
返回类型: Module

buffers(recurse=True)[source]¶

返回一个模块 buffers 的迭代器。

参数: recurse (bool) – 如果为 True，则生成此模块和所有子模块的 buffers。否则，仅生成此模块的直接成员 buffers。
Yields: torch.Tensor – 模块 buffer
返回类型: 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]¶

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

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

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

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

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

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

cpu()[source]¶

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

注意

此方法会原地修改模块。

返回值: 自身
返回类型: Module

cuda(device=None)[source]¶

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

这也会使相关的参数和 buffers 成为不同的对象。因此，如果模块在优化期间将位于 GPU 上，应在构建优化器之前调用此方法。

注意

此方法会原地修改模块。

参数: device (int, 可选) – 如果指定，所有参数将被复制到该设备
返回值: 自身
返回类型: Module

double()[source]¶

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

注意

此方法会原地修改模块。

返回值: 自身
返回类型: Module

eval()[source]¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回值: 自身
返回类型: Module

extra_repr()[source]¶

返回模块的额外表示。

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

返回类型: str

float()[source]¶

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

注意

此方法会原地修改模块。

返回值: 自身
返回类型: Module

forward(*args, **kwargs)[source][source]¶: 前向传播。

get_buffer(target)[source]¶

返回由 target 指定的 buffer，如果存在；否则抛出错误。

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

参数: target (str) – 要查找的 buffer 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回值: 由 target 引用的 buffer
返回类型: torch.Tensor
抛出: AttributeError – 如果目标字符串引用无效路径或解析结果不是 buffer

get_extra_state()[source]¶

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

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

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

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

get_parameter(target)[source]¶

返回由 target 指定的 parameter，如果存在；否则抛出错误。

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回值: 由 target 引用的 Parameter
返回类型: 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。)或解析结果不是 nn.Parameter

要检查是否存在 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 数据类型。

注意

此方法会原地修改模块。

返回值: 自身
返回类型: Module

ipu(device=None)[源]¶

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

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

注意

此方法会原地修改模块。

参数: device (int, 可选) – 如果指定，所有参数将被复制到该设备
返回值: 自身
返回类型: Module

load_state_dict(state_dict, strict=True, assign=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, 可选) – 是否严格要求 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值：True
assign (bool, 可选) – 当设置为 False 时，保留当前模块中张量的属性，而将其设置为 True 时，保留状态字典中张量的属性。默认值：False

返回值

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

返回类型

包含 missing_keys 和 unexpected_keys 字段的 NamedTuple

注意

如果参数或缓冲区注册为 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)[源]¶

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

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

注意

此方法会原地修改模块。

参数: device (int, 可选) – 如果指定，所有参数将被复制到该设备
返回值: 自身
返回类型: Module

named_buffers(prefix='', recurse=True, remove_duplicate=True)[源]¶

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

参数

prefix (str) – 要添加到所有缓冲区名称前的字符串前缀。
recurse (bool, 可选) – 如果为 True，则产生此模块及所有子模块的缓冲区。否则，仅产生直接属于此模块的缓冲区。默认为 True。
remove_duplicate (bool, 可选) – 是否移除结果中的重复缓冲区。默认为 True。

Yields

(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()[源]¶

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

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, 可选) – 是否移除结果中的重复参数。默认为 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)[源]¶

在此模块上注册反向钩子。

此函数已弃用，请使用 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() 调用之后调用的，因此对 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)[源]¶

在此模块上注册反向钩子。

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

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

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义钩子。
prepend (布尔值) – 如果为 `True`，则提供的 `hook` 将在此 torch.nn.Module 上所有现有的 `backward` hook *之前*触发。否则，提供的 `hook` 将在此 torch.nn.Module 上所有现有的 `backward` hook *之后*触发。请注意，使用 register_module_full_backward_hook() 注册的全局 `backward` hook 将在此方法注册的所有 hook *之前*触发。

返回值

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

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)[source]¶

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

每次计算模块的梯度时都会调用该 hook。该 hook 应具有以下签名

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

grad_output 是一个元组。Hook 不应修改其参数，但它可以选择返回一个关于输出的新梯度，该梯度将在后续计算中用于替代 `grad_output`。`grad_output` 中的非 Tensor 参数对应项将为 `None`。

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

警告

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

参数

hook (Callable) – 要注册的用户定义钩子。
prepend (布尔值) – 如果为 `True`，则提供的 `hook` 将在此 torch.nn.Module 上所有现有的 `backward_pre` hook *之前*触发。否则，提供的 `hook` 将在此 torch.nn.Module 上所有现有的 `backward_pre` hook *之后*触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 `backward_pre` hook 将在此方法注册的所有 hook *之前*触发。

返回值

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

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)[source]¶

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

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

参数 module 是注册此 hook 的当前模块，参数 incompatible_keys 是一个 NamedTuple，包含 missing_keys 和 unexpected_keys 属性。missing_keys 是一个包含缺失键的 str 列表，unexpected_keys 是一个包含意外键的 str 列表。

如果需要，给定的 incompatible_keys 可以原地修改。

请注意，当调用带有 strict=True 参数的 load_state_dict() 时执行的检查会受到 hook 对 missing_keys 或 unexpected_keys 所做修改的影响，这是预期的行为。向任一键集合中添加键都会在 strict=True 时导致错误抛出，而清空所有缺失和意外的键将避免错误。

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

register_load_state_dict_pre_hook(hook)[source]¶

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

它应具有以下签名：: hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

参数: hook (可调用对象 Callable) – 在加载状态字典之前将被调用的可调用 hook。

register_module(name, module)[source]¶

add_module() 的别名。

register_parameter(name, param)[source]¶

向模块添加一个参数。

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

参数

name (字符串 str) – 参数的名称。可以使用给定的名称从该模块访问该参数
param (Parameter 或 None) – 要添加到模块的参数。如果为 None，则对参数执行的操作（例如 cuda）将被忽略。如果为 None，则该参数**不会**包含在模块的 state_dict 中。

register_state_dict_post_hook(hook)[source]¶

为 state_dict() 方法注册一个后置 hook。

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

注册的 hook 可以原地修改 state_dict。

register_state_dict_pre_hook(hook)[source]¶

为 state_dict() 方法注册一个前置 hook。

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

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

requires_grad_(requires_grad=True)[source]¶

改变是否由 autograd 记录此模块中参数上的操作。

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

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

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

参数: requires_grad (布尔值) – autograd 是否应记录此模块中参数上的操作。默认值：True。
返回值: 自身
返回类型: Module

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`


要在现有的 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 (布尔值) – 如果为 False，则如果父模块存在，此方法将替换现有子模块或创建一个新子模块。如果为 True，则此方法将仅尝试替换现有子模块，如果子模块不存在，则抛出错误。


抛出

ValueError – 如果 target 字符串为空，或者如果 module 不是 nn.Module 的实例。
AttributeError – 如果由 target 字符串形成的路径在任何地方解析到不存在的属性名或不是 nn.Module 实例的对象。





share_memory()[source]¶
请参阅 torch.Tensor.share_memory_()。

返回类型







state_dict(*args, destination=None, prefix='', keep_vars=False)[source]¶
返回一个字典，其中包含模块整个状态的引用。
参数和持久缓冲区（例如，运行平均值）都包含在内。键是相应的参数名和缓冲区名。设置为 None 的参数和缓冲区不包含在内。

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


警告
目前 state_dict() 也按顺序接受 destination、prefix 和 keep_vars 的位置参数。然而，这已被弃用，未来的版本将强制使用关键字参数。


警告
请避免使用参数 destination，因为它并非为终端用户设计。


参数

destination (字典 dict, 可选) – 如果提供，模块的状态将更新到该字典中，并返回相同的对象。否则，将创建一个 OrderedDict 并返回。默认值：None。
prefix (字符串 str, 可选) – 添加到参数和缓冲区名称前的字符串，用于构成 state_dict 中的键。默认值：''。
keep_vars (布尔值, 可选) – 默认情况下，state dict 中返回的 Tensor 从 autograd 分离（detached）。如果设置为 True，则不会执行分离。默认值：False。


返回值
一个包含模块整个状态的字典

返回类型
字典 dict


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






to(*args, **kwargs)[source]¶
移动和/或转换参数和缓冲区的数据类型。
可以按以下方式调用：


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，则整型参数和缓冲区将被移动到指定 device，但其 dtype 不变。当设置了 non_blocking 时，如果可能，它会尝试相对于主机异步地转换/移动，例如，将具有 pinned memory 的 CPU Tensor 移动到 CUDA 设备。
参见下面的示例。

注意
此方法会原地修改模块。


参数

device (torch.device) – 此模块中参数和缓冲区的目标设备。
dtype (torch.dtype) – 此模块中参数和缓冲区的目标浮点或复数 dtype。
tensor (torch.Tensor) – 其 dtype 和设备为此模块中所有参数和缓冲区的目标 dtype 和设备的 Tensor。
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的目标内存格式（仅限关键字参数）。


返回值
自身

返回类型
Module


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


返回值
自身

返回类型
Module






train(mode=True)[source]¶
将模块设置为训练模式。
这仅对某些模块有影响。有关它们在训练/评估模式下的行为细节，即它们是否受到影响（例如 Dropout、BatchNorm 等），请参阅特定模块的文档。

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

返回值
自身

返回类型
Module






type(dst_type)[source]¶
将所有参数和缓冲区转换为 dst_type。

注意
此方法会原地修改模块。


参数
dst_type (类型 type 或 字符串 string) – 目标类型。

返回值
自身

返回类型
Module






update_parameters(model)[source][source]¶
更新模型参数。






xpu(device=None)[source]¶
将所有模型参数和缓冲区移动到 XPU。
这也会使关联的参数和缓冲区成为不同的对象。因此，如果模块在优化过程中将位于 XPU 上，则应在构建优化器之前调用此方法。

注意
此方法会原地修改模块。


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

返回值
自身

返回类型
Module






zero_grad(set_to_none=True)[source]¶
重置所有模型参数的梯度。
有关更多上下文，请参阅 torch.optim.Optimizer 下的类似函数。

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

AveragedModel¶

文档

教程

资源