<无标题> — darts 文档

class darts.models.components.glu_variants.Bilinear(d_model, d_ff, dropout=0.1)[源代码]¶

基类: Module

初始化内部 Module 状态，由 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)	在模块上注册一个 backward hook。
`register_buffer`(name, tensor[, persistent])	向模块添加一个缓冲区。
`register_forward_hook`(hook, *[, prepend, ...])	在模块上注册一个 forward hook。
`register_forward_pre_hook`(hook, *[, ...])	在模块上注册一个 forward pre-hook。
`register_full_backward_hook`(hook[, prepend])	在模块上注册一个 backward hook。
`register_full_backward_pre_hook`(hook[, prepend])	在模块上注册一个 backward pre-hook。
`register_load_state_dict_post_hook`(hook)	注册一个后置 hook，在调用模块的 `load_state_dict()` 后运行。
`register_load_state_dict_pre_hook`(hook)	注册一个前置 hook，在调用模块的 `load_state_dict()` 前运行。
`register_module`(name, module)	`add_module()` 的别名。
`register_parameter`(name, param)	向模块添加一个参数。
`register_state_dict_post_hook`(hook)	为 `state_dict()` 方法注册一个后置 hook。
`register_state_dict_pre_hook`(hook)	为 `state_dict()` 方法注册一个前置 hook。
`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) – 要应用于每个子模块的函数
返回: 自身
返回类型: 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 数据类型。

注意

此方法会就地修改模块。

返回: 自身
返回类型: 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。

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

cuda(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

double()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

dump_patches: bool = False¶

eval()¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回: 自身
返回类型: Module

extra_repr()¶

返回模块的额外表示。

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

返回类型: str

float()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

forward(x)[源代码]¶

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

应被所有子类覆盖。

注意

虽然 forward pass 的 рецеп应在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行注册的 hook，而后者会默默地忽略它们。

get_buffer(target)¶

如果存在，则返回由 target 给定的缓冲区，否则抛出错误。

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非缓冲区

get_extra_state()¶

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

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

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: object

get_parameter(target)¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 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 – 如果 target 字符串引用了无效路径或解析为非 nn.Module

half()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

ipu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

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

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

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

警告

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

参数

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。

返回类型

NamedTuple with missing_keys and unexpected_keys fields

注意

If a parameter or buffer is registered as None and its corresponding key exists in state_dict, load_state_dict() will raise a 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) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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)¶

在模块上注册一个 backward hook。

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: 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 hook。

每次 forward() 计算输出后都会调用此 hook。

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

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

如果 with_kwargs 为 True，则 forward hook 会传递给 forward 函数的 kwargs，并期望返回可能已修改的输出。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 True，则将向 hook 传递给 forward 函数的 kwargs。默认值: False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，hook 都会运行。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

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

在模块上注册一个 forward pre-hook。

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

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

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

如果 with_kwargs 为 true，则 forward pre-hook 会传递给 forward 函数的 kwargs。如果 hook 修改输入，则应同时返回 args 和 kwargs。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 true，则将向 hook 传递给 forward 函数的 kwargs。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)¶

在模块上注册一个 backward hook。

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

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

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之后触发。请注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)¶

在模块上注册一个 backward pre-hook。

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

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

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

警告

使用 backward hooks 时不允许就地修改输入，否则将引发错误。

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)¶

注册一个后置 hook，在调用模块的 load_state_dict() 后运行。

它应该具有以下签名：: hook(module, incompatible_keys) -> None

module 参数是注册此 hook 的当前模块，incompatible_keys 参数是一个 NamedTuple，包含属性 missing_keys 和 unexpected_keys。missing_keys 是一个包含缺失键的 list，unexpected_keys 是一个包含意外键的 list。

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

请注意，调用 load_state_dict() 并设置 strict=True 时执行的检查会受到 hook 对 missing_keys 或 unexpected_keys 进行的修改的影响，这是预期的。向任一组键中添加键将导致在 strict=True 时引发错误，而清除所有缺失和意外键将避免错误。

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(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 前将调用的可调用 hook。

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。

它应该具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

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

register_state_dict_pre_hook(hook)¶

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

它应该具有以下签名：: hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)¶

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

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

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

请参阅 locally-disable-grad-doc，比较 .requires_grad_() 与其他一些可能与之混淆的类似机制。

参数: requires_grad (bool) – autograd 是否应该记录此模块中参数上的操作。默认值: True。
返回: 自身
返回类型: 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 – 如果 target 字符串引用了无效路径或解析为非 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，则整数参数和缓冲区将被移动到 device，但 dtype 保持不变。当设置 non_blocking 时，如果可能，它会尝试与主机异步转换/移动，例如，将具有固定内存的 CPU Tensors 移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法会就地修改模块。

参数

device (torch.device) – 此模块中参数和缓冲区的所需设备
dtype (torch.dtype) – 此模块中参数和缓冲区的所需浮点或复数 dtype
tensor (torch.Tensor) – Tensor，其 dtype 和 device 是此模块中所有参数和缓冲区的所需 dtype 和 device
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的所需内存格式（仅关键字参数）

返回

自身

返回类型

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

返回

自身

返回类型

Module

train(mode=True)¶

将模块设置为训练模式。

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

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。
返回: 自身
返回类型: Module

training: bool¶

type(dst_type)¶

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

注意

此方法会就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: 自身
返回类型: Module

xpu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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.glu_variants.GEGLU(d_model, d_ff, dropout=0.1)[源代码]¶

基类: Module

初始化内部 Module 状态，由 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)	在模块上注册一个 backward hook。
`register_buffer`(name, tensor[, persistent])	向模块添加一个缓冲区。
`register_forward_hook`(hook, *[, prepend, ...])	在模块上注册一个 forward hook。
`register_forward_pre_hook`(hook, *[, ...])	在模块上注册一个 forward pre-hook。
`register_full_backward_hook`(hook[, prepend])	在模块上注册一个 backward hook。
`register_full_backward_pre_hook`(hook[, prepend])	在模块上注册一个 backward pre-hook。
`register_load_state_dict_post_hook`(hook)	注册一个后置 hook，在调用模块的 `load_state_dict()` 后运行。
`register_load_state_dict_pre_hook`(hook)	注册一个前置 hook，在调用模块的 `load_state_dict()` 前运行。
`register_module`(name, module)	`add_module()` 的别名。
`register_parameter`(name, param)	向模块添加一个参数。
`register_state_dict_post_hook`(hook)	为 `state_dict()` 方法注册一个后置 hook。
`register_state_dict_pre_hook`(hook)	为 `state_dict()` 方法注册一个前置 hook。
`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) – 要应用于每个子模块的函数
返回: 自身
返回类型: 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 数据类型。

