MIT 许可证

Copyright (c) 2020 Phil Wang

特此免费授予任何获得本软件及相关文档文件（“软件”）副本的人士不受限制地处理本软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，并允许获得软件的人士这样做，但须遵守以下条件：

上述版权声明和本许可声明应包含在本软件的所有副本或实质性部分中。

本软件按“原样”提供，不作任何明示或暗示的保证，包括但不限于适销性、特定用途适用性和非侵权性的保证。在任何情况下，作者或版权持有者均不对任何索赔、损害或其他责任负责，无论是因合同、侵权或其他原因引起的，也无论是因软件或软件的使用或其他交易而产生、引发或与之相关。

class darts.models.components.layer_norm_variants.LayerNorm(input_size, **kwargs)

基类: LayerNorm

初始化内部模块状态，由 nn.Module 和 ScriptModule 共享。

方法

add_module(name, module)	向当前模块添加子模块。
apply(fn)	递归地将 fn 应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此模块的 forward。
cpu()	将所有模型参数和缓冲区移至 CPU。
cuda([device])	将所有模型参数和缓冲区移至 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(input)	定义每次调用时执行的计算。
get_buffer(target)	如果缓冲区 target 存在，则返回该缓冲区，否则抛出错误。
get_extra_state()	返回要包含在模块 state_dict 中的任何额外状态。
get_parameter(target)	如果参数 target 存在，则返回该参数，否则抛出错误。
get_submodule(target)	如果子模块 target 存在，则返回该子模块，否则抛出错误。
half()	将所有浮点参数和缓冲区转换为 half 数据类型。
ipu([device])	将所有模型参数和缓冲区移至 IPU。
load_state_dict(state_dict[, strict, assign])	将参数和缓冲区从 state_dict 复制到此模块及其后代中。
modules()	返回网络中所有模块的迭代器。
mtia([device])	将所有模型参数和缓冲区移至 MTIA。
named_buffers([prefix, recurse, ...])	返回模块缓冲区的迭代器，同时产生缓冲区的名称和缓冲区本身。
named_children()	返回直接子模块的迭代器，同时产生模块的名称和模块本身。
named_modules([memo, prefix, remove_duplicate])	返回网络中所有模块的迭代器，同时产生模块的名称和模块本身。
named_parameters([prefix, recurse, ...])	返回模块参数的迭代器，同时产生参数的名称和参数本身。
parameters([recurse])	返回模块参数的迭代器。
register_backward_hook(hook)	在模块上注册后向钩子。
register_buffer(name, tensor[, persistent])	向模块添加缓冲区。
register_forward_hook(hook, *[, prepend, ...])	在模块上注册前向钩子。
register_forward_pre_hook(hook, *[, ...])	在模块上注册前向预钩子。
register_full_backward_hook(hook[, prepend])	在模块上注册后向钩子。
register_full_backward_pre_hook(hook[, prepend])	在模块上注册后向预钩子。
register_load_state_dict_post_hook(hook)	注册后置钩子，在调用模块的 load_state_dict() 后运行。
register_load_state_dict_pre_hook(hook)	注册前置钩子，在调用模块的 load_state_dict() 前运行。
register_module(name, module)	等同于 add_module()。
register_parameter(name, param)	向模块添加参数。
register_state_dict_post_hook(hook)	为 state_dict() 方法注册后置钩子。
register_state_dict_pre_hook(hook)	为 state_dict() 方法注册前置钩子。
requires_grad_([requires_grad])	更改 autograd 是否应记录此模块参数上的操作。
set_extra_state(state)	设置加载的 state_dict 中包含的额外状态。
set_submodule(target, module)	如果子模块 target 存在，则设置该子模块，否则抛出错误。
share_memory()	参见 torch.Tensor.share_memory_()。
state_dict(*args[, destination, prefix, ...])	返回包含模块整个状态引用的字典。
to(*args, **kwargs)	移动和/或转换参数和缓冲区。
to_empty(*, device[, recurse])	将参数和缓冲区移至指定的设备，而不复制存储。
train([mode])	将模块设置为训练模式。
type(dst_type)	将所有参数和缓冲区转换为 dst_type。
xpu([device])	将所有模型参数和缓冲区移至 XPU。
zero_grad([set_to_none])	重置所有模型参数的梯度。

__call__
reset_parameters

T_destination

TypeVar(‘T_destination’, bound=Dict[str, Any]) 的别名

add_module(name, module)

向当前模块添加子模块。

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

参数

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

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

返回类型

None

apply(fn)

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

典型用法包括初始化模型参数（另见 nn-init-doc）。

参数

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 – 模块缓冲区

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

返回类型

Iterator[Tensor]

call_super_init: bool = False

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

dump_patches: bool = False

elementwise_affine: bool

eps: float

eval()

将模块设置为评估模式。

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

这等同于 self.train(False)。

有关 .eval() 与可能混淆的几种类似机制的比较，请参阅 locally-disable-grad-doc。

返回

self

返回类型

Module

extra_repr()

返回模块的额外表示。

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

返回类型

str

float()

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

注意

此方法修改模块原地。

返回

self

返回类型

Module

forward(input)

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

应由所有子类覆盖。

注意

尽管 forward pass 的方法需要在函数内部定义，但之后应该调用 Module 实例而不是此函数本身，因为前者负责运行已注册的钩子，而后者会默默地忽略它们。

返回类型

Tensor

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 的正常序列化。我们仅为序列化 Tensor 提供向后兼容性保证；如果其他对象的序列化 pickle 形式发生变化，可能会破坏向后兼容性。

