AveragedModel

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

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

随机权重平均在 Averaging Weights Leads to Wider Optima and Better Generalization 中提出，作者为 Pavel Izmailov、Dmitrii Podoprikhin、Timur Garipov、Dmitry Vetrov 和 Andrew Gordon Wilson (UAI 2018)。

指数移动平均是 Polyak averaging 的变体，但使用指数权重而不是迭代之间的相等权重。

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

参数

• model (torch.nn.Module) – 与 SWA/EMA 一起使用的模型

• device (torch.device, optional) – 如果提供，平均模型将存储在 device 上

• avg_fn (function, optional) – 用于更新参数的平均函数；该函数必须接受 AveragedModel 参数的当前值、model 参数的当前值以及已平均的模型数量；如果为 None，则使用等权重平均值（默认值：None）

• multi_avg_fn (function, optional) – 用于就地更新参数的平均函数；该函数必须接受 AveragedModel 参数的当前值列表、model 参数的当前值列表以及已平均的模型数量；如果为 None，则使用等权重平均值（默认值：None）

• use_buffers (bool) – 如果为 True，它将计算模型的参数和缓冲区的运行平均值。（默认值：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 与包含批归一化的模型一起使用时，您可能需要更新批归一化的激活统计信息。这可以通过使用 torch.optim.swa_utils.update_bn() 或将 use_buffers 设置为 True 来完成。第一种方法通过传递数据通过模型在训练后步骤中更新统计信息。第二种方法在参数更新阶段通过平均所有缓冲区来完成。经验证据表明，更新归一化层中的统计信息会提高准确性，但您可能希望通过经验测试哪种方法在您的问题中产生最佳结果。

注意

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

注意

当第一次调用 update_parameters() 时（即 n_averaged 为 0），model 的参数将复制到 AveragedModel 的参数。对于每次后续调用 update_parameters()，函数 avg_fn 用于更新参数。

add_module(name, module)

向当前模块添加子模块。

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

参数

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

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

apply(fn)

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

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

参数

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

返回

self

返回类型

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

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

注意

此方法就地修改模块。

返回

self

返回类型

Module

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

返回类型

Module

cuda(device=None)

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

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

注意

此方法就地修改模块。

参数

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

返回

self

返回类型

Module

double()

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

注意

此方法就地修改模块。

返回

self

返回类型

Module

eval()

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回

self

返回类型

Module

extra_repr()

返回模块的额外表示。

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

返回类型

str

float()

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

注意

此方法就地修改模块。

返回

self

返回类型

Module

forward(*args, **kwargs)

前向传播。

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 的工作序列化。我们仅为序列化张量提供向后兼容性保证；如果其他对象的序列化 pickle 形式发生更改，则它们可能会破坏向后兼容性。

返回

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

返回类型

object

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

返回类型

Module

ipu(device=None)

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

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

注意

此方法就地修改模块。

参数

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

返回

self

返回类型

Module

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, 可选) – 是否严格强制 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值： True

• assign (bool, 可选) – 当设置为 False 时，当前模块中张量的属性将被保留，而设置为 True 则保留状态字典中张量的属性。唯一的例外是 requires_grad 字段。默认值: ``False`

返回

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

  by this module but missing from the provided state_dict.

• unexpected_keys 是一个字符串列表，包含此模块不预期但在提供的 state_dict 中存在的键。

  expected by this module but present in the provided 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

返回类型

Module

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

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

参数

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

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

• remove_duplicate (bool, 可选) – 是否删除结果中重复的缓冲区。默认为 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 (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)

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

参数

• prefix (str) – 要添加到所有参数名称的前缀。

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

• remove_duplicate (bool, 可选) – 是否删除结果中重复的参数。默认为 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.modules.Module 上的所有现有 forward 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在由此方法注册的所有钩子之前触发。默认值： False

• with_kwargs (bool) – 如果为 True，则 hook 将传递给 forward 函数的 kwargs。默认值： False

• always_call (bool) – 如果为 True，则无论在调用模块时是否引发异常，都将运行 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.modules.Module 上的所有现有 forward_pre 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.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 中的条目对于所有非 Tensor 参数都将为 None。

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

警告

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

参数

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

• prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward 钩子之前触发。否则，提供的 hook 将在此 torch.nn.modules.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] or None

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

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

警告

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

参数

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

• 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() 删除添加的钩子

返回类型

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 的 str，包含缺失的键，unexpected_keys 是一个 list 的 str，包含意外的键。

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

请注意，使用 strict=True 调用 load_state_dict() 时执行的检查会受到钩子对 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。

它应具有以下签名：

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

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

register_state_dict_pre_hook(hook)

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

它应具有以下签名：

hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)

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

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

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

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

参数

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

返回

self

返回类型

Module

set_extra_state(state)

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

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

参数

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

set_submodule(target, 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_c 和 linear。net_c 然后有一个子模块 conv。）

要使用新的子模块 Linear 覆盖 Conv2d，您可以调用 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

参数

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

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

引发

• ValueError – 如果目标字符串为空

• AttributeError – 如果目标字符串引用无效路径或解析为非 nn.Module 的内容

share_memory()

参见 torch.Tensor.share_memory_()。

返回类型

T

state_dict(*args, destination=None, prefix='', keep_vars=False)

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

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

注意

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

警告

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

警告

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

参数

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

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

• keep_vars (bool, 可选) – 默认情况下，state dict 中返回的 Tensor s 与 autograd 分离。如果设置为 True，则不会执行分离。默认值：False。

返回

包含模块整个状态的字典

返回类型

dict

示例

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

请参见下面的示例。

注意

此方法就地修改模块。

参数

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

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

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

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

返回

self

返回类型

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)

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

参数

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

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

返回

self

返回类型

Module

train(mode=True)

将模块设置为训练模式。

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

参数

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

返回

self

返回类型

Module

type(dst_type)

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

注意

此方法就地修改模块。

参数

dst_type (type 或 string) – 所需的类型

返回

self

返回类型

Module

update_parameters(model)

更新模型参数。

xpu(device=None)

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

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

注意

此方法就地修改模块。

参数

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

返回

self

返回类型

Module

zero_grad(set_to_none=True)

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

有关更多上下文，请参见 torch.optim.Optimizer 下的类似函数。

参数

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