注意

此方法会就地修改模块。

返回: 自身
返回类型: 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。

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

cuda(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

double()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

dump_patches: bool = False¶

eval()¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回: 自身
返回类型: Module

extra_repr()¶

返回模块的额外表示。

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

返回类型: str

float()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

forward(x)[源代码]¶

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

应被所有子类覆盖。

注意

虽然 forward pass 的 рецеп应在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行注册的 hook，而后者会默默地忽略它们。

get_buffer(target)¶

如果存在，则返回由 target 给定的缓冲区，否则抛出错误。

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非缓冲区

get_extra_state()¶

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

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: object

get_parameter(target)¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 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")。

参数: target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上述示例。）
返回: 由 target 引用的子模块
返回类型: torch.nn.Module
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Module

half()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

ipu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

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

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

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

警告

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

参数

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。

返回类型

NamedTuple with missing_keys and unexpected_keys fields

注意

如果参数或缓冲区注册为 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) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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)¶

在模块上注册一个 backward hook。

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: 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 hook。

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

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

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

如果 with_kwargs 为 True，则 forward hook 会传递给 forward 函数的 kwargs，并期望返回可能已修改的输出。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 True，则将向 hook 传递给 forward 函数的 kwargs。默认值: False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，hook 都会运行。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

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

在模块上注册一个 forward pre-hook。

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

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

如果 with_kwargs 为 true，则 forward pre-hook 会传递给 forward 函数的 kwargs。如果 hook 修改输入，则应同时返回 args 和 kwargs。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 true，则将向 hook 传递给 forward 函数的 kwargs。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)¶

在模块上注册一个 backward hook。

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之后触发。请注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)¶

在模块上注册一个 backward pre-hook。

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

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

警告

使用 backward hooks 时不允许就地修改输入，否则将引发错误。

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)¶

注册一个后置 hook，在调用模块的 load_state_dict() 后运行。

它应该具有以下签名：: hook(module, incompatible_keys) -> None

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

请注意，调用 load_state_dict() 并设置 strict=True 时执行的检查会受到钩子对 missing_keys 或 unexpected_keys 的修改的影响，这是预期行为。添加到任一键集都会导致在 strict=True 时引发错误，而清除缺失和意外键则会避免错误。

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(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 前将调用的可调用 hook。

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。

它应该具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

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

register_state_dict_pre_hook(hook)¶

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

它应该具有以下签名：: hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)¶

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

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

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

请参阅 locally-disable-grad-doc，比较 .requires_grad_() 与其他一些可能与之混淆的类似机制。

参数: requires_grad (bool) – autograd 是否应该记录此模块中参数上的操作。默认值: True。
返回: 自身
返回类型: Module

