MIT 许可证 (MIT)

版权所有 (c) 2020 Varuna Jayasiri

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

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

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

— title: 位置前馈网络 (FFN) summary: 位置前馈网络的文档化可复用实现。—

# 位置前馈网络 (FFN) 这是 Transformer 中使用的位置前馈网络的一个 [PyTorch](https://pytorch.ac.cn) 实现。

FFN 由两个全连接层组成。隐藏层的维度 $d_{ff}$ 通常设置为词元嵌入 $d_{model}$ 的四倍左右。因此它有时也被称为扩展-收缩网络。

隐藏层有一个激活函数，通常设置为 ReLU（修正线性单元）激活函数，$$max(0, x)$$

也就是说，FFN 函数是：$$FFN(x, W_1, W_2, b_1, b_2) = max(0, x W_1 + b_1) W_2 + b_2$$ 其中 $W_1$、$W_2$、$b_1$ 和 $b_2$ 是可学习参数。

有时也会使用 GELU（高斯误差线性单元）激活函数代替 ReLU。$$x Phi(x)$$ 其中 $Phi(x) = P(X le x), X sim mathcal{N}(0,1)$ ### 门控线性单元

这是一个通用实现，支持不同的变体，包括 [门控线性单元](https://papers.labml.ai/paper/2002.05202) (GLU)。

class darts.models.components.feed_forward.FeedForward(d_model, d_ff, dropout=0.1, activation=ReLU(), is_gated=False, bias1=True, bias2=True, bias_gate=True)[source]

基类: Module

## FFN 模块

来源 [前馈网络](https://arxiv.org/abs/2002.05202)

方法

add_module(name, module)

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

apply(fn)

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

bfloat16()

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

buffers([recurse])

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

children()

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

compile(*args, **kwargs)

使用 torch.compile() 编译此模块的前向传播。

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__

  • d_model 是词元嵌入中的特征数量

  • d_ff 是 FFN 隐藏层中的特征数量

  • dropout 是隐藏层的 dropout 概率，

    在推理时兼容 Monte Carlo dropout

  • is_gated 指定隐藏层是否为门控

  • bias1 指定第一个全连接层是否应具有可学习的偏置

  • bias2 指定第二个全连接层是否应具有可学习的偏置

  • bias_gate 指定门控的全连接层是否应具有可学习的偏置

方法

add_module(name, module)

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

apply(fn)

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

bfloat16()

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

buffers([recurse])

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

children()

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

compile(*args, **kwargs)

使用 torch.compile() 编译此模块的前向传播。

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) – 要添加到模块的子模块。

返回类型

无

apply(fn)

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

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

参数

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

返回

自身

返回类型

模块

示例

>>> @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 数据类型。

注意

此方法会原地修改模块。

返回

自身

返回类型

模块

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() 编译此模块的前向传播。

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

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

cpu()

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

注意

此方法会原地修改模块。

返回

自身

返回类型

模块

cuda(device=None)

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

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

注意

此方法会原地修改模块。

参数

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

返回

自身

返回类型

模块

double()

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

注意

此方法会原地修改模块。

返回

自身

返回类型

模块

dump_patches: bool = False
eval()

将模块设置为评估模式。

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

这等同于 self.train(False)。

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

返回

自身

返回类型

模块

extra_repr()

返回模块的额外表示。

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

返回类型

str

float()

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

注意

此方法会原地修改模块。

返回

自身

返回类型

模块

forward(x)[source]

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

应由所有子类覆盖。

注意

虽然前向传播的计算过程需要在函数内部定义，但之后应调用 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() 时会调用此函数。

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

返回

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

返回类型

object

get_parameter(target)

返回由 target 指定的参数（如果存在），否则抛出错误。

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

参数

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

返回

target 引用的参数

返回类型

torch.nn.Parameter

引发

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

get_submodule(target)

返回由 target 指定的子模块（如果存在），否则抛出错误。

例如，假设您有一个 nn.Module A，它看起来像这样

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

（图示显示了一个 nn.Module A。 A 有一个嵌套子模块 net_b，其本身有两个子模块 net_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 数据类型。

注意

此方法会原地修改模块。

返回

自身

返回类型

模块

ipu(device=None)

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

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

注意

此方法会原地修改模块。

参数

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

返回

自身

返回类型

模块

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 中张量的属性。唯一的例外是 Default: ``False` 的 requires_grad 字段。

返回

  • missing_keys 是一个字符串列表，包含预期的任何键

    但提供的 state_dict 中缺少的键。

  • unexpected_keys 是一个字符串列表，包含未

    被此模块预期但在提供的 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) – 如果指定，所有参数将复制到该设备

返回

自身

返回类型

模块

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))
返回类型

无

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 将仅对应于作为位置参数给定的输入，所有关键字参数都将被忽略。grad_input 和 grad_output 中的非 Tensor 参数条目将为 None。

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

警告

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

参数

  • 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 钩子时，不允许原地修改输入，否则将引发错误。

参数

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

如果需要，可以原地修改给定的 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) – 在加载状态字典前调用的可调用钩子。

register_module(name, module)

add_module() 的别名。

返回类型

无

register_parameter(name, param)

向模块添加一个参数。

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

参数

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

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

返回类型

无

register_state_dict_post_hook(hook)

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

它应具有以下签名：

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

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

register_state_dict_pre_hook(hook)

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

它应具有以下签名：

hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)

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

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

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

有关 .requires_grad_() 与其他可能与其混淆的类似机制的比较，请参阅 本地禁用梯度文档。

参数

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

返回

自身

返回类型

模块

set_extra_state(state)

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

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

参数

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

返回类型

无

set_submodule(target, module)

设置由 target 指定的子模块（如果存在），否则抛出错误。

例如，假设您有一个 nn.Module A，它看起来像这样

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

（图显示了一个 nn.Module A。A 有一个嵌套子模块 net_b，它本身有两个子模块 net_c 和 linear。net_c 然后有一个子模块 conv。）

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

参数

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

  • module (Module) – 用于设置子模块的模块。

引发

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

  • AttributeError – 如果目标字符串引用了无效路径或解析结果不是 nn.Module

返回类型

无

share_memory()

参见 torch.Tensor.share_memory_()。

返回类型

~T

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

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

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

注意

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

警告

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

警告

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

参数

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

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

  • keep_vars (bool, optional) – 默认情况下，在 state dict 中返回的 Tensor 与 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 和设备为此模块中所有参数和缓冲区的期望 dtype 和设备的 Tensor

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

返回

自身

返回类型

模块

示例

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

返回

自身

返回类型

模块

train(mode=True)

将模块设置为训练模式。

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

参数

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

返回

自身

返回类型

模块

training: bool
type(dst_type)

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

注意

此方法会原地修改模块。

参数

dst_type (type or string) – 期望的类型

返回

自身

返回类型

模块

xpu(device=None)

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

此方法还会使相关的参数和缓冲区成为不同的对象。因此，如果在优化模块时模块将位于 XPU 上，应在构建优化器之前调用它。

注意

此方法会原地修改模块。

参数

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

返回

自身

返回类型

模块

zero_grad(set_to_none=True)

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

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

参数

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

返回类型

无

上一个

<无标题>

下一个

<无标题>