PyTorch 及其用法的工具集¶

class darts.utils.torch.MonteCarloDropout(p=0.5, inplace=False)[source]¶

基类: Dropout

定义了论文 https://arxiv.org/pdf/1506.02142.pdf 中定义的 Monte Carlo dropout 模块。总而言之，该技术使用常规 dropout，可以解释为已知概率模型（高斯过程）的贝叶斯近似。我们可以将许多不同的网络（丢弃不同的神经元）视为来自所有可用模型空间的蒙特卡洛样本。这为推理模型的不确定性提供了数学基础，并且事实证明，这通常会提升其性能。

属性

mc_dropout_enabled

方法

`add_module`(name, module)	向当前模块添加子模块。
`apply`(fn)	递归地将 `fn` 应用于每个子模块（通过 `.children()` 返回）以及自身。
`bfloat16`()	将所有浮点参数和缓冲区转换为 `bfloat16` 数据类型。
`buffers`([recurse])	返回模块缓冲区的迭代器。
`children`()	返回直接子模块的迭代器。
`compile`(args, *kwargs)	使用 `torch.compile()` 编译此模块的前向计算。
`cpu`()	将所有模型参数和缓冲区移动到 CPU。
`cuda`([device])	将所有模型参数和缓冲区移动到 GPU。
`double`()	将所有浮点参数和缓冲区转换为 `double` 数据类型。
`eval`()	将模块设置为评估模式。
`extra_repr`()	返回模块的附加表示。
`float`()	将所有浮点参数和缓冲区转换为 `float` 数据类型。
`forward`(input)	定义每次调用时执行的计算。
`get_buffer`(target)	如果存在，则返回由 `target` 指定的缓冲区，否则抛出错误。
`get_extra_state`()	返回模块 state_dict 中包含的任何额外状态。
`get_parameter`(target)	如果存在，则返回由 `target` 指定的参数，否则抛出错误。
`get_submodule`(target)	如果存在，则返回由 `target` 指定的子模块，否则抛出错误。
`half`()	将所有浮点参数和缓冲区转换为 `half` 数据类型。
`ipu`([device])	将所有模型参数和缓冲区移动到 IPU。
`load_state_dict`(state_dict[, strict, assign])	将 `state_dict` 中的参数和缓冲区复制到此模块及其后代模块中。
`modules`()	返回网络中所有模块的迭代器。
`mtia`([device])	将所有模型参数和缓冲区移动到 MTIA。
`named_buffers`([prefix, recurse, ...])	返回模块缓冲区的迭代器，同时返回缓冲区的名称和缓冲区本身。
`named_children`()	返回直接子模块的迭代器，同时返回模块的名称和模块本身。
`named_modules`([memo, prefix, remove_duplicate])	返回网络中所有模块的迭代器，同时返回模块的名称和模块本身。
`named_parameters`([prefix, recurse, ...])	返回模块参数的迭代器，同时返回参数的名称和参数本身。
`parameters`([recurse])	返回模块参数的迭代器。
`register_backward_hook`(hook)	在模块上注册 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__

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

属性

mc_dropout_enabled

方法

`add_module`(name, module)	向当前模块添加子模块。
`apply`(fn)	递归地将 `fn` 应用于每个子模块（通过 `.children()` 返回）以及自身。
`bfloat16`()	将所有浮点参数和缓冲区转换为 `bfloat16` 数据类型。
`buffers`([recurse])	返回模块缓冲区的迭代器。
`children`()	返回直接子模块的迭代器。
`compile`(args, *kwargs)	使用 `torch.compile()` 编译此模块的前向计算。
`cpu`()	将所有模型参数和缓冲区移动到 CPU。
`cuda`([device])	将所有模型参数和缓冲区移动到 GPU。
`double`()	将所有浮点参数和缓冲区转换为 `double` 数据类型。
`eval`()	将模块设置为评估模式。
`extra_repr`()	返回模块的附加表示。
`float`()	将所有浮点参数和缓冲区转换为 `float` 数据类型。
`forward`(input)	定义每次调用时执行的计算。
`get_buffer`(target)	如果存在，则返回由 `target` 指定的缓冲区，否则抛出错误。
`get_extra_state`()	返回模块 state_dict 中包含的任何额外状态。
`get_parameter`(target)	如果存在，则返回由 `target` 指定的参数，否则抛出错误。
`get_submodule`(target)	如果存在，则返回由 `target` 指定的子模块，否则抛出错误。
`half`()	将所有浮点参数和缓冲区转换为 `half` 数据类型。
`ipu`([device])	将所有模型参数和缓冲区移动到 IPU。
`load_state_dict`(state_dict[, strict, assign])	将 `state_dict` 中的参数和缓冲区复制到此模块及其后代模块中。
`modules`()	返回网络中所有模块的迭代器。
`mtia`([device])	将所有模型参数和缓冲区移动到 MTIA。
`named_buffers`([prefix, recurse, ...])	返回模块缓冲区的迭代器，同时返回缓冲区的名称和缓冲区本身。
`named_children`()	返回直接子模块的迭代器，同时返回模块的名称和模块本身。
`named_modules`([memo, prefix, remove_duplicate])	返回网络中所有模块的迭代器，同时返回模块的名称和模块本身。
`named_parameters`([prefix, recurse, ...])	返回模块参数的迭代器，同时返回参数的名称和参数本身。
`parameters`([recurse])	返回模块参数的迭代器。
`register_backward_hook`(hook)	在模块上注册 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) – 要应用于每个子模块的函数
返回: self
返回类型: Module