set_extra_state(state)¶

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

参数: 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 – 如果 target 字符串引用了无效路径或解析为非 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)

请参阅下面的示例。

注意

此方法会就地修改模块。

参数

device (torch.device) – 此模块中参数和缓冲区的所需设备
dtype (torch.dtype) – 此模块中参数和缓冲区的所需浮点或复数 dtype
tensor (torch.Tensor) – Tensor，其 dtype 和 device 是此模块中所有参数和缓冲区的所需 dtype 和 device
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的所需内存格式（仅关键字参数）

返回

自身

返回类型

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

返回

自身

返回类型

Module

train(mode=True)¶

将模块设置为训练模式。

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

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。
返回: 自身
返回类型: Module

training: bool¶

type(dst_type)¶

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

注意

此方法会就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: 自身
返回类型: Module

xpu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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.glu_variants.GELU(d_model, d_ff, dropout=0.1)[源代码]¶

基类: Module

初始化内部 Module 状态，由 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)	在模块上注册一个 backward hook。
`register_buffer`(name, tensor[, persistent])	向模块添加一个缓冲区。
`register_forward_hook`(hook, *[, prepend, ...])	在模块上注册一个 forward hook。
`register_forward_pre_hook`(hook, *[, ...])	在模块上注册一个 forward pre-hook。
`register_full_backward_hook`(hook[, prepend])	在模块上注册一个 backward hook。
`register_full_backward_pre_hook`(hook[, prepend])	在模块上注册一个 backward pre-hook。
`register_load_state_dict_post_hook`(hook)	注册一个后置 hook，在调用模块的 `load_state_dict()` 后运行。
`register_load_state_dict_pre_hook`(hook)	注册一个前置 hook，在调用模块的 `load_state_dict()` 前运行。
`register_module`(name, module)	`add_module()` 的别名。
`register_parameter`(name, param)	向模块添加一个参数。
`register_state_dict_post_hook`(hook)	为 `state_dict()` 方法注册一个后置 hook。
`register_state_dict_pre_hook`(hook)	为 `state_dict()` 方法注册一个前置 hook。
`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) – 要应用于每个子模块的函数
返回: 自身
返回类型: 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 数据类型。

注意

此方法会就地修改模块。

返回: 自身
返回类型: 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。

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

cuda(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

double()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

dump_patches: bool = False¶

eval()¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回: 自身
返回类型: Module

extra_repr()¶

返回模块的额外表示。

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

返回类型: str

float()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

forward(x)[源代码]¶

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

应被所有子类覆盖。

注意

虽然 forward pass 的 рецеп应在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行注册的 hook，而后者会默默地忽略它们。

get_buffer(target)¶

如果存在，则返回由 target 给定的缓冲区，否则抛出错误。

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非缓冲区

get_extra_state()¶

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

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: object

get_parameter(target)¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 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")。

参数: target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上述示例。）
返回: 由 target 引用的子模块
返回类型: torch.nn.Module
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Module

half()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

ipu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

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

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

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

警告

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

参数

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。

返回类型

NamedTuple with missing_keys and unexpected_keys fields

注意

如果参数或缓冲区注册为 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) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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)¶

在模块上注册一个 backward hook。

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: 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 hook。

每次 forward() 计算完输出后，将调用该钩子。

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

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

如果 with_kwargs 为 True，则 forward hook 会传递给 forward 函数的 kwargs，并期望返回可能已修改的输出。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 True，则将向 hook 传递给 forward 函数的 kwargs。默认值: False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，hook 都会运行。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

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

在模块上注册一个 forward pre-hook。

每次调用 forward() 之前，将调用该钩子。

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

如果 with_kwargs 为 true，则 forward pre-hook 会传递给 forward 函数的 kwargs。如果 hook 修改输入，则应同时返回 args 和 kwargs。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 true，则将向 hook 传递给 forward 函数的 kwargs。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)¶

在模块上注册一个 backward hook。

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之后触发。请注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)¶

在模块上注册一个 backward pre-hook。

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

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

警告

使用 backward hooks 时不允许就地修改输入，否则将引发错误。

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)¶

注册一个后置 hook，在调用模块的 load_state_dict() 后运行。

它应该具有以下签名：: hook(module, incompatible_keys) -> None

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

请注意，调用 load_state_dict() 并设置 strict=True 时执行的检查会受到钩子对 missing_keys 或 unexpected_keys 所做修改的影响，这是预期的。向任一组键添加内容都会在 strict=True 时引发错误，而清除缺失和意外的键将避免错误。

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(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 前将调用的可调用 hook。

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。

它应该具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

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

register_state_dict_pre_hook(hook)¶

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

它应该具有以下签名：: hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)¶

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

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

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

请参阅 locally-disable-grad-doc，比较 .requires_grad_() 与其他一些可能与之混淆的类似机制。

参数: requires_grad (bool) – autograd 是否应该记录此模块中参数上的操作。默认值: True。
返回: 自身
返回类型: 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 – 如果 target 字符串引用了无效路径或解析为非 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)

请参阅下面的示例。

注意

此方法会就地修改模块。

参数

device (torch.device) – 此模块中参数和缓冲区的所需设备
dtype (torch.dtype) – 此模块中参数和缓冲区的所需浮点或复数 dtype
tensor (torch.Tensor) – Tensor，其 dtype 和 device 是此模块中所有参数和缓冲区的所需 dtype 和 device
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的所需内存格式（仅关键字参数）

返回

自身

返回类型

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

返回

自身

返回类型

Module

train(mode=True)¶

将模块设置为训练模式。

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

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。
返回: 自身
返回类型: Module

training: bool¶

type(dst_type)¶

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

注意

此方法会就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: 自身
返回类型: Module

xpu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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.glu_variants.GLU(d_model, d_ff, dropout=0.1)[源]¶

基类: Module

初始化内部 Module 状态，由 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)	在模块上注册一个 backward hook。
`register_buffer`(name, tensor[, persistent])	向模块添加一个缓冲区。
`register_forward_hook`(hook, *[, prepend, ...])	在模块上注册一个 forward hook。
`register_forward_pre_hook`(hook, *[, ...])	在模块上注册一个 forward pre-hook。
`register_full_backward_hook`(hook[, prepend])	在模块上注册一个 backward hook。
`register_full_backward_pre_hook`(hook[, prepend])	在模块上注册一个 backward pre-hook。
`register_load_state_dict_post_hook`(hook)	注册一个后置 hook，在调用模块的 `load_state_dict()` 后运行。
`register_load_state_dict_pre_hook`(hook)	注册一个前置 hook，在调用模块的 `load_state_dict()` 前运行。
`register_module`(name, module)	`add_module()` 的别名。
`register_parameter`(name, param)	向模块添加一个参数。
`register_state_dict_post_hook`(hook)	为 `state_dict()` 方法注册一个后置 hook。
`register_state_dict_pre_hook`(hook)	为 `state_dict()` 方法注册一个前置 hook。
`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) – 要应用于每个子模块的函数
返回: 自身
返回类型: 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 数据类型。

