class darts.models.components.transformer.CustomFeedForwardDecoderLayer(ffn, dropout, *args, **kwargs)

基类: TransformerDecoderLayer

重写 PyTorch TransformerDecoderLayer 以使用 Darts 的自定义 Position Wise Feed Forward 层。

方法

add_module(name, module)	将子模块添加到当前模块。
apply(fn)	将 fn 递归地应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此 Module 的 forward。
cpu()	将所有模型参数和缓冲区移动到 CPU。
cuda([device])	将所有模型参数和缓冲区移动到 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(tgt, memory[, tgt_mask, ...])	将输入（和掩码）通过解码器层。
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__

参数

• ffn (Module) – 来自 darts.models.components.glu_variants 的 Darts 位置感知前馈网络变体之一

• dropout (float) – 受 Dropout 影响的神经元比例（默认值=0.1）。

• args – 来自 torch.nn.TransformerEncoderLayer 的位置参数。

• kwargs – 来自 torch.nn.TransformerEncoderLayer 的关键字参数。activation 将不起作用。

方法

add_module(name, module)	将子模块添加到当前模块。
apply(fn)	将 fn 递归地应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此 Module 的 forward。
cpu()	将所有模型参数和缓冲区移动到 CPU。
cuda([device])	将所有模型参数和缓冲区移动到 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(tgt, memory[, tgt_mask, ...])	将输入（和掩码）通过解码器层。
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() 编译此 Module 的 forward。

此 Module 的 __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(tgt, memory, tgt_mask=None, memory_mask=None, tgt_key_padding_mask=None, memory_key_padding_mask=None, tgt_is_causal=False, memory_is_causal=False)

将输入（和掩码）通过解码器层。

参数

• tgt (Tensor) – 解码器层的输入序列（必需）。

• memory (Tensor) – 来自编码器最后一层的序列（必需）。

• tgt_mask (Optional[Tensor, None]) – tgt 序列的掩码（可选）。

• memory_mask (Optional[Tensor, None]) – memory 序列的掩码（可选）。

• tgt_key_padding_mask (Optional[Tensor, None]) – 每个批次 tgt 键的掩码（可选）。

• memory_key_padding_mask (Optional[Tensor, None]) – 每个批次 memory 键的掩码（可选）。

• tgt_is_causal (bool) – 如果指定，则应用因果掩码作为 tgt mask。默认值：False。警告：tgt_is_causal 暗示 tgt_mask 是因果掩码。提供不正确的暗示可能导致执行错误，包括前向和后向兼容性。

• memory_is_causal (bool) – 如果指定，则应用因果掩码作为 memory mask。默认值：False。警告：memory_is_causal 暗示 memory_mask 是因果掩码。提供不正确的暗示可能导致执行错误，包括前向和后向兼容性。

形状

参见 Transformer 的文档。

返回类型

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() 时会调用此函数。

请注意，额外状态应该是可 pickle 化的，以确保 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_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 时，保留当前模块中 Tensor 的属性，而设置为 True 时则保留 state dict 中 Tensor 的属性。唯一的例外是 requires_grad 字段。默认值：False

返回值

• missing_keys 是一个包含预期键的 str 列表

  此模块预期但提供的 state_dict 中缺失的任何键。

• unexpected_keys 是一个包含非预期键的 str 列表

  此模块不预期但提供的 state_dict 中存在的键。

返回类型

具有 missing_keys 和 unexpected_keys 字段的 NamedTuple

注意

如果参数或缓冲区注册为 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 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 函数的 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，无论调用 Module 时是否引发异常，hook 都将运行。默认值：False

返回值

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

返回类型

torch.utils.hooks.RemovableHandle

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

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

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

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

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

如果 with_kwargs 为 true，前向预钩子将接收传递给 forward 函数的 kwargs。如果钩子修改了输入，则应同时返回 args 和 kwargs。钩子应该具有以下签名：

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

参数

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

• prepend (bool) – 如果为 true，提供的 hook 将在此 torch.nn.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。

出于技术原因，当此钩子应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。同样，调用者也将接收 Module 的 forward 函数返回的每个 Tensor 的视图。

警告

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

参数

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

出于技术原因，当此钩子应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。同样，调用者也将接收 Module 的 forward 函数返回的每个 Tensor 的视图。

警告

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

参数

• 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 是一个包含缺失键的 str 列表，unexpected_keys 是一个包含非预期键的 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 之前将调用的 Callable 钩子。

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

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, optional) – 如果提供，模块的状态将更新到此字典中并返回同一对象。否则，将创建一个并返回 OrderedDict。默认值：None。

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

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

返回值

包含模块完整状态的字典

返回类型

dict

示例

>>> # 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（如果给定），但 dtype 不变。当设置 non_blocking 时，如果可能，它会尝试相对于主机异步进行转换/移动，例如，将带有固定内存的 CPU Tensor 移动到 CUDA 设备。

示例见下文。

注意

此方法会就地修改模块。

参数

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

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

• tensor (torch.Tensor) – 其 dtype 和 device 是此模块中所有参数和缓冲区的目标 dtype 和 device 的 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.transformer.CustomFeedForwardEncoderLayer(ffn, dropout, *args, **kwargs)

