自动微分包 - torch.autograd

torch.autograd 提供了类和函数，用于实现任意标量值函数的自动微分。

它只需要对现有代码进行最少的更改 - 您只需使用 requires_grad=True 关键字声明需要计算梯度的 Tensor 。目前，我们仅支持浮点 Tensor 类型（ half, float, double 和 bfloat16）和复数 Tensor 类型（cfloat, cdouble）的自动微分。

backward	计算给定张量相对于图叶节点的梯度之和。
grad	计算并返回输出相对于输入的梯度之和。

前向模式自动微分

警告

此 API 尚处于 beta 阶段。即使函数签名不太可能更改，我们也计划在认为其稳定之前改进算子覆盖率。

有关如何使用此 API 的详细步骤，请参阅前向模式 AD 教程。

forward_ad.dual_level	前向 AD 的上下文管理器，其中所有前向 AD 计算都必须在 dual_level 上下文中进行。
forward_ad.make_dual	将张量值与其切线相关联，以创建用于前向 AD 梯度计算的“对偶张量”。
forward_ad.unpack_dual	解包“对偶张量”以获取其张量值及其前向 AD 梯度。
forward_ad.enter_dual_level	进入新的前向梯度级别。
forward_ad.exit_dual_level	退出前向梯度级别。
forward_ad.UnpackedDualTensor	由 unpack_dual() 返回的 Namedtuple，包含对偶张量的原始分量和切线分量。

函数式高级 API

警告

此 API 尚处于 beta 阶段。即使函数签名不太可能更改，我们也计划在认为其稳定之前大幅提升性能。

本节包含 autograd 的高级 API，它建立在上述基本 API 之上，并允许您计算雅可比矩阵、黑塞矩阵等。

此 API 适用于仅接受张量作为输入并仅返回张量的用户提供的函数。如果您的函数接受其他非张量参数或未设置 requires_grad 的张量，则可以使用 lambda 来捕获它们。例如，对于一个函数 f ，它接受三个输入：一个我们想要计算雅可比矩阵的张量，另一个应该被视为常量的张量，以及一个布尔标志，如 f(input, constant, flag=flag) ，您可以将其用作 functional.jacobian(lambda x: f(x, constant, flag=flag), input) 。

functional.jacobian	计算给定函数的雅可比矩阵。
functional.hessian	计算给定标量函数的黑塞矩阵。
functional.vjp	计算向量 v 与给定函数在输入点处的雅可比矩阵之间的点积。
functional.jvp	计算给定函数在输入点处的雅可比矩阵与向量 v 之间的点积。
functional.vhp	计算向量 v 与给定标量函数在指定点处的黑塞矩阵之间的点积。
functional.hvp	计算标量函数的黑塞矩阵与向量 v 在指定点处的点积。

局部禁用梯度计算

有关 no-grad 和推理模式之间的差异以及可能与两者混淆的其他相关机制的更多信息，请参阅局部禁用梯度计算。另请参阅局部禁用梯度计算，获取可用于局部禁用梯度的函数列表。

默认梯度布局

当非稀疏 param 在 torch.autograd.backward() 或 torch.Tensor.backward() 期间接收到非稀疏梯度时， param.grad 的累积方式如下。

如果 param.grad 最初为 None

1. 如果 param 的内存是非重叠且密集的，则使用与 param 匹配的步幅创建 .grad （因此与 param 的布局匹配）。

2. 否则，使用行优先连续步幅创建 .grad 。

如果 param 已经具有非稀疏 .grad 属性

3. 如果 create_graph=False ， backward() 会就地累积到 .grad 中，从而保留其步幅。

4. 如果 create_graph=True ， backward() 会将 .grad 替换为新的张量 .grad + new grad ，这会尝试（但不保证）匹配先前存在的 .grad 的步幅。

建议使用默认行为（在第一次 backward() 之前让 .grad 为 None ，以便根据 1 或 2 创建其布局，并根据 3 或 4 随时间保留），以获得最佳性能。调用 model.zero_grad() 或 optimizer.zero_grad() 不会影响 .grad 布局。