返回

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

返回类型

object

get_parameter(target)

如果参数 target 存在，则返回该参数，否则抛出错误。

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

参数

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

返回

由 target 引用的 Parameter

返回类型

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

• assign (bool, optional) – 当设置为 False 时，将保留当前模块中张量的属性，而将其设置为 True 时，将保留 state dict 中张量的属性。唯一的例外是 requires_grad 字段。 默认值: ``False`

返回

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

  由此模块所有但缺失于所提供的 state_dict 中。

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

  由此模块所需但存在于所提供的 state_dict 中。

返回类型

NamedTuple，包含 missing_keys 和 unexpected_keys 字段

注意

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

modules()

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

生成

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)

返回类型

Iterator[Module]

mtia(device=None)

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

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

注意

此方法修改模块原地。

参数

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

返回

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) – 包含名称和缓冲区的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

返回类型

Iterator[Tuple[str, Tensor]]

named_children()

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

生成

(str, Module) – 包含名称和子模块的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

返回类型

Iterator[Tuple[str, Module]]

named_modules(memo=None, prefix='', remove_duplicate=True)

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

参数

• memo (Optional[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) – 包含名称和参数的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

返回类型

Iterator[Tuple[str, Parameter]]

normalized_shape: Tuple[int, ...]

parameters(recurse=True)

返回模块参数的迭代器。

这通常会传递给优化器。

参数

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

生成

Parameter – 模块参数

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for param in model.parameters():
>>>     print(type(param), param.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

返回类型

Iterator[Parameter]

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

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

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

返回类型

None

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 钩子将接收传递给 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 pre-hook 将接收传递给 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。

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

警告

使用 backward hooks 时不允许原地修改输入或输出，并且会引发错误。

参数

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

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

警告

使用 backward hooks 时不允许原地修改输入，并且会引发错误。

参数

• 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 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) – 可调用钩子，将在加载 state dict 前调用。

register_module(name, module)

等同于 add_module()。

返回类型

None

register_parameter(name, param)

向模块添加参数。

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

参数

• name (str) – 参数的名称。可以使用给定的名称从当前模块访问该参数

• param (Parameter or None) – 要添加到模块的参数。如果为 None，则对参数进行的操作（例如 cuda）将被忽略。如果为 None，则该参数不会包含在模块的 state_dict 中。

返回类型

None

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)

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

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

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

有关 .requires_grad_() 与可能混淆的几种类似机制的比较，请参阅 locally-disable-grad-doc。

参数

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

返回

self

返回类型

Module

reset_parameters()

返回类型

None

set_extra_state(state)

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

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

参数

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

返回类型

None

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

返回类型

None

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

返回

包含模块完整状态的字典

返回类型

字典

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> 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 Tensors 移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法修改模块原地。

参数

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

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

• tensor (torch.Tensor) – 一个 Tensor，其数据类型和设备是此模块中所有参数和缓冲区的目标数据类型和设备

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

返回

self

返回类型

Module

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> 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)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> 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

training: bool

type(dst_type)

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

注意

此方法修改模块原地。

参数

dst_type (type 或 string) – 目标类型

返回

self

返回类型

Module

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

返回类型

None

class darts.models.components.layer_norm_variants.LayerNormNoBias(input_size, **kwargs)

基类: LayerNorm

初始化内部模块状态，由 nn.Module 和 ScriptModule 共享。

方法

add_module(name, module)	向当前模块添加子模块。
apply(fn)	递归地将 fn 应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此模块的 forward。
cpu()	将所有模型参数和缓冲区移至 CPU。
cuda([device])	将所有模型参数和缓冲区移至 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(input)	定义每次调用时执行的计算。
get_buffer(target)	如果缓冲区 target 存在，则返回该缓冲区，否则抛出错误。
get_extra_state()	返回要包含在模块 state_dict 中的任何额外状态。
get_parameter(target)	如果参数 target 存在，则返回该参数，否则抛出错误。
get_submodule(target)	如果子模块 target 存在，则返回该子模块，否则抛出错误。
half()	将所有浮点参数和缓冲区转换为 half 数据类型。
ipu([device])	将所有模型参数和缓冲区移至 IPU。
load_state_dict(state_dict[, strict, assign])	将 state_dict 中的参数和缓冲区复制到此模块及其后代中。
modules()	返回网络中所有模块的迭代器。
mtia([device])	将所有模型参数和缓冲区移至 MTIA。
named_buffers([prefix, recurse, ...])	返回模块缓冲区的迭代器，同时产生缓冲区的名称和缓冲区本身。
named_children()	返回直接子模块的迭代器，同时产生模块的名称和模块本身。
named_modules([memo, prefix, remove_duplicate])	返回网络中所有模块的迭代器，同时产生模块的名称和模块本身。
named_parameters([prefix, recurse, ...])	返回模块参数的迭代器，同时产生参数的名称和参数本身。
parameters([recurse])	返回模块参数的迭代器。
register_backward_hook(hook)	在模块上注册后向钩子。
register_buffer(name, tensor[, persistent])	向模块添加缓冲区。
register_forward_hook(hook, *[, prepend, ...])	在模块上注册前向钩子。
register_forward_pre_hook(hook, *[, ...])	在模块上注册前向预钩子。
register_full_backward_hook(hook[, prepend])	在模块上注册后向钩子。
register_full_backward_pre_hook(hook[, prepend])	在模块上注册后向预钩子。
register_load_state_dict_post_hook(hook)	注册后置钩子，在调用模块的 load_state_dict() 后运行。
register_load_state_dict_pre_hook(hook)	注册前置钩子，在调用模块的 load_state_dict() 前运行。
register_module(name, module)	add_module() 的别名。
register_parameter(name, param)	向模块添加参数。
register_state_dict_post_hook(hook)	为 state_dict() 方法注册后置钩子。
register_state_dict_pre_hook(hook)	为 state_dict() 方法注册前置钩子。
requires_grad_([requires_grad])	更改 autograd 是否应记录此模块参数上的操作。
set_extra_state(state)	设置加载的 state_dict 中包含的额外状态。
set_submodule(target, module)	如果子模块 target 存在，则设置该子模块，否则抛出错误。
share_memory()	参见 torch.Tensor.share_memory_()。
state_dict(*args[, destination, prefix, ...])	返回包含模块整个状态引用的字典。
to(*args, **kwargs)	移动和/或转换参数和缓冲区。
to_empty(*, device[, recurse])	将参数和缓冲区移至指定的设备，而不复制存储。
train([mode])	将模块设置为训练模式。
type(dst_type)	将所有参数和缓冲区转换为 dst_type。
xpu([device])	将所有模型参数和缓冲区移至 XPU。
zero_grad([set_to_none])	重置所有模型参数的梯度。

__call__
reset_parameters

T_destination

TypeVar(‘T_destination’, bound=Dict[str, Any]) 的别名

add_module(name, module)

向当前模块添加子模块。

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

参数

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

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

返回类型

None

apply(fn)

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

典型用法包括初始化模型参数（另见 nn-init-doc）。

参数

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 – 模块缓冲区

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

返回类型

Iterator[Tensor]

call_super_init: bool = False

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

dump_patches: bool = False

elementwise_affine: bool

eps: float

eval()

将模块设置为评估模式。

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

这等同于 self.train(False)。

有关 .eval() 与可能混淆的几种类似机制的比较，请参阅 locally-disable-grad-doc。

返回

self

返回类型

Module

extra_repr()

返回模块的额外表示。

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

返回类型

str

float()

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

注意

此方法修改模块原地。

返回

self

返回类型

Module

forward(input)

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

应由所有子类覆盖。

注意

尽管 forward pass 的方法需要在函数内部定义，但之后应该调用 Module 实例而不是此函数本身，因为前者负责运行已注册的钩子，而后者会默默地忽略它们。

返回类型

Tensor

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 的正常序列化。我们仅为序列化 Tensor 提供向后兼容性保证；如果其他对象的序列化 pickle 形式发生变化，可能会破坏向后兼容性。

返回

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

返回类型

object

get_parameter(target)

如果参数 target 存在，则返回该参数，否则抛出错误。

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

参数

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

返回

由 target 引用的 Parameter

返回类型

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, 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, optional) – 当设置为 False 时，将保留当前模块中张量的属性，而将其设置为 True 时，将保留 state dict 中张量的属性。唯一的例外是 requires_grad 字段。 默认值: ``False`