基类：TransformerEncoderLayer

覆盖 PyTorch TransformerEncoderLayer 以使用 Darts 的逐位置前馈变体。

方法

add_module(name, module)	将子模块添加到当前模块。
apply(fn)	将 fn 递归地应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此 Module 的 forward。
cpu()	将所有模型参数和缓冲区移动到 CPU。
cuda([device])	将所有模型参数和缓冲区移动到 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(src[, src_mask, ...])	将输入通过编码器层。
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__

参数

• ffn (Module) – 来自 darts.models.components.glu_variants 的 Darts 位置感知前馈网络变体之一

• dropout (float) – 受 Dropout 影响的神经元比例（默认为 0.1）。

• args – 来自 torch.nn.TransformerEncoderLayer 的位置参数。

• kwargs – 来自 torch.nn.TransformerEncoderLayer 的关键字参数。activation 将不起作用。

方法

add_module(name, module)	将子模块添加到当前模块。
apply(fn)	将 fn 递归地应用于每个子模块（由 .children() 返回）以及自身。
bfloat16()	将所有浮点参数和缓冲区转换为 bfloat16 数据类型。
buffers([recurse])	返回模块缓冲区的迭代器。
children()	返回直接子模块的迭代器。
compile(*args, **kwargs)	使用 torch.compile() 编译此 Module 的 forward。
cpu()	将所有模型参数和缓冲区移动到 CPU。
cuda([device])	将所有模型参数和缓冲区移动到 GPU。
double()	将所有浮点参数和缓冲区转换为 double 数据类型。
eval()	将模块设置为评估模式。
extra_repr()	返回模块的额外表示。
float()	将所有浮点参数和缓冲区转换为 float 数据类型。
forward(src[, src_mask, ...])	将输入通过编码器层。
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() 编译此 Module 的 forward。

此 Module 的 __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(src, src_mask=None, src_key_padding_mask=None, is_causal=False)

将输入通过编码器层。

参数

• src (Tensor) – 编码器层的输入序列（必需）。

• src_mask (Optional[Tensor, None]) – src 序列的掩码（可选）。

• src_key_padding_mask (Optional[Tensor, None]) – 每批次 src 键的掩码（可选）。

• is_causal (bool) – 如果指定，则将因果掩码应用于 src mask。默认值：False。警告：is_causal 提示 src_mask 是因果掩码。提供不正确的提示可能导致执行错误，包括前向和后向兼容性问题。

形状

参见 Transformer 的文档。

返回类型

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

请注意，额外状态应该是可 pickle 化的，以确保 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_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 时，保留当前模块中 Tensor 的属性，而设置为 True 时则保留 state dict 中 Tensor 的属性。唯一的例外是 requires_grad 字段。默认值：False

返回值

• missing_keys 是一个包含预期键的 str 列表

  此模块预期但提供的 state_dict 中缺失的任何键。

• unexpected_keys 是一个包含非预期键的 str 列表

  此模块不预期但提供的 state_dict 中存在的键。

返回类型

具有 missing_keys 和 unexpected_keys 字段的 NamedTuple

注意

如果参数或缓冲区注册为 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() 计算出输出后，都会调用此 hook。

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

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

如果 with_kwargs 为 True，前向钩子将接收传递给 forward 函数的 kwargs，并应返回可能修改后的输出。钩子应该具有以下签名：

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

参数

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

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

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

• always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，hook 都将运行。默认值：False

返回值

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

返回类型

torch.utils.hooks.RemovableHandle

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

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

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

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

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

如果 with_kwargs 为 true，前向预钩子将接收传递给 forward 函数的 kwargs。如果钩子修改了输入，则应同时返回 args 和 kwargs。钩子应该具有以下签名：

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

参数

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

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

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

返回值

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

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)

在模块上注册反向钩子。

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

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

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

出于技术原因，当此钩子应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。同样，调用者也将接收 Module 的 forward 函数返回的每个 Tensor 的视图。

警告

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

参数

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

出于技术原因，当此钩子应用于 Module 时，其 forward 函数将接收传递给 Module 的每个 Tensor 的视图。同样，调用者也将接收 Module 的 forward 函数返回的每个 Tensor 的视图。

警告

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

参数

• 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 是一个包含缺失键的 str 列表，unexpected_keys 是一个包含非预期键的 str 列表。

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

请注意，当调用 load_state_dict() 并设置 strict=True 时执行的检查会受到 hook 对 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 之前将调用的 Callable 钩子。

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, optional) – 如果提供，模块的状态将更新到此字典中并返回同一对象。否则，将创建一个并返回 OrderedDict。默认值：None。

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

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

返回值

包含模块完整状态的字典

返回类型

dict

示例

>>> # 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（如果给定），但 dtype 不变。当设置 non_blocking 时，如果可能，它会尝试相对于主机异步进行转换/移动，例如，将带有固定内存的 CPU Tensor 移动到 CUDA 设备。

示例见下文。

注意

此方法会就地修改模块。

参数

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

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

• tensor (torch.Tensor) – 其 dtype 和 device 是此模块中所有参数和缓冲区的目标 dtype 和 device 的 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

上一页

<无标题>

下一页

过滤模型