实际上，在每个累积阶段之前将所有 .grad 重置为 None ，例如

for iterations...
    ...
    for param in model.parameters():
        param.grad = None
    loss.backward()

这样，它们每次都根据 1 或 2 重新创建，这是 model.zero_grad() 或 optimizer.zero_grad() 的有效替代方案，可能会提高某些网络的性能。

手动梯度布局

如果您需要手动控制 .grad 的步幅，请在第一次 backward() 之前将 param.grad = 分配为具有所需步幅的零张量，并且永远不要将其重置为 None 。只要 create_graph=False ，3 就可以保证您的布局得到保留。4 表示即使 create_graph=True ，您的布局也可能得到保留。

张量的原地操作

在 autograd 中支持原地操作是一件困难的事情，我们不鼓励在大多数情况下使用它们。Autograd 的激进缓冲区释放和重用使其非常高效，并且在极少数情况下，原地操作实际上会显着降低内存使用量。除非您在内存压力很大的情况下运行，否则您可能永远不需要使用它们。

原地正确性检查

所有 Tensor 都会跟踪应用于它们的原地操作，如果实现检测到张量已在某个函数中保存以用于反向传播，但之后已就地修改，则在反向传播开始后会引发错误。这确保了如果您正在使用原地函数并且没有看到任何错误，则可以确保计算出的梯度是正确的。

Variable（已弃用）

警告

Variable API 已弃用：不再需要 Variable 即可将 autograd 与张量一起使用。Autograd 自动支持 requires_grad 设置为 True 的张量。以下是有关更改内容的快速指南

• Variable(tensor) 和 Variable(tensor, requires_grad) 仍然可以按预期工作，但它们返回张量而不是 Variable。

• var.data 与 tensor.data 相同。

• 诸如 var.backward(), var.detach(), var.register_hook() 之类的方法现在可以在具有相同方法名称的张量上工作。

此外，现在可以使用工厂方法（例如 torch.randn() ， torch.zeros() ， torch.ones() 以及其他类似的方法）创建 requires_grad=True 的张量，如下所示

autograd_tensor = torch.randn((2, 3, 4), requires_grad=True)

张量自动微分函数

torch.Tensor.grad	默认情况下，此属性为 None ，并且在首次调用 backward() 计算 self 的梯度时变为张量。
torch.Tensor.requires_grad	如果需要为此张量计算梯度，则为 True ，否则为 False 。
torch.Tensor.is_leaf	根据约定，所有 requires_grad 为 False 的张量都将是叶张量。
torch.Tensor.backward([gradient, ...])	计算当前张量 wrt 图叶节点的梯度。
torch.Tensor.detach	返回一个新的张量，该张量与当前图分离。
torch.Tensor.detach_	将张量从创建它的图中分离，使其成为叶节点。
torch.Tensor.register_hook(hook)	注册一个反向钩子。
torch.Tensor.register_post_accumulate_grad_hook(hook)	注册一个在梯度累积后运行的反向钩子。
torch.Tensor.retain_grad()	使此张量在其 grad 在 backward() 期间填充。

函数

class torch.autograd.Function(*args, **kwargs)

用于创建自定义 autograd.Function 的基类。

要创建自定义 autograd.Function ，请子类化此类并实现 forward() 和 backward() 静态方法。然后，要在前向传播中使用您的自定义操作，请调用类方法 apply 。不要直接调用 forward() 。

为确保正确性和最佳性能，请确保您在 ctx 上调用正确的方法，并使用 torch.autograd.gradcheck() 验证您的反向函数。

有关如何使用此类别的更多详细信息，请参阅扩展 torch.autograd。

示例

>>> class Exp(Function):
>>>     @staticmethod
>>>     def forward(ctx, i):
>>>         result = i.exp()
>>>         ctx.save_for_backward(result)
>>>         return result
>>>
>>>     @staticmethod
>>>     def backward(ctx, grad_output):
>>>         result, = ctx.saved_tensors
>>>         return grad_output * result
>>>
>>> # Use it by calling the apply method:
>>> output = Exp.apply(input)