返回

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

  由此模块所有但缺失于所提供的 state_dict 中。

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

  由此模块所需但存在于所提供的 state_dict 中。

返回类型

NamedTuple，包含 missing_keys 和 unexpected_keys 字段

注意

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

modules()

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

生成

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)

返回类型

Iterator[Module]

mtia(device=None)

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

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

注意

此方法修改模块原地。

参数

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

返回

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) – 包含名称和缓冲区的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

返回类型

Iterator[Tuple[str, Tensor]]

named_children()

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

生成

(str, Module) – 包含名称和子模块的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

返回类型

Iterator[Tuple[str, Module]]

named_modules(memo=None, prefix='', remove_duplicate=True)

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

参数

• memo (Optional[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) – 包含名称和参数的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

返回类型

Iterator[Tuple[str, Parameter]]

normalized_shape: Tuple[int, ...]

parameters(recurse=True)

返回模块参数的迭代器。

这通常会传递给优化器。

参数

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

生成

Parameter – 模块参数

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for param in model.parameters():
>>>     print(type(param), param.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

返回类型

Iterator[Parameter]

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 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

返回类型

None

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 钩子将接收传递给 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 pre-hook 将接收传递给 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。

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

警告

使用 backward hooks 时不允许原地修改输入或输出，并且会引发错误。

参数

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

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

警告

使用 backward hooks 时不允许原地修改输入，并且会引发错误。

参数

• 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 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) – 可调用钩子，将在加载 state dict 前调用。

register_module(name, module)

add_module() 的别名。

返回类型

None

register_parameter(name, param)

向模块添加参数。

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

参数

• name (str) – 参数的名称。可以使用给定的名称从当前模块访问该参数

• param (Parameter 或 None) – 要添加到模块的参数。如果为 None，则对参数运行的操作（例如 cuda）将被忽略。如果为 None，则参数**不**包含在模块的 state_dict 中。

返回类型

None

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)

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

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

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

有关 .requires_grad_() 与可能混淆的几种类似机制的比较，请参阅 locally-disable-grad-doc。

参数

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

返回

self

返回类型

Module

reset_parameters()

返回类型

None

set_extra_state(state)

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

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

参数

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

返回类型

None

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

返回类型

None

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

返回

包含模块完整状态的字典

返回类型

字典

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> 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 Tensors 移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法修改模块原地。

参数

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

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

• tensor (torch.Tensor) – 一个 Tensor，其数据类型和设备是此模块中所有参数和缓冲区的目标数据类型和设备

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

