自动微分包 - torch.autograd

torch.autograd 提供了实现任意标量值函数自动微分的类和函数。它对现有代码的要求更改最少 - 您只需要使用 requires_grad=True 关键字声明需要计算梯度的 Tensor。目前，我们仅支持浮点 Tensor 类型（half、float、double 和 bfloat16）和复数 Tensor 类型（cfloat、cdouble）的自动微分。

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

前向模式自动微分

警告

此 API 处于测试阶段。尽管函数签名不太可能发生变化，但在我们认为其稳定之前，计划改进运算符覆盖范围。

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

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

函数式高级 API

警告

此 API 处于测试阶段。尽管函数签名不太可能发生变化，但在我们认为其稳定之前，计划对其性能进行重大改进。

本节包含自动微分的高级 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 的内存是非重叠且密集的，则 .grad 将使用与 param 匹配的步幅创建（因此与 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。情况 3 保证只要 create_graph=False，你的布局就会被保留。情况 4 表明即使 create_graph=True，你的布局也*可能*会被保留。

张量的原地操作

在自动求导中支持原地操作是一个难题，我们不建议在大多数情况下使用它们。自动求导积极的缓冲区释放和重用使其非常高效，并且在极少数情况下，原地操作实际上会显著降低内存使用量。除非你是在很大的内存压力下运行，否则你可能永远不需要使用它们。

原地正确性检查

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

变量（已弃用）

警告

变量 API 已被弃用：不再需要使用变量来对张量进行自动求导。自动求导自动支持 requires_grad 设置为 True 的张量。以下是对已更改内容的快速指南

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

• 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, ...])	计算当前张量相对于图叶子的梯度。
torch.Tensor.detach	返回一个新的张量，与当前图分离。
torch.Tensor.detach_	将张量与其创建图分离，使其成为叶节点。
torch.Tensor.register_hook(hook)	注册一个反向钩子。
torch.Tensor.register_post_accumulate_grad_hook(hook)	注册一个在梯度累积后运行的反向钩子。
torch.Tensor.retain_grad()	使此张量能够在 backward() 期间填充其 grad。

函数

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	定义自定义自动求导函数的前向传播。
Function.backward	使用反向模式自动微分定义用于微分操作的公式。
Function.jvp	使用正向模式自动微分定义用于微分操作的公式。
Function.vmap	在 torch.vmap() 下定义此 autograd.Function 的行为。

上下文方法混合

创建新的 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	此类用于内部自动求导工作。
function.InplaceFunction	此类仅出于向后兼容性原因而存在。
function.NestedIOFunction	此类仅出于向后兼容性原因而存在。

数值梯度检查

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

分析器

Autograd 包含一个分析器，可用于检查模型中不同运算符的成本 - 包括 CPU 和 GPU。目前实现了三种模式 - 仅使用 profile 的 CPU 模式。基于 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, use_mtia=False, experimental_config=None)

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

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

参数

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

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

• use_device (str, 可选) – 启用设备事件的时间。使用 cuda 时，每个张量操作大约会增加 4 微秒的开销。有效的设备选项是“cuda”、“xpu”和“privateuseone”。

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

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

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

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

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

• use_kineto (bool, 可选) – 实验性的，使用 Kineto 分析器启用分析。

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

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

示例

>>> 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 tracing tools 文件。
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, 可选) – 设置 enabled=False 会使此上下文管理器成为无操作。默认值：True。

• record_shapes (bool, 可选) – 如果 record_shapes=True，则包装每个 autograd 操作的 nvtx 范围将追加有关该操作接收到的张量参数大小的信息，格式如下：[[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)

前向-反向关联

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

在前向传递期间，每个函数范围都用 seq=<N> 装饰。每当创建一个新的后向函数对象并将其存储起来用于反向传播时，运行计数器 seq 就会递增。因此，与每个前向函数范围相关联的 seq=<N> 注释告诉你，如果此前向函数创建了一个后向函数对象，则该后向对象将收到序列号 N。在反向传递期间，包装每个 C++ 后向函数的 apply() 调用的顶级范围用 stashed seq=<M> 装饰。M 是创建后向对象时的序列号。通过比较反向传播中的 stashed seq 号与前向传递中的 seq 号，你可以追踪哪个前向操作创建了每个后向函数。

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

双重重播

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

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

上下文管理器，使每个自动求导操作都发出一个 ITT 范围。

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

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

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

参数

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

• record_shapes (bool, 可选) – 如果 record_shapes=True，则包装每个自动求导操作的 itt 范围将附加有关该操作接收到的张量参数大小的信息，格式如下：[[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 跟踪文件并解析自动求导注释。

调试和异常检测

类 torch.autograd.detect_anomaly(check_nan=True)

上下文管理器，为自动求导引擎启用异常检测。

这会做两件事

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

• 如果 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

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

上下文管理器，用于打开或关闭自动求导引擎的异常检测。

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

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

参数

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

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

grad_mode.set_multithreading_enabled

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

自动求导图

自动求导公开了允许人们在反向传递期间检查图并在行为之间进行调解的方法。

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

graph.Node.name	返回名称。
graph.Node.metadata	返回元数据。
graph.Node.next_functions
graph.Node.register_hook	注册一个向后钩子。
graph.Node.register_prehook	注册一个向后预钩子。
graph.increment_version	更新自动求导元数据，跟踪给定的张量是否被原地修改。

一些操作需要在正向传递期间保存中间结果，以便执行反向传递。这些中间结果作为 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 但不适合训练，则这尤其有用。另请参阅已保存张量的钩子。

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

示例

>>> 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]
>>>

class torch.autograd.graph.allow_mutation_on_saved_tensors

在此上下文管理器下，允许对为反向传递保存的张量进行修改。

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

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

返回值

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

示例

>>> 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)

表示自动梯度计算图中给定梯度边的对象。要获取将计算给定张量梯度的梯度边，您可以执行 edge = autograd.graph.get_gradient_edge(tensor)。

torch.autograd.graph.get_gradient_edge(tensor)

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

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