Function.forward	定义自定义 autograd Function 的前向传播。
Function.backward	定义使用反向模式自动微分来区分操作的公式。
Function.jvp	定义使用前向模式自动微分来区分操作的公式。
Function.vmap	定义此 autograd.Function 在 torch.vmap() 下的行为。

上下文方法混入

创建新的 Function 时，以下方法可用于 ctx 。

function.FunctionCtx.mark_dirty	将给定的张量标记为在原地操作中已修改。
function.FunctionCtx.mark_non_differentiable	将输出标记为不可微分。
function.FunctionCtx.save_for_backward	保存给定的张量，以便将来调用 backward() 。
function.FunctionCtx.set_materialize_grads	设置是否物化梯度张量。

自定义函数实用工具

反向方法的装饰器。

function.once_differentiable

用于构建 PyTorch 实用工具的基本自定义 Function

function.BackwardCFunction	此类用于内部 autograd 工作。
function.InplaceFunction	此类仅出于向后兼容性原因而存在。
function.NestedIOFunction	此类仅出于向后兼容性原因而存在。

数值梯度检查

gradcheck	对照 inputs 中浮点型或复数类型且 requires_grad=True 的张量的解析梯度，检查通过小有限差分计算的梯度。
gradgradcheck	对照 inputs 和 grad_outputs 中浮点型或复数类型且 requires_grad=True 的张量的解析梯度，检查通过小有限差分计算的梯度的梯度。
GradcheckError	由 gradcheck() 和 gradgradcheck() 引发的错误。

性能分析器

Autograd 包括一个性能分析器，可让您检查模型内部不同算子的成本 - 包括 CPU 和 GPU。目前实现了三种模式 - 仅 CPU，使用 profile 。基于 nvprof（注册 CPU 和 GPU 活动），使用 emit_nvtx 。以及基于 vtune 性能分析器，使用 emit_itt 。

class torch.autograd.profiler.profile(enabled=True, *, use_cuda=False, use_device=None, record_shapes=False, with_flops=False, profile_memory=False, with_stack=False, with_modules=False, use_kineto=False, use_cpu=True, experimental_config=None, acc_events=False, custom_trace_id_callback=None)

管理 autograd 分析器状态并保存结果摘要的上下文管理器。

其底层只是记录 C++ 中执行的函数事件，并将这些事件暴露给 Python。您可以将任何代码包装在其中，它将仅报告 PyTorch 函数的运行时。注意：分析器是线程本地的，并且会自动传播到异步任务中

参数

• enabled (bool, optional) – 将此项设置为 False 会使此上下文管理器成为空操作。

• use_cuda (bool, optional) – 使用 cudaEvent API 启用 CUDA 事件的计时。（将被弃用）

• use_device (str, optional) – 启用设备事件的计时。当使用 CUDA 时，会为每个张量操作增加大约 4us 的开销。有效的设备选项为 ‘cuda’、‘xpu’、‘mtia’ 和 ‘privateuseone’。

• record_shapes (bool, optional) – 如果设置了形状记录，将收集有关输入维度的信息。这允许查看底层使用了哪些维度，并使用 prof.key_averages(group_by_input_shape=True) 进一步按维度分组。请注意，形状记录可能会使您的分析数据产生偏差。建议在有和没有形状记录的情况下分别运行，以验证计时。对于最底层的事件（在嵌套函数调用的情况下），偏差很可能可以忽略不计。但是对于更高级别的函数，由于形状收集，总的自 CPU 时间可能会人为地增加。

• with_flops (bool, optional) – 如果设置了 with_flops，分析器将使用运算符的输入形状来估计 FLOPs（浮点运算）值。这允许估计硬件性能。目前，此选项仅适用于矩阵乘法和 2D 卷积运算符。

• profile_memory (bool, optional) – 跟踪张量内存分配/释放。

• with_stack (bool, optional) – 记录操作的源信息（文件和行号）。