注意

此方法会就地修改模块。

返回: 自身
返回类型: 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。

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

cuda(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

double()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

dump_patches: bool = False¶

eval()¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回: 自身
返回类型: Module

extra_repr()¶

返回模块的额外表示。

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

返回类型: str

float()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

forward(x)[源]¶

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

应被所有子类覆盖。

注意

虽然 forward pass 的 рецеп应在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行注册的 hook，而后者会默默地忽略它们。

get_buffer(target)¶

如果存在，则返回由 target 给定的缓冲区，否则抛出错误。

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非缓冲区

get_extra_state()¶

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

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: object

get_parameter(target)¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 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")。

参数: target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上述示例。）
返回: 由 target 引用的子模块
返回类型: torch.nn.Module
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Module

half()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

ipu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

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

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

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

警告

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

参数

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。

返回类型

NamedTuple with missing_keys and unexpected_keys fields

注意

如果参数或缓冲区被注册为 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) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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)¶

在模块上注册一个 backward hook。

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_buffer(name, tensor, persistent=True)¶

向模块添加一个缓冲区。

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

参数

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

每次 forward() 计算完输出后，将调用该钩子。

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

如果 with_kwargs 为 True，则 forward hook 会传递给 forward 函数的 kwargs，并期望返回可能已修改的输出。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 True，则将向 hook 传递给 forward 函数的 kwargs。默认值: False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，hook 都会运行。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

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

在模块上注册一个 forward pre-hook。

每次调用 forward() 之前，将调用该钩子。

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

如果 with_kwargs 为 true，则 forward pre-hook 会传递给 forward 函数的 kwargs。如果 hook 修改输入，则应同时返回 args 和 kwargs。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 true，则将向 hook 传递给 forward 函数的 kwargs。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)¶

在模块上注册一个 backward hook。

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之后触发。请注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)¶

在模块上注册一个 backward pre-hook。

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

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

警告

使用 backward hooks 时不允许就地修改输入，否则将引发错误。

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)¶

注册一个后置 hook，在调用模块的 load_state_dict() 后运行。

它应该具有以下签名：: hook(module, incompatible_keys) -> None

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(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 前将调用的可调用 hook。

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。

它应该具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

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

register_state_dict_pre_hook(hook)¶

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

它应该具有以下签名：: hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)¶

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

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

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