示例

>>> @torch.no_grad()
>>> def init_weights(m):
>>>     print(m)
>>>     if type(m) == nn.Linear:
>>>         m.weight.fill_(1.0)
>>>         print(m.weight)
>>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2))
>>> net.apply(init_weights)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)

bfloat16()¶

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

注意

此方法会原地修改模块。

返回: self
返回类型: Module

buffers(recurse=True)¶

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

参数: recurse (bool) – 如果为 True，则产生此模块及其所有子模块的缓冲区。否则，仅产生此模块的直接成员缓冲区。
产生: torch.Tensor – 模块缓冲区

示例

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

返回类型: Iterator[Tensor]

call_super_init: bool = False¶

children()¶

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

产生: Module – 子模块
返回类型: Iterator[Module]

compile(*args, **kwargs)¶

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

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

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

cpu()¶

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

注意

此方法会原地修改模块。

返回: self
返回类型: Module

cuda(device=None)¶

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

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

注意

此方法会原地修改模块。

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

double()¶

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

注意

此方法会原地修改模块。

返回: self
返回类型: Module

dump_patches: bool = False¶

eval()¶

将模块设置为评估模式。

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

这等同于 self.train(False)。

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

返回: self
返回类型: Module

extra_repr()¶

返回模块的附加表示。

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

返回类型: str

float()¶

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

注意

此方法会原地修改模块。

返回: self
返回类型: Module

forward(input)[source]¶

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

应由所有子类覆盖。

注意

尽管前向传播的实现需要在此外函数中定义，但在此之后应调用 Module 实例而不是此函数，因为前者负责运行已注册的 hook，而后者会默默忽略它们。

返回类型: Tensor

get_buffer(target)¶

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

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

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

get_extra_state()¶

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

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

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

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

get_parameter(target)¶

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

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

参数: target (str) – 要查找的 Parameter 的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅 get_submodule 的说明。）
返回: 由 target 引用的 Parameter
返回类型: torch.nn.Parameter
抛出: AttributeError – 如果目标字符串引用了无效路径或解析到的不是 nn.Parameter

get_submodule(target)¶

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

例如，假设您有一个 nn.Module A，其结构如下所示

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

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

要检查是否存在 linear 子模块，我们会调用 get_submodule("net_b.linear")。要检查是否存在 conv 子模块，我们会调用 get_submodule("net_b.net_c.conv")。

get_submodule 的运行时长受限于 target 中的模块嵌套深度。查询 named_modules 也能达到同样的结果，但对于传递性模块的数量来说，它是 O(N) 的复杂度。所以，对于简单检查查看是否存在某个子模块，应始终使用 get_submodule。

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

half()¶

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

注意

此方法会原地修改模块。

返回: self
返回类型: Module

inplace: bool¶

ipu(device=None)¶

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

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

注意

此方法会原地修改模块。

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

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

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

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

警告

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

参数