• with_modules (bool) – 记录与操作的调用堆栈相对应的模块层次结构（包括函数名称）。例如，如果模块 A 的 forward 调用了模块 B 的 forward，其中包含 aten::add 操作，则 aten::add 的模块层次结构为 A.B。请注意，目前此支持仅适用于 TorchScript 模型，而不适用于 eager 模式模型。

• use_kineto (bool, optional) – 实验性功能，启用使用 Kineto 分析器进行分析。

• use_cpu (bool, optional) – 分析 CPU 事件；设置为 False 需要 use_kineto=True，并且可以用于降低仅 GPU 分析的开销。

• experimental_config (_ExperimentalConfig) – Kineto 等分析器库使用的一组实验性选项。请注意，不保证向后兼容性。

• acc_events (bool) – 启用跨多个分析周期的 FunctionEvents 累积

示例

>>> x = torch.randn((1, 1), requires_grad=True)
>>> with torch.autograd.profiler.profile() as prof:
>>>     for _ in range(100):  # any normal python code, really!
>>>         y = x ** 2
>>>         y.backward()
>>> # NOTE: some columns were removed for brevity
>>> print(prof.key_averages().table(sort_by="self_cpu_time_total"))
-----------------------------------  ---------------  ---------------  ---------------
Name                                 Self CPU total   CPU time avg     Number of Calls
-----------------------------------  ---------------  ---------------  ---------------
mul                                  32.048ms         32.048ms         200
pow                                  27.041ms         27.041ms         200
PowBackward0                         9.727ms          55.483ms         100
torch::autograd::AccumulateGrad      9.148ms          9.148ms          100
torch::autograd::GraphRoot           691.816us        691.816us        100
-----------------------------------  ---------------  ---------------  ---------------

profiler.profile.export_chrome_trace	将 EventList 导出为 Chrome 跟踪工具文件。
profiler.profile.key_averages	对所有函数事件的键求平均值。
profiler.profile.self_cpu_time_total	返回在 CPU 上花费的总时间。
profiler.profile.total_average	对所有事件求平均值。
profiler.parse_nvprof_trace
profiler.EnforceUnique	如果一个键被多次看到，则引发错误。
profiler.KinetoStepTracker	提供用于全局递增步数的抽象。
profiler.record_function	上下文管理器/函数装饰器，在运行 autograd 分析器时，为代码块/函数添加标签。
profiler_util.Interval
profiler_util.Kernel
profiler_util.MemRecordsAcc	用于访问间隔中 mem_records 的加速结构。
profiler_util.StringTable

class torch.autograd.profiler.emit_nvtx(enabled=True, record_shapes=False)

使每个 autograd 操作发出 NVTX 范围的上下文管理器。

在 nvprof 下运行程序时很有用

nvprof --profile-from-start off -o trace_name.prof -- <regular command here>

不幸的是，没有办法强制 nvprof 将其收集的数据刷新到磁盘，因此对于 CUDA 分析，必须使用此上下文管理器来注释 nvprof 跟踪，并等待进程退出才能检查它们。然后，可以使用 NVIDIA Visual Profiler (nvvp) 可视化时间线，或者 torch.autograd.profiler.load_nvprof() 可以加载结果以进行检查，例如在 Python REPL 中。

参数

• enabled (bool, optional) – 设置 enabled=False 会使此上下文管理器成为空操作。默认值：True。

• record_shapes (bool, optional) – 如果 record_shapes=True，则包装每个 autograd 操作的 nvtx 范围将附加有关该操作接收的 Tensor 参数大小的信息，格式如下：[[arg0.size(0), arg0.size(1), ...], [arg1.size(0), arg1.size(1), ...], ...]。非张量参数将由 [] 表示。参数将按照后端操作接收它们的顺序进行列出。请注意，此顺序可能与这些参数在 Python 端传递的顺序不匹配。另请注意，形状记录可能会增加 nvtx 范围创建的开销。默认值：False

示例