请参阅 locally-disable-grad-doc，比较 .requires_grad_() 与其他一些可能与之混淆的类似机制。

参数: requires_grad (bool) – autograd 是否应该记录此模块中参数上的操作。默认值: True。
返回: 自身
返回类型: Module

set_extra_state(state)¶

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

参数: 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 – 如果 target 字符串引用了无效路径或解析为非 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)

请参阅下面的示例。

注意

此方法会就地修改模块。

参数

device (torch.device) – 此模块中参数和缓冲区的所需设备
dtype (torch.dtype) – 此模块中参数和缓冲区的所需浮点或复数 dtype
tensor (torch.Tensor) – Tensor，其 dtype 和 device 是此模块中所有参数和缓冲区的所需 dtype 和 device
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的所需内存格式（仅关键字参数）

返回

自身

返回类型

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

返回

自身

返回类型

Module

train(mode=True)¶

将模块设置为训练模式。

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

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。
返回: 自身
返回类型: Module

training: bool¶

type(dst_type)¶

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

注意

此方法会就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: 自身
返回类型: Module

xpu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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.glu_variants.ReGLU(d_model, d_ff, dropout=0.1)[源]¶

基类: Module

初始化内部 Module 状态，由 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)	在模块上注册一个 backward hook。
`register_buffer`(name, tensor[, persistent])	向模块添加一个缓冲区。
`register_forward_hook`(hook, *[, prepend, ...])	在模块上注册一个 forward hook。
`register_forward_pre_hook`(hook, *[, ...])	在模块上注册一个 forward pre-hook。
`register_full_backward_hook`(hook[, prepend])	在模块上注册一个 backward hook。
`register_full_backward_pre_hook`(hook[, prepend])	在模块上注册一个 backward pre-hook。
`register_load_state_dict_post_hook`(hook)	注册一个后置 hook，在调用模块的 `load_state_dict()` 后运行。
`register_load_state_dict_pre_hook`(hook)	注册一个前置 hook，在调用模块的 `load_state_dict()` 前运行。
`register_module`(name, module)	`add_module()` 的别名。
`register_parameter`(name, param)	向模块添加一个参数。
`register_state_dict_post_hook`(hook)	为 `state_dict()` 方法注册一个后置 hook。
`register_state_dict_pre_hook`(hook)	为 `state_dict()` 方法注册一个前置 hook。
`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) – 要应用于每个子模块的函数
返回: 自身
返回类型: 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 数据类型。

注意

此方法会就地修改模块。

返回: 自身
返回类型: 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。

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

cuda(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

double()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

dump_patches: bool = False¶

eval()¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回: 自身
返回类型: Module

extra_repr()¶

返回模块的额外表示。

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

返回类型: str

float()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

forward(x)[源]¶

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

应被所有子类覆盖。

注意

虽然 forward pass 的 рецеп应在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行注册的 hook，而后者会默默地忽略它们。

get_buffer(target)¶

如果存在，则返回由 target 给定的缓冲区，否则抛出错误。

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非缓冲区

get_extra_state()¶

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

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: object

get_parameter(target)¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 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")。

参数: target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上述示例。）
返回: 由 target 引用的子模块
返回类型: torch.nn.Module
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Module

half()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

ipu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

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

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

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

警告

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

参数

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。

返回类型

NamedTuple with missing_keys and unexpected_keys fields

注意

如果参数或缓冲区被注册为 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) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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)¶

在模块上注册一个 backward hook。

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_buffer(name, tensor, persistent=True)¶

向模块添加一个缓冲区。

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

参数

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

每次 forward() 计算完输出后，将调用该钩子。

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

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

如果 with_kwargs 为 True，则 forward hook 会传递给 forward 函数的 kwargs，并期望返回可能已修改的输出。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 True，则将向 hook 传递给 forward 函数的 kwargs。默认值: False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，hook 都会运行。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

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

在模块上注册一个 forward pre-hook。

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

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

如果 with_kwargs 为 true，则 forward pre-hook 会传递给 forward 函数的 kwargs。如果 hook 修改输入，则应同时返回 args 和 kwargs。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 true，则将向 hook 传递给 forward 函数的 kwargs。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)¶

在模块上注册一个 backward hook。

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之后触发。请注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)¶

在模块上注册一个 backward pre-hook。

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

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

警告

使用 backward hooks 时不允许就地修改输入，否则将引发错误。

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)¶

注册一个后置 hook，在调用模块的 load_state_dict() 后运行。

它应该具有以下签名：: hook(module, incompatible_keys) -> None

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

请注意，如预期所示，调用 load_state_dict() 并设置 strict=True 时执行的检查会受到钩子对 missing_keys 或 unexpected_keys 所做的修改的影响。添加到任一键集都会在 strict=True 时导致抛出错误，而清除缺失键和意外键则可以避免错误。

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(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 前将调用的可调用 hook。

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。

它应该具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

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

register_state_dict_pre_hook(hook)¶

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

它应该具有以下签名：: hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)¶

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

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

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

请参阅 locally-disable-grad-doc，比较 .requires_grad_() 与其他一些可能与之混淆的类似机制。

参数: requires_grad (bool) – autograd 是否应该记录此模块中参数上的操作。默认值: True。
返回: 自身
返回类型: 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 – 如果 target 字符串引用了无效路径或解析为非 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)

请参阅下面的示例。

注意

此方法会就地修改模块。

参数

device (torch.device) – 此模块中参数和缓冲区的所需设备
dtype (torch.dtype) – 此模块中参数和缓冲区的所需浮点或复数 dtype
tensor (torch.Tensor) – Tensor，其 dtype 和 device 是此模块中所有参数和缓冲区的所需 dtype 和 device
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的所需内存格式（仅关键字参数）

返回

自身

返回类型

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

返回

自身

返回类型

Module

train(mode=True)¶

将模块设置为训练模式。

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

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。
返回: 自身
返回类型: Module

training: bool¶

type(dst_type)¶

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

注意

此方法会就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: 自身
返回类型: Module

xpu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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.glu_variants.ReLU(d_model, d_ff, dropout=0.1)[源代码]¶

基类: Module

初始化内部 Module 状态，由 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)	在模块上注册一个 backward hook。
`register_buffer`(name, tensor[, persistent])	向模块添加一个缓冲区。
`register_forward_hook`(hook, *[, prepend, ...])	在模块上注册一个 forward hook。
`register_forward_pre_hook`(hook, *[, ...])	在模块上注册一个 forward pre-hook。
`register_full_backward_hook`(hook[, prepend])	在模块上注册一个 backward hook。
`register_full_backward_pre_hook`(hook[, prepend])	在模块上注册一个 backward pre-hook。
`register_load_state_dict_post_hook`(hook)	注册一个后置 hook，在调用模块的 `load_state_dict()` 后运行。
`register_load_state_dict_pre_hook`(hook)	注册一个前置 hook，在调用模块的 `load_state_dict()` 前运行。
`register_module`(name, module)	`add_module()` 的别名。
`register_parameter`(name, param)	向模块添加一个参数。
`register_state_dict_post_hook`(hook)	为 `state_dict()` 方法注册一个后置 hook。
`register_state_dict_pre_hook`(hook)	为 `state_dict()` 方法注册一个前置 hook。
`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) – 要应用于每个子模块的函数
返回: 自身
返回类型: 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 数据类型。