state_dict (dict) – 包含参数和持久性缓冲区的字典。
strict (bool, optional) – 是否严格强制 state_dict 中的键与此模块 state_dict() 函数返回的键匹配。默认值: True
assign (bool, optional) – 当设置为 False 时，当前模块中张量的属性会被保留，而设置为 True 时则保留 state dict 中张量的属性。唯一的例外是 Default: ``False` 的 requires_grad 字段

返回

missing_keys 是一个 str 列表，包含此模块期望但提供的 state_dict 中缺失的任何键。
unexpected_keys 是一个 str 列表，包含此模块不期望但在提供的 state_dict 中存在的键。
包含 missing_keys 和 unexpected_keys 字段的 NamedTuple
本模块预期需要，但在提供的 state_dict 中存在。

返回类型

NamedTuple with missing_keys and unexpected_keys fields

注意

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

property mc_dropout_enabled: bool¶

返回类型: bool

modules()¶

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

产生: Module – 网络中的模块

注意

重复的模块只返回一次。在以下示例中，l 将只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.modules()):
...     print(idx, '->', m)

0 -> Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)
1 -> Linear(in_features=2, out_features=2, bias=True)

返回类型: Iterator[Module]

mtia(device=None)¶

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

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

注意

此方法会原地修改模块。

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

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

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

参数

prefix (str) – 要添加到所有缓冲区名称的前缀。
recurse (bool, optional) – 如果为 True，则产生此模块及其所有子模块的缓冲区。否则，仅产生此模块的直接成员缓冲区。默认为 True。
remove_duplicate (bool, optional) – 是否移除结果中的重复缓冲区。默认为 True。

产生

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

示例

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

返回类型: Iterator[Tuple[str, Tensor]]

named_children()¶

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

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

示例

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

返回类型: Iterator[Tuple[str, Module]]

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

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

参数

memo (Optional[Set[Module], None]) – 用于存储已添加到结果中的模块集合的备忘录
prefix (str) – 将添加到模块名称的前缀
remove_duplicate (bool) – 是否移除结果中的重复模块实例

产生

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

注意

重复的模块只返回一次。在以下示例中，l 将只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.named_modules()):
...     print(idx, '->', m)

0 -> ('', Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
))
1 -> ('0', Linear(in_features=2, out_features=2, bias=True))

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

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

参数

prefix (str) – 要添加到所有参数名称的前缀。
recurse (bool) – 如果为 True，则产生此模块及其所有子模块的参数。否则，仅产生此模块的直接成员参数。
remove_duplicate (bool, optional) – 是否移除结果中的重复参数。默认为 True。

产生

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

示例

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

返回类型: Iterator[Tuple[str, Parameter]]

p: float¶

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，无论调用模块时是否抛出异常，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(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 将仅对应于作为位置参数提供的输入，所有关键字参数都被忽略。grad_input 和 grad_output 中的条目对于所有非 Tensor 参数将是 None。

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

警告

使用 backward hook 时不允许原地修改输入或输出，否则将抛出错误。

参数

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。

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

警告

使用 backward hook 时不允许原地修改输入，否则将抛出错误。

参数

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

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

requires_grad_(requires_grad=True)¶

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

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

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

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

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

set_extra_state(state)¶

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

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

参数: state (dict) – 来自 state_dict 的额外状态
返回类型: None

set_submodule(target, module)¶

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

例如，假设您有一个 nn.Module A，其结构如下所示

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

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

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

参数

target (str) – 要查找的子模块的完全限定字符串名称。（有关如何指定完全限定字符串，请参阅上例。）
module (Module) – 用于设置子模块的模块。

抛出

ValueError – 如果目标字符串为空
AttributeError – 如果目标字符串引用了无效路径或解析到的不是 nn.Module

返回类型

None

share_memory()¶

请参阅 torch.Tensor.share_memory_()。

返回类型: ~T

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

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

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

注意

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

警告

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

警告

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

参数

destination (dict, optional) – 如果提供，模块的状态将更新到字典中并返回同一对象。否则，将创建并返回一个 OrderedDict。默认值: None。
prefix (str, optional) – 添加到参数和缓冲区名称的前缀，用于组成 state_dict 中的键。默认值: ''。
keep_vars (bool, optional) – 默认情况下，返回的 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（如果给定），但 dtypes 保持不变。设置 non_blocking 时，它会尝试（如果可能）相对于主机异步转换/移动，例如，将具有固定内存的 CPU 张量移动到 CUDA 设备。

请参阅下面的示例。

注意

此方法会原地修改模块。

参数

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

返回

self

返回类型

Module

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> linear = nn.Linear(2, 2)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]])
>>> linear.to(torch.double)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]], dtype=torch.float64)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> gpu1 = torch.device("cuda:1")
>>> linear.to(gpu1, dtype=torch.half, non_blocking=True)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1')
>>> cpu = torch.device("cpu")
>>> linear.to(cpu)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16)

>>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble)
>>> linear.weight
Parameter containing:
tensor([[ 0.3741+0.j,  0.2382+0.j],
        [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128)
>>> linear(torch.ones(3, 2, dtype=torch.cdouble))
tensor([[0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)

to_empty(*, device, recurse=True)¶

在不复制存储的情况下将参数和缓冲区移动到指定设备。

参数

device (torch.device) – 本模块中参数和缓冲区所需设备。
recurse (bool) – 是否应将子模块的参数和缓冲区递归地移动到指定设备。

返回

self

返回类型

Module

train(mode=True)¶

将模块设置为训练模式。

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

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

training: bool¶

type(dst_type)¶

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

注意

此方法会原地修改模块。

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

xpu(device=None)¶

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

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

注意

此方法会原地修改模块。

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

zero_grad(set_to_none=True)¶

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

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

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

darts.utils.torch.random_method(decorated)[源]¶

可用于类中任何方法的装饰器，它将提供一个隔离的 torch 随机上下文。

该装饰器将在对象上存储一个 _random_instance 属性，以便保留对 RNG 的后续调用。

参数: decorated (Callable[…, ~T]) – 一个将在隔离的 torch 随机上下文中运行的方法。
返回类型: Callable[…, ~T]

上一个

时间序列生成工具

下一个

其他实用函数