>>> with torch.cuda.profiler.profile():
...     model(x)  # Warmup CUDA memory allocator and profiler
...     with torch.autograd.profiler.emit_nvtx():
...         model(x)

前向-后向关联

在使用 emit_nvtx 创建的 Nvidia Visual Profiler 中查看配置文件时，将每个后向传递操作与相应的前向传递操作相关联可能很困难。为了简化此任务，emit_nvtx 将序列号信息附加到其生成的范围。

在前向传递期间，每个函数范围都用 seq=<N> 修饰。seq 是一个运行计数器，每次创建新的后向 Function 对象并为后向存储时，计数器都会递增。因此，与每个前向函数范围关联的 seq=<N> 注释告诉您，如果此函数创建了后向 Function 对象，则后向对象将接收序列号 N。在后向传递期间，包装每个 C++ 后向 Function 的 apply() 调用的顶层范围都用 stashed seq=<M> 修饰。M 是创建后向对象时使用的序列号。通过比较后向中的 stashed seq 编号与前向中的 seq 编号，您可以跟踪哪个前向操作创建了每个后向 Function。

在后向传递期间执行的任何函数也用 seq=<N> 修饰。在默认后向（使用 create_graph=False）中，此信息无关紧要，实际上，对于所有此类函数，N 可能只是 0。只有与后向 Function 对象的 apply() 方法关联的顶层范围才有用，因为它们是将这些 Function 对象与较早的前向传递相关联的一种方法。

双重后向

另一方面，如果正在进行使用 create_graph=True 的后向传递（换句话说，如果您正在为双重后向设置），则在后向期间执行的每个函数都会获得非零的、有用的 seq=<N>。这些函数本身可能会创建 Function 对象，以便稍后在双重后向期间执行，就像前向传递中的原始函数一样。后向和双重后向之间的关系在概念上与前向和后向之间的关系相同：函数仍然发出带有当前序列号标记的范围，它们创建的 Function 对象仍然存储这些序列号，并且在最终的双重后向期间，Function 对象的 apply() 范围仍然使用 stashed seq 编号进行标记，可以将其与来自后向传递的 seq 编号进行比较。

class torch.autograd.profiler.emit_itt(enabled=True, record_shapes=False)

使每个 autograd 操作发出 ITT 范围的上下文管理器。

在 Intel(R) VTune Profiler 下运行程序时很有用

vtune <--vtune-flags> <regular command here>

Instrumentation and Tracing Technology (ITT) API 使您的应用程序能够在跨不同 Intel 工具的执行期间生成和控制跟踪数据的收集。此上下文管理器用于注释 Intel(R) VTune Profiling 跟踪。借助此上下文管理器，您将能够在 Intel(R) VTune Profiler GUI 中看到标记的范围。

参数

• enabled (bool, optional) – 设置 enabled=False 会使此上下文管理器成为空操作。默认值：True。

• record_shapes (bool, optional) – 如果 record_shapes=True，则包装每个 autograd 操作的 itt 范围将附加有关该操作接收的 Tensor 参数大小的信息，格式如下：[[arg0.size(0), arg0.size(1), ...], [arg1.size(0), arg1.size(1), ...], ...]。非张量参数将由 [] 表示。参数将按照后端操作接收它们的顺序进行列出。请注意，此顺序可能与这些参数在 Python 端传递的顺序不匹配。另请注意，形状记录可能会增加 itt 范围创建的开销。默认值：False

示例

>>> with torch.autograd.profiler.emit_itt():
...     model(x)

profiler.load_nvprof

打开 nvprof 跟踪文件并解析 autograd 注释。

调试和异常检测

class torch.autograd.detect_anomaly(check_nan=True)

启用 autograd 引擎异常检测的上下文管理器。

这会执行两项操作

• 在启用检测的情况下运行前向传递将允许后向传递打印创建失败的后向函数的前向操作的回溯。

• 如果 check_nan 为 True，则任何生成 “nan” 值的后向计算都将引发错误。默认值 True。

警告

此模式应仅在调试时启用，因为不同的测试会减慢程序的执行速度。

示例