注意

此方法会就地修改模块。

返回: 自身
返回类型: 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。

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

cuda(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

double()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

dump_patches: bool = False¶

eval()¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回: 自身
返回类型: Module

extra_repr()¶

返回模块的额外表示。

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

返回类型: str

float()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

forward(x)[源代码]¶

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

应被所有子类覆盖。

注意

虽然 forward pass 的 рецеп应在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行注册的 hook，而后者会默默地忽略它们。

get_buffer(target)¶

如果存在，则返回由 target 给定的缓冲区，否则抛出错误。

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非缓冲区

get_extra_state()¶

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

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: object

get_parameter(target)¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 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")。

参数: target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上述示例。）
返回: 由 target 引用的子模块
返回类型: torch.nn.Module
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Module

half()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

ipu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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 中张量的属性。唯一的例外是 Default: ``False` 的 requires_grad 字段

返回

missing_keys 是一个包含此模块预期但提供的 state_dict 中缺失的任何键的字符串列表。
unexpected_keys 是一个包含此模块不预期但提供的 state_dict 中存在的键的字符串列表。
带有 missing_keys 和 unexpected_keys 字段的 NamedTuple
如果参数或缓冲区注册为 None 且其对应键存在于 state_dict 中，load_state_dict() 将引发 RuntimeError。

返回类型

NamedTuple with missing_keys and unexpected_keys fields

注意

如果参数或缓冲区被注册为 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) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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)¶

在模块上注册一个 backward hook。

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: 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。

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

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

如果 with_kwargs 为 True，则 forward hook 会传递给 forward 函数的 kwargs，并期望返回可能已修改的输出。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 True，则将向 hook 传递给 forward 函数的 kwargs。默认值: False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，hook 都会运行。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

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

在模块上注册一个 forward pre-hook。

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

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

如果 with_kwargs 为 true，则 forward pre-hook 会传递给 forward 函数的 kwargs。如果 hook 修改输入，则应同时返回 args 和 kwargs。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 true，则将向 hook 传递给 forward 函数的 kwargs。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)¶

在模块上注册一个 backward hook。

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之后触发。请注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)¶

在模块上注册一个 backward pre-hook。

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

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

警告

使用 backward hooks 时不允许就地修改输入，否则将引发错误。

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)¶

注册一个后置 hook，在调用模块的 load_state_dict() 后运行。

它应该具有以下签名：: hook(module, incompatible_keys) -> None

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(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 前将调用的可调用 hook。

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。

它应该具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

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

register_state_dict_pre_hook(hook)¶

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

它应该具有以下签名：: hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)¶

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

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

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

请参阅 locally-disable-grad-doc，比较 .requires_grad_() 与其他一些可能与之混淆的类似机制。

参数: requires_grad (bool) – autograd 是否应该记录此模块中参数上的操作。默认值: True。
返回: 自身
返回类型: Module

set_extra_state(state)¶

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

参数: 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 – 如果 target 字符串引用了无效路径或解析为非 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)

请参阅下面的示例。

注意

此方法会就地修改模块。

参数

device (torch.device) – 此模块中参数和缓冲区的所需设备
dtype (torch.dtype) – 此模块中参数和缓冲区的所需浮点或复数 dtype
tensor (torch.Tensor) – Tensor，其 dtype 和 device 是此模块中所有参数和缓冲区的所需 dtype 和 device
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的所需内存格式（仅关键字参数）

返回

自身

返回类型

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

返回

自身

返回类型

Module

train(mode=True)¶

将模块设置为训练模式。

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

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。
返回: 自身
返回类型: Module

training: bool¶

type(dst_type)¶

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

注意

此方法会就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: 自身
返回类型: Module

xpu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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.glu_variants.SwiGLU(d_model, d_ff, dropout=0.1)[源代码]¶

基类: Module

初始化内部 Module 状态，由 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)	在模块上注册一个 backward hook。
`register_buffer`(name, tensor[, persistent])	向模块添加一个缓冲区。
这通常用于注册不应被视为模型参数的缓冲区。例如，BatchNorm 的 `running_mean` 不是参数，但属于模块的状态。缓冲区默认是持久的，将与参数一起保存。通过将 `persistent` 设置为 `False` 可以更改此行为。持久缓冲区和非持久缓冲区之间的唯一区别在于，后者将不属于此模块的 `state_dict`。	在模块上注册一个 forward hook。
tensor (Tensor 或 None) – 要注册的缓冲区。如果为 `None`，则对缓冲区运行的操作（例如 `cuda`）将被忽略。如果为 `None`，该缓冲区将不包含在模块的 `state_dict` 中。	在模块上注册一个 forward pre-hook。
persistent (bool) – 缓冲区是否为此模块 `state_dict` 的一部分。	在模块上注册一个 backward hook。
register_forward_hook(hook, , prepend=False, with_kwargs=False, always_call=False*)¶	在模块上注册一个 backward pre-hook。
每次 `forward()` 计算出输出后，都会调用此钩子。	注册一个后置 hook，在调用模块的 `load_state_dict()` 后运行。
如果 `with_kwargs` 为 `False` 或未指定，输入将仅包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 `forward`。钩子可以修改输出。它可以就地修改输入，但由于它是在 `forward()` 调用后执行，因此不会对 forward 产生影响。钩子应具有以下签名：	注册一个前置 hook，在调用模块的 `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()` 方法注册一个后置 hook。
register_load_state_dict_post_hook(hook)¶	为 `state_dict()` 方法注册一个前置 hook。
请注意，如预期所示，调用 `load_state_dict()` 并设置 `strict=True` 时执行的检查会受到钩子对 `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_()`。
`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) – 要应用于每个子模块的函数
返回: 自身
返回类型: 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 数据类型。