返回

self

返回类型

Module

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> 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)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> 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

training: bool

type(dst_type)

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

注意

此方法修改模块原地。

参数

dst_type (type 或 string) – 目标类型

返回

self

返回类型

Module

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

返回类型

None

class darts.models.components.layer_norm_variants.RINorm(input_dim, eps=1e-05, affine=True)

基类：Module

基于 [1] 的可逆实例归一化

参数

• input_dim (int) – 被归一化的输入轴的维度

• eps – 用于数值稳定性的 epsilon 值

• affine – 归一化后是否应用仿射变换

参考文献

1

Kim et al. “Reversible Instance Normalization for Accurate Time-Series Forecasting against Distribution Shift” International Conference on Learning Representations (2022)

方法

add_module(name, module)	向当前模块添加子模块。
apply(fn)	递归地将 fn 应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此模块的 forward。
cpu()	将所有模型参数和缓冲区移至 CPU。
cuda([device])	将所有模型参数和缓冲区移至 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(x)	定义每次调用时执行的计算。
get_buffer(target)	如果缓冲区 target 存在，则返回该缓冲区，否则抛出错误。
get_extra_state()	返回要包含在模块 state_dict 中的任何额外状态。
get_parameter(target)	如果参数 target 存在，则返回该参数，否则抛出错误。
get_submodule(target)	如果子模块 target 存在，则返回该子模块，否则抛出错误。
half()	将所有浮点参数和缓冲区转换为 half 数据类型。
ipu([device])	将所有模型参数和缓冲区移至 IPU。
load_state_dict(state_dict[, strict, assign])	将 state_dict 中的参数和缓冲区复制到此模块及其后代中。
modules()	返回网络中所有模块的迭代器。
mtia([device])	将所有模型参数和缓冲区移至 MTIA。
named_buffers([prefix, recurse, ...])	返回模块缓冲区的迭代器，同时产生缓冲区的名称和缓冲区本身。
named_children()	返回直接子模块的迭代器，同时产生模块的名称和模块本身。
named_modules([memo, prefix, remove_duplicate])	返回网络中所有模块的迭代器，同时产生模块的名称和模块本身。
named_parameters([prefix, recurse, ...])	返回模块参数的迭代器，同时产生参数的名称和参数本身。
parameters([recurse])	返回模块参数的迭代器。
register_backward_hook(hook)	在模块上注册后向钩子。
register_buffer(name, tensor[, persistent])	向模块添加缓冲区。
register_forward_hook(hook, *[, prepend, ...])	在模块上注册前向钩子。
register_forward_pre_hook(hook, *[, ...])	在模块上注册前向预钩子。
register_full_backward_hook(hook[, prepend])	在模块上注册后向钩子。
register_full_backward_pre_hook(hook[, prepend])	在模块上注册后向预钩子。
register_load_state_dict_post_hook(hook)	注册后置钩子，在调用模块的 load_state_dict() 后运行。
register_load_state_dict_pre_hook(hook)	注册前置钩子，在调用模块的 load_state_dict() 前运行。
register_module(name, module)	add_module() 的别名。
register_parameter(name, param)	向模块添加参数。
register_state_dict_post_hook(hook)	为 state_dict() 方法注册后置钩子。
register_state_dict_pre_hook(hook)	为 state_dict() 方法注册前置钩子。
requires_grad_([requires_grad])	更改 autograd 是否应记录此模块参数上的操作。
set_extra_state(state)	设置加载的 state_dict 中包含的额外状态。
set_submodule(target, module)	如果子模块 target 存在，则设置该子模块，否则抛出错误。
share_memory()	参见 torch.Tensor.share_memory_()。
state_dict(*args[, destination, prefix, ...])	返回包含模块整个状态引用的字典。
to(*args, **kwargs)	移动和/或转换参数和缓冲区。
to_empty(*, device[, recurse])	将参数和缓冲区移至指定的设备，而不复制存储。
train([mode])	将模块设置为训练模式。
type(dst_type)	将所有参数和缓冲区转换为 dst_type。
xpu([device])	将所有模型参数和缓冲区移至 XPU。
zero_grad([set_to_none])	重置所有模型参数的梯度。

__call__
逆向

T_destination

TypeVar(‘T_destination’, bound=Dict[str, Any]) 的别名

add_module(name, module)

向当前模块添加子模块。

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

参数

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

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

返回类型

None

apply(fn)

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

典型用法包括初始化模型参数（另见 nn-init-doc）。

参数

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 – 模块缓冲区

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

返回类型

Iterator[Tensor]

call_super_init: bool = False

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

dump_patches: bool = False

eval()

将模块设置为评估模式。

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

这等同于 self.train(False)。

有关 .eval() 与可能混淆的几种类似机制的比较，请参阅 locally-disable-grad-doc。

返回

self

返回类型

Module

extra_repr()

返回模块的额外表示。

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

返回类型

str

float()

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

注意

此方法修改模块原地。

返回

self

返回类型

Module

forward(x)

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

应由所有子类覆盖。

注意

尽管 forward pass 的方法需要在函数内部定义，但之后应该调用 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 的正常序列化。我们仅为序列化 Tensor 提供向后兼容性保证；如果其他对象的序列化 pickle 形式发生变化，可能会破坏向后兼容性。

返回

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

返回类型

object

get_parameter(target)

如果参数 target 存在，则返回该参数，否则抛出错误。

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

参数

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

返回

由 target 引用的 Parameter

返回类型

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