>>> import torch
>>> from torch import autograd
>>> class MyFunc(autograd.Function):
...     @staticmethod
...     def forward(ctx, inp):
...         return inp.clone()
...     @staticmethod
...     def backward(ctx, gO):
...         # Error during the backward pass
...         raise RuntimeError("Some error in backward")
...         return gO.clone()
>>> def run_fn(a):
...     out = MyFunc.apply(a)
...     return out.sum()
>>> inp = torch.rand(10, 10, requires_grad=True)
>>> out = run_fn(inp)
>>> out.backward()
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
      File "/your/pytorch/install/torch/_tensor.py", line 93, in backward
        torch.autograd.backward(self, gradient, retain_graph, create_graph)
      File "/your/pytorch/install/torch/autograd/__init__.py", line 90, in backward
        allow_unreachable=True)  # allow_unreachable flag
      File "/your/pytorch/install/torch/autograd/function.py", line 76, in apply
        return self._forward_cls.backward(self, *args)
      File "<stdin>", line 8, in backward
    RuntimeError: Some error in backward
>>> with autograd.detect_anomaly():
...     inp = torch.rand(10, 10, requires_grad=True)
...     out = run_fn(inp)
...     out.backward()
    Traceback of forward call that caused the error:
      File "tmp.py", line 53, in <module>
        out = run_fn(inp)
      File "tmp.py", line 44, in run_fn
        out = MyFunc.apply(a)
    Traceback (most recent call last):
      File "<stdin>", line 4, in <module>
      File "/your/pytorch/install/torch/_tensor.py", line 93, in backward
        torch.autograd.backward(self, gradient, retain_graph, create_graph)
      File "/your/pytorch/install/torch/autograd/__init__.py", line 90, in backward
        allow_unreachable=True)  # allow_unreachable flag
      File "/your/pytorch/install/torch/autograd/function.py", line 76, in apply
        return self._forward_cls.backward(self, *args)
      File "<stdin>", line 8, in backward
    RuntimeError: Some error in backward

class torch.autograd.set_detect_anomaly(mode, check_nan=True)

用于打开或关闭 autograd 引擎异常检测的上下文管理器。

set_detect_anomaly 将根据其参数 mode 启用或禁用 autograd 异常检测。它可以作为上下文管理器或函数使用。

有关异常检测行为的详细信息，请参阅上面的 detect_anomaly。

参数

• mode (bool) – 标志是否启用异常检测 (True) 或禁用 (False)。

• check_nan (bool) – 标志是否在后向生成 “nan” 时引发错误

grad_mode.set_multithreading_enabled

用于打开或关闭多线程后向的上下文管理器。

Autograd 图

Autograd 公开了允许检查图并在后向传递期间介入行为的方法。

torch.Tensor 的 grad_fn 属性保存一个 torch.autograd.graph.Node，如果张量是 autograd 记录的操作的输出（即，启用了 grad_mode 并且至少一个输入需要梯度），否则为 None。

graph.Node.name	返回名称。
graph.Node.metadata	返回元数据。
graph.Node.next_functions
graph.Node.register_hook	注册后向钩子。
graph.Node.register_prehook	注册后向预钩子。
graph.increment_version	更新 autograd 元数据，跟踪给定的 Tensor 是否已就地修改。

某些操作需要在前向传递期间保存中间结果，以便执行后向传递。这些中间结果作为属性保存在 grad_fn 上，并且可以访问。例如