注意

此方法会就地修改模块。

返回: 自身
返回类型: 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。

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

cuda(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

double()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

dump_patches: bool = False¶

eval()¶

将模块设置为评估模式。

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

这等效于 self.train(False)。

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

返回: 自身
返回类型: Module

extra_repr()¶

返回模块的额外表示。

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

返回类型: str

float()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

forward(x)[源码]¶

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

应被所有子类覆盖。

注意

虽然 forward pass 的 рецеп应在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行注册的 hook，而后者会默默地忽略它们。

get_buffer(target)¶

如果存在，则返回由 target 给定的缓冲区，否则抛出错误。

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

参数: target (str) – 要查找的缓冲区的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的缓冲区
返回类型: torch.Tensor
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非缓冲区

get_extra_state()¶

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

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

返回: 要存储在模块 state_dict 中的任何额外状态
返回类型: object

get_parameter(target)¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 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")。

参数: target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上述示例。）
返回: 由 target 引用的子模块
返回类型: torch.nn.Module
抛出: AttributeError – 如果 target 字符串引用了无效路径或解析为非 nn.Module

half()¶

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

注意

此方法会就地修改模块。

返回: 自身
返回类型: Module

ipu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

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

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

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

警告

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

参数

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。

返回类型

NamedTuple with missing_keys and unexpected_keys fields

注意

如果参数或缓冲区注册为 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) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: 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)¶