inverse(x)

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*, *optional*) – 是否严格要求 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值: True

• assign (bool, optional) – 当设置为 False 时，将保留当前模块中张量的属性，而将其设置为 True 时，将保留 state dict 中张量的属性。唯一的例外是 requires_grad 字段。 默认值: ``False`

返回

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

  由此模块所有但缺失于所提供的 state_dict 中。

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

  由此模块所需但存在于所提供的 state_dict 中。

返回类型

NamedTuple，包含 missing_keys 和 unexpected_keys 字段

注意

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

modules()

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

生成

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)

返回类型

Iterator[Module]

mtia(device=None)

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

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

注意

此方法修改模块原地。

参数

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

返回

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) – 包含名称和缓冲区的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

返回类型

Iterator[Tuple[str, Tensor]]

named_children()

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

生成

(str, Module) – 包含名称和子模块的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

返回类型

Iterator[Tuple[str, Module]]

named_modules(memo=None, prefix='', remove_duplicate=True)

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

参数

• memo (Optional[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) – 包含名称和参数的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

返回类型

Iterator[Tuple[str, Parameter]]

parameters(recurse=True)

返回模块参数的迭代器。

这通常会传递给优化器。

参数

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

生成

Parameter – 模块参数

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for param in model.parameters():
>>>     print(type(param), param.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

返回类型

Iterator[Parameter]

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 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

返回类型

None

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 钩子将接收传递给 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 pre-hook 将接收传递给 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。

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

警告

使用 backward hooks 时不允许原地修改输入或输出，并且会引发错误。

参数

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

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

警告

使用 backward hooks 时不允许原地修改输入，并且会引发错误。

参数

• 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 of str，unexpected_keys 是一个包含意外键的 list of 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) – 可调用钩子，将在加载 state dict 前调用。

register_module(name, module)

add_module() 的别名。

返回类型

None

register_parameter(name, param)

向模块添加参数。

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

参数

• name (str) – 参数的名称。可以使用给定的名称从当前模块访问该参数

• param (*Parameter* 或 *None*) – 要添加到模块的参数。如果为 None，则忽略对参数进行的操作（例如 cuda）。如果为 None，则该参数**不**包含在模块的 state_dict 中。

返回类型

None

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)

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

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

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

有关 .requires_grad_() 与可能混淆的几种类似机制的比较，请参阅 locally-disable-grad-doc。

参数

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 中的额外状态

返回类型

None

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

返回类型

None

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

返回

包含模块完整状态的字典

返回类型

字典

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> 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 Tensors 移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法修改模块原地。

参数

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

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

• tensor (torch.Tensor) – 一个 Tensor，其数据类型和设备是此模块中所有参数和缓冲区的目标数据类型和设备

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

返回

self

返回类型

Module

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> 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)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> 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

training: bool

type(dst_type)

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

注意

此方法修改模块原地。

参数

dst_type (type 或 string) – 目标类型

返回

self

返回类型

Module

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

返回类型

None

class darts.models.components.layer_norm_variants.RMSNorm(dim, eps=1e-08)

基类：Module

一种替代层归一化的方法，无需均值中心化和学习到的偏置 [1]

参考文献

1

Zhang, Biao, and Rico Sennrich. “Root mean square layer normalization.” Advances in Neural Information Processing Systems 32 (2019).

方法

add_module(name, module)	向当前模块添加子模块。
apply(fn)	递归地将 fn 应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此模块的 forward。
cpu()	将所有模型参数和缓冲区移至 CPU。
cuda([device])	将所有模型参数和缓冲区移至 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(x)	定义每次调用时执行的计算。
get_buffer(target)	如果缓冲区 target 存在，则返回该缓冲区，否则抛出错误。
get_extra_state()	返回要包含在模块 state_dict 中的任何额外状态。
get_parameter(target)	如果参数 target 存在，则返回该参数，否则抛出错误。
get_submodule(target)	如果子模块 target 存在，则返回该子模块，否则抛出错误。
half()	将所有浮点参数和缓冲区转换为 half 数据类型。
ipu([device])	将所有模型参数和缓冲区移至 IPU。
load_state_dict(state_dict[, strict, assign])	将参数和缓冲区从 state_dict 复制到此模块及其后代中。
modules()	返回网络中所有模块的迭代器。
mtia([device])	将所有模型参数和缓冲区移至 MTIA。
named_buffers([prefix, recurse, ...])	返回模块缓冲区的迭代器，同时产生缓冲区的名称和缓冲区本身。
named_children()	返回直接子模块的迭代器，同时产生模块的名称和模块本身。
named_modules([memo, prefix, remove_duplicate])	返回网络中所有模块的迭代器，同时产生模块的名称和模块本身。
named_parameters([prefix, recurse, ...])	返回模块参数的迭代器，同时产生参数的名称和参数本身。
parameters([recurse])	返回模块参数的迭代器。
register_backward_hook(hook)	在模块上注册后向钩子。
register_buffer(name, tensor[, persistent])	向模块添加缓冲区。
这通常用于注册不应被视为模型参数的缓冲区。例如，BatchNorm 的 running_mean 不是参数，而是模块状态的一部分。默认情况下，缓冲区是持久的，将与参数一起保存。可以通过将 persistent 设置为 False 来更改此行为。持久缓冲区和非持久缓冲区之间的唯一区别在于，非持久缓冲区将不会成为此模块的 state_dict 的一部分。	在模块上注册前向钩子。
tensor (*Tensor* 或 *None*) – 要注册的缓冲区。如果为 None，则忽略对缓冲区进行的操作（例如 cuda）。如果为 None，则该缓冲区**不**包含在模块的 state_dict 中。	在模块上注册前向预钩子。
persistent (*bool*) – 缓冲区是否是此模块的 state_dict 的一部分。	在模块上注册后向钩子。
register_forward_hook(hook, *, prepend=False, with_kwargs=False, always_call=False)	在模块上注册后向预钩子。
每次在 forward() 计算出输出后，都会调用此钩子。	注册后置钩子，在调用模块的 load_state_dict() 后运行。
如果 with_kwargs 为 False 或未指定，则输入仅包含提供给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。钩子可以修改输出。它可以就地修改输入，但由于此钩子是在 forward() 调用后调用，因此对 forward 没有影响。钩子应具有以下签名：	注册前置钩子，在调用模块的 load_state_dict() 前运行。
register_forward_pre_hook(hook, *, prepend=False, with_kwargs=False)	每次在调用 forward() 之前，都会调用此钩子。
register_full_backward_hook(hook, prepend=False)	向模块添加参数。
register_full_backward_pre_hook(hook, prepend=False)	为 state_dict() 方法注册后置钩子。
register_load_state_dict_post_hook(hook)	为 state_dict() 方法注册前置钩子。
请注意，在使用 strict=True 调用 load_state_dict() 时执行的检查，会受到钩子对 missing_keys 或 unexpected_keys 所做修改的影响，这是符合预期的。向任一键集合添加键都将在 strict=True 时导致抛出错误，而清除所有丢失和意外的键将避免错误。	更改 autograd 是否应记录此模块参数上的操作。
register_load_state_dict_pre_hook(hook)	设置加载的 state_dict 中包含的额外状态。
register_module(name, module)	如果子模块 target 存在，则设置该子模块，否则抛出错误。
share_memory()	参见 torch.Tensor.share_memory_()。
add_module() 的别名。	返回包含模块整个状态引用的字典。
register_parameter(name, param)	移动和/或转换参数和缓冲区。
param (*Parameter* 或 *None*) – 要添加到模块的参数。如果为 None，则忽略对参数进行的操作（例如 cuda）。如果为 None，则该参数**不**包含在模块的 state_dict 中。	将参数和缓冲区移至指定的设备，而不复制存储。
register_state_dict_post_hook(hook)	将模块设置为训练模式。
register_state_dict_pre_hook(hook)	将所有参数和缓冲区转换为 dst_type。
requires_grad_(requires_grad=True)	将所有模型参数和缓冲区移至 XPU。
set_extra_state(state)	重置所有模型参数的梯度。

__call__

初始化内部模块状态，由 nn.Module 和 ScriptModule 共享。

方法

add_module(name, module)	向当前模块添加子模块。
apply(fn)	递归地将 fn 应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此模块的 forward。
cpu()	将所有模型参数和缓冲区移至 CPU。
cuda([device])	将所有模型参数和缓冲区移至 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(x)	定义每次调用时执行的计算。
get_buffer(target)	如果缓冲区 target 存在，则返回该缓冲区，否则抛出错误。
get_extra_state()	返回要包含在模块 state_dict 中的任何额外状态。
get_parameter(target)	如果参数 target 存在，则返回该参数，否则抛出错误。
get_submodule(target)	如果子模块 target 存在，则返回该子模块，否则抛出错误。
half()	将所有浮点参数和缓冲区转换为 half 数据类型。
ipu([device])	将所有模型参数和缓冲区移至 IPU。
load_state_dict(state_dict[, strict, assign])	将参数和缓冲区从 state_dict 复制到此模块及其后代中。
modules()	返回网络中所有模块的迭代器。
mtia([device])	将所有模型参数和缓冲区移至 MTIA。
named_buffers([prefix, recurse, ...])	返回模块缓冲区的迭代器，同时产生缓冲区的名称和缓冲区本身。
named_children()	返回直接子模块的迭代器，同时产生模块的名称和模块本身。
named_modules([memo, prefix, remove_duplicate])	返回网络中所有模块的迭代器，同时产生模块的名称和模块本身。
named_parameters([prefix, recurse, ...])	返回模块参数的迭代器，同时产生参数的名称和参数本身。
parameters([recurse])	返回模块参数的迭代器。
register_backward_hook(hook)	在模块上注册后向钩子。
register_buffer(name, tensor[, persistent])	向模块添加缓冲区。
这通常用于注册不应被视为模型参数的缓冲区。例如，BatchNorm 的 running_mean 不是参数，而是模块状态的一部分。默认情况下，缓冲区是持久的，将与参数一起保存。可以通过将 persistent 设置为 False 来更改此行为。持久缓冲区和非持久缓冲区之间的唯一区别在于，非持久缓冲区将不会成为此模块的 state_dict 的一部分。	在模块上注册前向钩子。
tensor (*Tensor* 或 *None*) – 要注册的缓冲区。如果为 None，则忽略对缓冲区进行的操作（例如 cuda）。如果为 None，则该缓冲区**不**包含在模块的 state_dict 中。	在模块上注册前向预钩子。
persistent (*bool*) – 缓冲区是否是此模块的 state_dict 的一部分。	在模块上注册后向钩子。
register_forward_hook(hook, *, prepend=False, with_kwargs=False, always_call=False)	在模块上注册后向预钩子。
每次在 forward() 计算出输出后，都会调用此钩子。	注册后置钩子，在调用模块的 load_state_dict() 后运行。
如果 with_kwargs 为 False 或未指定，则输入仅包含提供给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。钩子可以修改输出。它可以就地修改输入，但由于此钩子是在 forward() 调用后调用，因此对 forward 没有影响。钩子应具有以下签名：	注册前置钩子，在调用模块的 load_state_dict() 前运行。
register_forward_pre_hook(hook, *, prepend=False, with_kwargs=False)	每次在调用 forward() 之前，都会调用此钩子。
register_full_backward_hook(hook, prepend=False)	向模块添加参数。
register_full_backward_pre_hook(hook, prepend=False)	为 state_dict() 方法注册后置钩子。
register_load_state_dict_post_hook(hook)	为 state_dict() 方法注册前置钩子。
请注意，在使用 strict=True 调用 load_state_dict() 时执行的检查，会受到钩子对 missing_keys 或 unexpected_keys 所做修改的影响，这是符合预期的。向任一键集合添加键都将在 strict=True 时导致抛出错误，而清除所有丢失和意外的键将避免错误。	更改 autograd 是否应记录此模块参数上的操作。
register_load_state_dict_pre_hook(hook)	设置加载的 state_dict 中包含的额外状态。
register_module(name, module)	如果子模块 target 存在，则设置该子模块，否则抛出错误。
share_memory()	参见 torch.Tensor.share_memory_()。
add_module() 的别名。	返回包含模块整个状态引用的字典。
register_parameter(name, param)	移动和/或转换参数和缓冲区。
param (*Parameter* 或 *None*) – 要添加到模块的参数。如果为 None，则忽略对参数进行的操作（例如 cuda）。如果为 None，则该参数**不**包含在模块的 state_dict 中。	将参数和缓冲区移至指定的设备，而不复制存储。
register_state_dict_post_hook(hook)	将模块设置为训练模式。
register_state_dict_pre_hook(hook)	将所有参数和缓冲区转换为 dst_type。
requires_grad_(requires_grad=True)	将所有模型参数和缓冲区移至 XPU。
set_extra_state(state)	重置所有模型参数的梯度。

__call__

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

TypeVar(‘T_destination’, bound=Dict[str, Any]) 的别名

set_submodule(target, module)

向当前模块添加子模块。

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

参数

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

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

返回类型

None

share_memory()

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

典型用法包括初始化模型参数（另见 nn-init-doc）。

参数

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

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

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

注意

此方法修改模块原地。

返回

self

返回类型

Module

to(*args, **kwargs)

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

参数

recurse (bool) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，仅生成直接属于此模块的缓冲区。

生成

torch.Tensor – 模块缓冲区

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

返回类型

Iterator[Tensor]

to_empty(*, device, recurse=True)

train(mode=True)

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

生成

Module – 子模块

返回类型

Iterator[Module]

training: bool

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

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

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

type(dst_type)

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

注意

此方法修改模块原地。

返回

self

返回类型

Module

xpu(device=None)

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

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

注意

此方法修改模块原地。

参数

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

返回

self

返回类型

Module

zero_grad(set_to_none=True)

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

注意

此方法修改模块原地。

返回

self

返回类型

Module

T_destination

add_module(name, module)

将模块设置为评估模式。

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

这等同于 self.train(False)。

有关 .eval() 与可能混淆的几种类似机制的比较，请参阅 locally-disable-grad-doc。

返回

self

返回类型

Module

apply(fn)

返回模块的额外表示。

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

返回类型

str

bfloat16()

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

注意

此方法修改模块原地。

返回

self

返回类型

Module

buffers(recurse=True)

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

应由所有子类覆盖。

注意

尽管 forward pass 的方法需要在函数内部定义，但之后应该调用 Module 实例而不是此函数本身，因为前者负责运行已注册的钩子，而后者会默默地忽略它们。

call_super_init: bool = False

如果缓冲区 target 存在，则返回该缓冲区，否则抛出错误。

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

参数

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

返回

由 target 引用的缓冲区

返回类型

torch.Tensor

抛出

AttributeError – 如果目标字符串引用了无效路径或解析为非缓冲区

children()

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

compile(*args, **kwargs)

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

返回

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

返回类型

object

cpu()

如果参数 target 存在，则返回该参数，否则抛出错误。

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

参数

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

返回

由 target 引用的 Parameter

返回类型

torch.nn.Parameter

抛出

AttributeError – 如果目标字符串引用了无效路径或解析为非 nn.Parameter

cuda(device=None)

如果子模块 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

double()

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

注意

此方法修改模块原地。

返回

self

返回类型

Module

dump_patches: bool = False

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

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

注意

此方法修改模块原地。

参数

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

返回

self

返回类型

Module

eval()

将参数和缓冲区从 state_dict 复制到此模块及其后代中。

extra_repr()

警告

float()

参数

• state_dict (dict) – 包含参数和持久缓冲区的字典。

• forward(x)

• assign (bool, optional) – 当设置为 False 时，将保留当前模块中张量的属性，而将其设置为 True 时，将保留 state dict 中张量的属性。唯一的例外是 requires_grad 字段。 默认值: ``False`

