AveragedModel

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

为随机权重平均 (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, 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() 编译此模块的前向。

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

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

cpu()

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

注意

此方法会就地修改模块。

返回值

self

返回值类型

Module

cuda(device=None)

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

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

注意

此方法会就地修改模块。

参数

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

返回值

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() 时调用。

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

返回值

要存储在模块的 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_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, 可选) – 如果指定，所有参数都将复制到该设备。

返回值

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, optional) – 是否严格执行 state_dict 中的键与该模块的 state_dict() 函数返回的键匹配。 默认： True

• assign (bool, optional) – 当 False 时，当前模块中张量的属性将被保留，而当 True 时，状态字典中张量的属性将被保留。 唯一的例外是 requires_grad 字段 Default: ``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, 可选) – 如果指定，所有参数都将复制到该设备。

返回值

self

返回值类型

Module

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 (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, optional) – 是否从结果中移除重复的参数。 默认值为 True。

生成

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

返回值类型

迭代器[元组[str, 参数]]

示例

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

parameters(recurse=True)

返回模块参数的迭代器。

这通常传递给优化器。

参数

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

生成

参数 – 模块参数

返回值类型

迭代器[参数]

示例

>>> 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 (张量 or None) – 要注册的缓冲区。如果为 None，则会忽略对缓冲区运行的操作，例如 cuda。如果为 None，则缓冲区不包含在模块的 state_dict 中。

• persistent (布尔值) – 缓冲区是否是此模块的 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，则前向钩子将传递给前向函数的 kwargs，并预期返回可能已修改的输出。钩子应该具有以下签名

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

参数

• hook (可调用对象) – 要注册的用户定义的钩子。

• prepend (布尔值) – 如果为 True，则提供的 hook 将在该 torch.nn.modules.Module 上所有现有 forward 钩子之前触发。否则，提供的 hook 将在该 torch.nn.modules.Module 上所有现有 forward 钩子之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward 钩子将在通过此方法注册的所有钩子之前触发。默认：False

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

• always_call (布尔值) – 如果为 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，则前向预钩子将传递给前向函数的 kwargs。如果钩子修改了输入，则应返回 args 和 kwargs。钩子应该具有以下签名

hook(module, args, kwargs) -> None or a tuple of modified input and kwargs

参数

• hook (可调用对象) – 要注册的用户定义的钩子。

• prepend (布尔值) – 如果为 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 (布尔值) – 如果为 true，则 hook 将传递给前向函数的 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 仅对应作为位置参数给出的输入，所有关键字参数都将被忽略。 grad_input 和 grad_output 中的条目对于所有非张量参数将为 None。

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

警告

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

参数

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

• prepend (bool) – 如果为真，则提供的 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 中的条目对于所有非张量参数将为 None。

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

警告

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

参数

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

• prepend (bool) – 如果为真，则提供的 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 是一个包含属性 missing_keys 和 unexpected_keys 的 NamedTuple。 missing_keys 是一个包含缺失键的 list，而 unexpected_keys 是一个包含意外键的 list。

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

返回值类型

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, 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(*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（如果给出），但数据类型保持不变。当设置 non_blocking 时，它尝试异步地相对于主机进行转换/移动，如果可能，例如，将具有固定内存的 CPU 张量移动到 CUDA 设备。

有关示例，请参见下文。

注意

此方法会就地修改模块。

参数

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

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

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

• 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 or string) – 所需类型

返回值

self

返回值类型

Module

update_parameters(model)

更新模型参数。

xpu(device=None)

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

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

注意

此方法会就地修改模块。

参数

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

返回值

self

返回值类型

Module

zero_grad(set_to_none=True)

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

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

参数

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