在模块上注册一个 backward hook。

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

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: 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 hook。

每次 forward() 计算输出后都会调用此 hook。

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

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

如果 with_kwargs 为 True，则 forward hook 会传递给 forward 函数的 kwargs，并期望返回可能已修改的输出。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 True，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward hook 之后触发。请注意，使用 register_module_forward_hook() 注册的全局 forward hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 True，则将向 hook 传递给 forward 函数的 kwargs。默认值: False
always_call (bool) – 如果为 True，无论调用 Module 时是否引发异常，hook 都会运行。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

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

在模块上注册一个 forward pre-hook。

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

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

如果 with_kwargs 为 true，则 forward pre-hook 会传递给 forward 函数的 kwargs。如果 hook 修改输入，则应同时返回 args 和 kwargs。hook 应该具有以下签名

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 forward_pre hook 之后触发。请注意，使用 register_module_forward_pre_hook() 注册的全局 forward_pre hook 将在此方法注册的所有 hook 之前触发。默认值: False
with_kwargs (bool) – 如果为 true，则将向 hook 传递给 forward 函数的 kwargs。默认值: False

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook, prepend=False)¶

在模块上注册一个 backward hook。

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

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

警告

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

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward hook 之后触发。请注意，使用 register_module_full_backward_hook() 注册的全局 backward hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook, prepend=False)¶

在模块上注册一个 backward pre-hook。

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

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

警告

使用 backward hooks 时不允许就地修改输入，否则将引发错误。

参数

hook (Callable) – 要注册的用户定义 hook。
prepend (bool) – 如果为 true，则提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之前触发。否则，提供的 hook 将在此 torch.nn.modules.Module 上的所有现有 backward_pre hook 之后触发。请注意，使用 register_module_full_backward_pre_hook() 注册的全局 backward_pre hook 将在此方法注册的所有 hook 之前触发。

返回

可以通过调用 handle.remove() 移除添加的 hook 的句柄

返回类型

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)¶

注册一个后置 hook，在调用模块的 load_state_dict() 后运行。

它应该具有以下签名：: hook(module, incompatible_keys) -> None

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

请注意，在调用 load_state_dict() 并设置 strict=True 时执行的检查，会受到 hook 对 missing_keys 或 unexpected_keys 所做修改的影响，这是预期行为。向任一组键添加内容都会在 strict=True 时引发错误，而清除 missing 和 unexpected 键则会避免错误。

返回: 可以通过调用 handle.remove() 移除添加的 hook 的句柄
返回类型: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(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 前将调用的可调用 hook。

register_module(name, module)¶

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

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

它应该具有以下签名：: hook(module, state_dict, prefix, local_metadata) -> None

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

register_state_dict_pre_hook(hook)¶

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

它应该具有以下签名：: hook(module, prefix, keep_vars) -> None

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

requires_grad_(requires_grad=True)¶

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

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

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

请参阅 locally-disable-grad-doc，比较 .requires_grad_() 与其他一些可能与之混淆的类似机制。

参数: requires_grad (bool) – autograd 是否应该记录此模块中参数上的操作。默认值: True。
返回: 自身
返回类型: 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 – 如果 target 字符串引用了无效路径或解析为非 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)

请参阅下面的示例。

注意

此方法会就地修改模块。

参数

device (torch.device) – 此模块中参数和缓冲区的所需设备
dtype (torch.dtype) – 此模块中参数和缓冲区的所需浮点或复数 dtype
tensor (torch.Tensor) – Tensor，其 dtype 和 device 是此模块中所有参数和缓冲区的所需 dtype 和 device
memory_format (torch.memory_format) – 此模块中 4D 参数和缓冲区的所需内存格式（仅关键字参数）

返回

自身

返回类型

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

返回

自身

返回类型

Module

train(mode=True)¶

将模块设置为训练模式。

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

参数: mode (bool) – 是否设置训练模式 (True) 或评估模式 (False)。默认值: True。
返回: 自身
返回类型: Module

training: bool¶

type(dst_type)¶

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

注意

此方法会就地修改模块。

参数: dst_type (type or string) – 所需类型
返回: 自身
返回类型: Module

xpu(device=None)¶

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

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

注意

此方法会就地修改模块。

参数: device (int, optional) – 如果指定，所有参数将被复制到该设备
返回: 自身
返回类型: Module

zero_grad(set_to_none=True)¶

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

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

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

<无标题>