返回

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

  由此模块所有但缺失于所提供的 state_dict 中。

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

  由此模块所需但存在于所提供的 state_dict 中。

返回类型

NamedTuple，包含 missing_keys 和 unexpected_keys 字段

注意

get_buffer(target)

get_extra_state()

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

生成

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)

返回类型

Iterator[Module]

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

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

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

注意

此方法修改模块原地。

参数

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

返回

self

返回类型

Module

get_parameter(target)

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

参数

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

• recurse (bool, optional) – 如果为 True，则生成此模块和所有子模块的缓冲区。否则，仅生成直接属于此模块的缓冲区。默认值: True。

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

生成

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

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

返回类型

Iterator[Tuple[str, Tensor]]

get_submodule(target)

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

生成

(str, Module) – 包含名称和子模块的元组

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

返回类型

Iterator[Tuple[str, Module]]

half()

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

参数

• memo (Optional[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))

ipu(device=None)

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

参数

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

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

• remove_duplicate (bool, optional) – 是否移除结果中重复的参数。默认值: True。

生成

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

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

返回类型

Iterator[Tuple[str, Parameter]]

load_state_dict(state_dict, strict=True, assign=False)

返回模块参数的迭代器。

这通常会传递给优化器。

参数

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

生成

Parameter – 模块参数

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for param in model.parameters():
>>>     print(type(param), param.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

返回类型

Iterator[Parameter]

如果 strict 为 True，则 state_dict 的键必须与此模块的 state_dict() 函数返回的键完全匹配。

在模块上注册后向钩子。

此函数已弃用，推荐使用 register_full_backward_hook()，此函数的行为将在未来版本中更改。

返回

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

返回类型

torch.utils.hooks.RemovableHandle

如果 assign 为 True，则必须在调用 load_state_dict 后创建优化器，除非 get_swap_module_params_on_conversion() 为 True。

向模块添加缓冲区。

strict (*bool*, *optional*) – 是否严格要求 state_dict 中的键与此模块的 state_dict() 函数返回的键匹配。默认值: True

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

参数

• name (str) – 缓冲区的名称。可以使用给定的名称从当前模块访问该缓冲区

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

• modules()

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

返回类型

None

mtia(device=None)

在模块上注册前向钩子。

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

named_children()

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

如果 with_kwargs 为 True，则 forward 钩子将接收传递给 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

named_modules(memo=None, prefix='', remove_duplicate=True)

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

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

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

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

如果 with_kwargs 为 true，则 forward pre-hook 将接收传递给 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

parameters(recurse=True)

在模块上注册后向钩子。

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

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。

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

警告

使用 backward hooks 时不允许原地修改输入或输出，并且会引发错误。

参数

• 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_backward_hook(hook)

在模块上注册后向预钩子。

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

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

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

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

警告

使用 backward hooks 时不允许原地修改输入，并且会引发错误。

参数

• 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_buffer(name, tensor, persistent=True)

注册后置钩子，在调用模块的 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。

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

返回

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

返回类型

torch.utils.hooks.RemovableHandle

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

注册前置钩子，在调用模块的 load_state_dict() 前运行。

其签名应如下：

hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

参数

hook (Callable) – 可调用钩子，将在加载 state dict 前调用。

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

每次在调用 forward() 之前，都会调用此钩子。

返回类型

None

register_forward_hook(hook, *, prepend=False, with_kwargs=False, always_call=False)

向模块添加参数。

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

参数

• name (str) – 参数的名称。可以使用给定的名称从当前模块访问该参数

• 每次在 forward() 计算出输出后，都会调用此钩子。

返回类型

None

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

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

其签名应如下：

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

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

register_forward_pre_hook(hook, *, prepend=False, with_kwargs=False)

为 state_dict() 方法注册前置钩子。

其签名应如下：

hook(module, prefix, keep_vars) -> None

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

每次在调用 forward() 之前，都会调用此钩子。

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

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

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

有关 .requires_grad_() 与可能混淆的几种类似机制的比较，请参阅 locally-disable-grad-doc。

参数

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

返回

self

返回类型

Module

register_full_backward_hook(hook, prepend=False)

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

register_full_backward_pre_hook(hook, prepend=False)

参数

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

返回类型

None

register_load_state_dict_post_hook(hook)

如果子模块 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

返回类型

None

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

参见 torch.Tensor.share_memory_()。

返回类型

~T

register_load_state_dict_pre_hook(hook)

返回包含模块整个状态引用的字典。

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

注意

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

警告

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

警告

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

参数

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

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

• keep_vars (bool, 可选) – 默认情况下，state dict 中返回的 Tensor 会从自动梯度中分离。如果设置为 True，则不会执行分离操作。默认值：False。

返回

包含模块完整状态的字典

返回类型

字典

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']

register_module(name, module)

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

可以按如下方式调用：

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

请参阅下面的示例。

注意

此方法修改模块原地。

参数

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

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

• tensor (torch.Tensor) – 一个 Tensor，其数据类型和设备是此模块中所有参数和缓冲区的目标数据类型和设备

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

返回

self

返回类型

Module

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> 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)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> 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)

register_parameter(name, param)

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

参数

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

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

返回

self

返回类型

Module

param (*Parameter* 或 *None*) – 要添加到模块的参数。如果为 None，则忽略对参数进行的操作（例如 cuda）。如果为 None，则该参数**不**包含在模块的 state_dict 中。

将模块设置为训练模式。

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

参数

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

返回

self

返回类型

Module

register_state_dict_post_hook(hook)

register_state_dict_pre_hook(hook)

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

注意

此方法修改模块原地。

参数

dst_type (type 或 string) – 目标类型

返回

self

返回类型

Module

requires_grad_(requires_grad=True)

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

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

注意

此方法修改模块原地。

参数

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

返回

self

返回类型

Module

set_extra_state(state)

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

请参阅 torch.optim.Optimizer 下的类似函数以获取更多上下文。

参数

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

返回类型

None

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