>>> a = torch.tensor([0., 0., 0.], requires_grad=True)
>>> b = a.exp()
>>> print(isinstance(b.grad_fn, torch.autograd.graph.Node))
True
>>> print(dir(b.grad_fn))
['__call__', '__class__', '__delattr__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '_raw_saved_result', '_register_hook_dict', '_saved_result', 'metadata', 'name', 'next_functions', 'register_hook', 'register_prehook', 'requires_grad']
>>> print(torch.allclose(b.grad_fn._saved_result, b))
True

您还可以定义如何使用钩子打包/解包这些保存的张量。一个常见的应用是通过将这些中间结果保存到磁盘或 CPU 而不是将它们留在 GPU 上来权衡计算与内存。如果您注意到您的模型在评估期间适合 GPU，但在训练期间不适合，这将特别有用。另请参阅 Saved Tensors 钩子。

class torch.autograd.graph.saved_tensors_hooks(pack_hook, unpack_hook)

为保存的张量设置一对打包/解包钩子的上下文管理器。

使用此上下文管理器来定义操作的中间结果应如何在保存前打包，以及在检索时如何解包。

在该上下文中，每次操作保存张量以进行后向传播时，都会调用 pack_hook 函数（这包括使用 save_for_backward() 保存的中间结果，以及 PyTorch 定义的操作记录的中间结果）。然后，pack_hook 的输出将存储在计算图中，而不是原始张量。

当需要访问保存的张量时，即在执行 torch.Tensor.backward() 或 torch.autograd.grad() 时，将调用 unpack_hook。它以 pack_hook 返回的打包对象作为参数，并且应返回一个张量，该张量具有与原始张量（作为相应 pack_hook 的输入传递）相同的内容。

钩子应具有以下签名

pack_hook(tensor: Tensor) -> Any

unpack_hook(Any) -> Tensor

其中 pack_hook 的返回值是 unpack_hook 的有效输入。

通常，您希望 unpack_hook(pack_hook(t)) 在值、大小、dtype 和设备方面等于 t。

示例

>>> def pack_hook(x):
...     print("Packing", x)
...     return x
>>>
>>> def unpack_hook(x):
...     print("Unpacking", x)
...     return x
>>>
>>> a = torch.ones(5, requires_grad=True)
>>> b = torch.ones(5, requires_grad=True) * 2
>>> with torch.autograd.graph.saved_tensors_hooks(pack_hook, unpack_hook):
...     y = a * b
Packing tensor([1., 1., 1., 1., 1.], requires_grad=True)
Packing tensor([2., 2., 2., 2., 2.], grad_fn=<MulBackward0>)
>>> y.sum().backward()
Unpacking tensor([1., 1., 1., 1., 1.], requires_grad=True)
Unpacking tensor([2., 2., 2., 2., 2.], grad_fn=<MulBackward0>)

警告

对任一钩子的输入执行就地操作可能会导致未定义的行为。

警告

一次只允许一对钩子。当递归嵌套此上下文管理器时，将仅应用最内层的一对钩子。

class torch.autograd.graph.save_on_cpu(pin_memory=False, device_type='cuda')

在前向传递中保存的张量将存储在 cpu 上，然后在后向传播时检索的上下文管理器。

当在此上下文管理器中执行操作时，在前向传递期间在图中保存的中间结果将被移动到 CPU，然后在后向传递需要时复制回原始设备。如果图已在 CPU 上，则不执行张量复制。

使用此上下文管理器来权衡计算与 GPU 内存使用量（例如，当您的模型在训练期间不适合 GPU 内存时）。

参数

pin_memory (bool) – 如果 True，张量将在打包期间保存到 CPU 锁页内存，并在解包期间异步复制到 GPU。默认为 False。另请参阅 使用锁页内存缓冲区。

示例

>>> a = torch.randn(5, requires_grad=True, device="cuda")
>>> b = torch.randn(5, requires_grad=True, device="cuda")
>>> c = torch.randn(5, requires_grad=True, device="cuda")
>>>
>>> def f(a, b, c):
...     prod_1 = a * b           # a and b are saved on GPU
...     with torch.autograd.graph.save_on_cpu():
...         prod_2 = prod_1 * c  # prod_1 and c are saved on CPU
...     y = prod_2 * a           # prod_2 and a are saved on GPU
...     return y
>>>
>>> y = f(a, b, c)
>>> del a, b, c  # for illustration only
>>> # the content of a, b, and prod_2 are still alive on GPU
>>> # the content of prod_1 and c only live on CPU
>>> y.sum().backward()  # all CPU tensors are moved back to GPU, for backward
>>> # all intermediary tensors are released (deleted) after the call to backward

class torch.autograd.graph.disable_saved_tensors_hooks(error_message)

禁用保存的张量默认钩子功能的上下文管理器。

如果您要创建与保存的张量默认钩子不兼容的功能，这将很有用。

参数

error_message (str) – 当保存的张量默认钩子在禁用时被使用，将引发带有此错误消息的 RuntimeError。

返回类型

Generator[None, None, None]

示例

>>> message = "saved tensors default hooks are disabled"
>>> with torch.autograd.graph.disable_saved_tensors_hooks(message):
...     # Raises RuntimeError: saved tensors default hooks are disabled
...     with torch.autograd.graph.save_on_cpu():
...         pass

class torch.autograd.graph.register_multi_grad_hook(tensors, fn, *, mode='all')

注册多梯度后向钩子。

有两种支持的模式："all" 和 "any"。

在 "all" 模式下，钩子将在计算出 tensors 中每个张量的梯度后被调用。如果张量在 tensors 中，但不是图的一部分，或者如果不需要张量来计算当前 .backward() 或 .grad() 调用指定的任何 inputs 的梯度，则将忽略此张量，并且钩子将不会等待计算其梯度。

在计算出每个非忽略张量的梯度后，将使用这些梯度调用 fn。对于未计算梯度的张量，将传递 None。

在 "any" 模式下，钩子将在计算出 tensors 中张量的第一个梯度后被调用。钩子将使用该梯度作为其参数进行调用。

钩子不应修改其参数。

此函数返回一个带有 handle.remove() 方法的句柄，该方法删除钩子。

注意

有关何时执行此钩子以及其执行相对于其他钩子的顺序的更多信息，请参阅 后向钩子执行。

示例

>>> import torch
>>>
>>> a = torch.rand(2, 3, requires_grad=True)
>>> b = torch.rand(2, 3, requires_grad=True)
>>> c = a * b
>>> d = a * b
>>>
>>> def fn(grads):
...     print([g is not None for g in grads])
...
>>> torch.autograd.graph.register_multi_grad_hook((a, b, c, d), fn)
>>>
>>> c.sum().backward(retain_graph=True)
[True, True, True, False]
>>> c.sum().backward(inputs=(a,), retain_graph=True)
[True, False, True, False]
>>>

返回类型

RemovableHandle

class torch.autograd.graph.allow_mutation_on_saved_tensors

允许修改为后向传播保存的张量的上下文管理器。

在此上下文管理器下，为后向传播保存的张量在修改时会被克隆，因此原始版本仍然可以在后向传播期间使用。通常，修改为后向传播保存的张量会在后向传播期间使用时导致引发错误。

为了确保正确的行为，前向传播和后向传播都应在同一上下文管理器下运行。

返回

一个 _AllowMutationOnSavedContext 对象，用于存储此上下文管理器管理的状态。此对象对于调试目的可能很有用。上下文管理器管理的状态在退出时会自动清除。

返回类型

Generator[_AllowMutationOnSavedContext, None, None]

示例

>>> import torch
>>> with torch.autograd.graph.allow_mutation_on_saved_tensors():
...     # forward
...     a = torch.ones(2, 3, requires_grad=True)
...     b = a.clone()
...     out = (b**2).sum()
...     b.sin_()
...     # backward
...     out.sum().backward()
...
tensor([[0.8415, 0.8415, 0.8415],
        [0.8415, 0.8415, 0.8415]], grad_fn=<SinBackward0>)

class torch.autograd.graph.GradientEdge(node, output_nr)

表示 autograd 图中给定梯度边的对象。

要获取将计算给定 Tensor 梯度的梯度边，您可以执行 edge = autograd.graph.get_gradient_edge(tensor)。

torch.autograd.graph.get_gradient_edge(tensor)

获取用于计算给定 Tensor 梯度的梯度边。

特别是，它等效于调用 g = autograd.grad(loss, input) 和 g = autograd.grad(loss, get_gradient_edge(input))。

返回类型

GradientEdge