PyTorch 2.0 故障排除

作者: 迈克尔·拉佐斯

我们正在积极开发调试工具、探查器，并改进我们的错误和警告消息。下面是可用工具及其典型用法的表格。有关更多帮助，请参阅 诊断运行时错误。

标题

工具	目的	用法
信息日志记录	查看编译的汇总步骤	torch._logging.set_logs(dynamo = logging.INFO) 或 TORCH_LOGS="dynamo"
调试日志记录	查看编译的详细步骤（打印跟踪的每条指令）	torch._logging.set_logs(dynamo = logging.DEBUG) 和 torch._dynamo.config.verbose = True，或 TORCH_LOGS="+dynamo" TORCHDYNAMO_VERBOSE=1
任何后端的最小化器	查找任何后端中能够重现错误的最小子图	设置环境变量 TORCHDYNAMO_REPRO_AFTER="dynamo"
针对 TorchInductor 的最小化器	如果已知错误发生在 AOTAutograd 之后，请查找在 TorchInductor 下降期间能够重现错误的最小子图	设置环境变量 TORCHDYNAMO_REPRO_AFTER="aot"
Dynamo 准确性最小化器	查找能够在急切模式模型和优化模型之间重现准确性问题的最小子图，如果您怀疑问题出在 AOTAutograd 中	TORCHDYNAMO_REPRO_AFTER="dynamo" TORCHDYNAMO_REPRO_LEVEL=4
Inductor 准确性最小化器	查找能够在急切模式模型和优化模型之间重现准确性问题的最小子图，如果您怀疑问题出在后端（例如，inductor）中。如果这不起作用，请尝试使用 Dynamo 准确性最小化器。	TORCHDYNAMO_REPRO_AFTER="aot" TORCHDYNAMO_REPRO_LEVEL=4
torch._dynamo.explain	查找图断点并显示其推理结果	torch._dynamo.explain(fn)(*inputs)
录制/重放	录制和重放框架，以在图捕获期间重现错误	torch._dynamo.config.replay_record_enabled = True
TorchDynamo 函数名过滤	仅编译具有给定名称的函数，以减少调试问题时的噪音	设置环境变量 TORCHDYNAMO_DEBUG_FUNCTION=<name>
TorchInductor 调试日志记录	打印一般的 TorchInductor 调试信息以及生成的 Triton/C++ 代码	torch._inductor.config.debug = True
TorchInductor 跟踪	显示每个 TorchInductor 阶段所花费的时间 + 输出代码和图可视化	设置环境变量 TORCH_COMPILE_DEBUG=1 或 torch._inductor.config.trace.enabled = True

除了信息和调试日志记录之外，您还可以使用 torch._logging 进行更细粒度的日志记录。

诊断运行时错误

从高层次上讲，TorchDynamo 堆栈由来自 Python 代码（TorchDynamo）的图捕获和后端编译器组成。例如，后端编译器可能包括反向图跟踪（AOTAutograd）和图下降（TorchInductor）*。错误可能发生在堆栈的任何组件中，并将提供完整的堆栈跟踪。

要确定错误发生在哪个组件中，您可以使用信息级日志记录 torch._logging.set_logs(dynamo = logging.INFO) 或 TORCH_LOGS="dynamo" 并查找 Step #: ... 输出。日志是在每个步骤的开始和结束时创建的，因此错误应对应的步骤是最近记录的步骤，该步骤的结束尚未记录。这些步骤对应于堆栈的以下部分

步骤	组件
1	TorchDynamo
2	编译器后端
3	TorchInductor

如果信息日志记录不足，您可以使用可用的后端选项。这些选项包括

• "eager": 只运行 TorchDynamo 正向图捕获，然后使用 PyTorch 运行捕获的图。这可以指示 TorchDynamo 是否引发了错误。

• "aot_eager": 运行 TorchDynamo 捕获正向图，然后运行 AOTAutograd 追踪反向图，不进行任何额外的后端编译步骤。然后使用 PyTorch eager 运行正向和反向图。这有助于将问题缩小到 AOTAutograd。

缩小问题的一般步骤如下：

1. 使用 "eager" 后端运行您的程序。如果错误不再发生，则问题出在正在使用的后端编译器中（如果使用 TorchInductor，请继续执行步骤 2。否则，请参阅 此部分）。如果错误在 "eager" 后端仍然发生，则这是一个 运行 torchdynamo 时的错误。

2. 此步骤仅在使用 TorchInductor 作为后端编译器时才需要。使用 "aot_eager" 后端运行模型。如果此后端引发错误，则错误发生在 AOTAutograd 追踪期间。如果错误在此后端不再发生，则 错误出在 TorchInductor* 中。

以下各节将分析每种情况。

注意

TorchInductor 后端包括 AOTAutograd 追踪和 TorchInductor 编译器本身。我们将通过将 TorchInductor 称为后端，并将 TorchInductor 降级称为将 AOTAutograd 追踪的图降级的阶段来进行区分。

Torchdynamo 错误

如果生成的错误在 "eager" 后端出现，则 TorchDynamo 很可能是错误的根源。以下是一段会导致错误的示例代码。

import torch

import torch._dynamo as dynamo


def test_assertion_error():
    y = torch.ones(200, 200)
    z = {y: 5}
    return z

compiled_test_assertion_error = torch.compile(test_assertion_error, backend="eager")

compiled_test_assertion_error()

上面的代码会生成以下错误

torch._dynamo.convert_frame: [ERROR] WON'T CONVERT test_assertion_error /scratch/mlazos/torchdynamo/../test/errors.py line 26
due to:
Traceback (most recent call last):
  File "/scratch/mlazos/torchdynamo/torchdynamo/symbolic_convert.py", line 837, in BUILD_MAP
    assert isinstance(k, ConstantVariable) or (
AssertionError

from user code:
   File "/scratch/mlazos/torchdynamo/../test/errors.py", line 34, in test_assertion_error
    z = {y: 5}

Set torch._dynamo.config.verbose=True for more information
==========

如消息所示，您可以设置 torch._dynamo.config.verbose=True 以获得 TorchDynamo 和用户代码的完整堆栈跟踪。除了此标志之外，您还可以通过 torch._logging.set_logs(dynamo = logging.INFO) 或 TORCH_LOGS="dynamo" 设置 TorchDynamo 的 log_level。这些级别包括

• logging.DEBUG 或 TORCH_LOGS="+dynamo": 打印遇到的每个指令，以及下面列出的所有日志级别。

• logging.INFO: 打印每个编译的函数（原始和修改后的字节码）以及捕获的图，以及下面列出的所有日志级别。

• logging.WARNING（默认）：打印图中断，以及下面列出的所有日志级别。

• logging.ERROR: 仅打印错误。

如果模型非常大，日志可能会变得很庞大。如果错误发生在模型 Python 代码的深处，执行发生错误的帧可能会有所帮助，以便更容易地调试。有两个工具可以实现这一点

• 将环境变量 TORCHDYNAMO_DEBUG_FUNCTION 设置为所需的函数名称，将仅对具有该名称的函数运行 torchdynamo。

• 启用记录/回放工具（设置 torch._dynamo.config.replay_record_enabled = True），该工具会在遇到错误时转储执行记录。然后可以回放此记录以仅运行发生错误的帧。

诊断 TorchInductor 错误

如果错误在 "eager" 后端没有发生，则后端编译器是错误的根源 (示例错误)。TorchDynamo 的后端编译器有 多种选择，其中 TorchInductor 适合大多数用户的需求。本节以 TorchInductor 为主要示例，但某些工具也可以用于其他后端编译器。

以下是我们关注的堆栈部分

如果选择 TorchInductor 作为后端，AOTAutograd 用于从 torchdynamo 捕获的正向图生成反向图。需要注意的是，错误可能发生在此追踪期间，也可能发生在 TorchInductor 将正向和反向图降级为 GPU 代码或 C++ 的过程中。一个模型通常可能包含数百或数千个 FX 节点，因此缩小导致此问题的节点可能非常困难。幸运的是，有一些工具可以自动将这些输入图缩小到导致问题的节点。第一步是确定错误发生在使用 AOTAutograd 追踪反向图期间还是在 TorchInductor 降级期间。如上面步骤 2 中所述，可以使用 "aot_eager" 后端来单独运行 AOTAutograd，而不进行降级。如果错误在此后端仍然发生，则表明错误发生在 AOTAutograd 追踪期间。

以下是一个示例

import torch

import torch._dynamo as dynamo

model = torch.nn.Sequential(*[torch.nn.Linear(200, 200) for _ in range(5)])

def test_backend_error():

    y = torch.ones(200, 200)
    x = torch.ones(200, 200)
    z = x + y
    a = torch.ops.aten._foobar(z)  # dummy function which errors
    return model(a)


compiled_test_backend_error = torch.compile(test_backend_error, backend="inductor")
compiled_test_backend_error()

运行此代码应该会得到此错误，以及下面的更长的堆栈跟踪

Traceback (most recent call last):
  File "/scratch/mlazos/torchdynamo/torchinductor/graph.py", line 246, in call_function
    return lowerings[target](*args, **kwargs)
  File "/scratch/mlazos/torchdynamo/torchinductor/lowering.py", line 185, in wrapped
    return decomp_fn(*args, **kwargs)
  File "/scratch/mlazos/torchdynamo/torchinductor/lowering.py", line 810, in _foobar
    assert False
AssertionError
...

错误以及完整堆栈跟踪

如果您将 torch.compile(backend="inductor") 更改为 torch.compile(backend="aot_eager")，它将运行而不会出错，因为 问题 出在 TorchInductor 降级过程中，而不是 AOTAutograd 中。

缩小 TorchInductor 错误

从这里开始，让我们运行缩小器以获得最小的重现程序。设置环境变量 TORCHDYNAMO_REPRO_AFTER="aot"（或直接设置 torch._dynamo.config.repro_after="aot"）将生成一个 Python 程序，该程序将 AOTAutograd 生成的图缩小到能够重现错误的最小子图。（请参阅下面缩小 TorchDynamo 生成的图的示例）使用此环境变量运行程序应该会显示几乎 相同的输出，以及一行指示 minifier_launcher.py 写入的位置。输出目录可以通过将 torch._dynamo.config.base_dir 设置为有效的目录名称进行配置。最后一步是运行缩小器并检查它是否成功运行。成功的运行类似于 此示例。如果缩小器成功运行，它会生成可运行的 python 代码，这些代码可以重现确切的错误。对于我们的示例，这是以下代码

import torch
from torch import tensor, device
import torch.fx as fx
from torch._dynamo.testing import rand_strided
from math import inf
from torch.fx.experimental.proxy_tensor import make_fx

# torch version: 1.13.0a0+gitfddfc44
# torch cuda version: 11.6
# torch git version: fddfc4488afb207971c54ad4bf58130fdc8a4dc5


# CUDA Info:
# nvcc: NVIDIA (R) Cuda compiler driver
# Copyright (c) 2005-2022 NVIDIA Corporation
# Built on Thu_Feb_10_18:23:41_PST_2022
# Cuda compilation tools, release 11.6, V11.6.112
# Build cuda_11.6.r11.6/compiler.30978841_0

# GPU Hardware Info:
# NVIDIA A100-SXM4-40GB : 8

from torch.nn import *

class Repro(torch.nn.Module):
    def __init__(self):
        super().__init__()

    def forward(self, add):
        _foobar = torch.ops.aten._foobar.default(add);  add = None
        return (_foobar,)

args = [((200, 200), (200, 1), torch.float32, 'cpu')]
args = [rand_strided(shape, stride, dtype, device) for shape, stride, dtype, device in args]
mod = make_fx(Repro())(*args)
from torch._inductor.compile_fx import compile_fx_inner

compiled = compile_fx_inner(mod, args)
compiled(*args)

的 forward 方法包含导致问题的操作。在提交问题时，请包含任何缩小的重现程序以帮助调试。

缩小后端编译器错误

对于除 TorchInductor 之外的后端编译器，查找导致错误的子图的过程与 TorchInductor 中的错误 中的过程几乎相同，但有一个重要的区别。即，缩小器现在将在 TorchDynamo 追踪的图上运行，而不是 AOTAutograd 的输出图上。让我们通过一个例子来演示。

import torch

import torch._dynamo as dynamo

model = torch.nn.Sequential(*[torch.nn.Linear(200, 200) for _ in range(5)])
# toy compiler which fails if graph contains relu
def toy_compiler(gm: torch.fx.GraphModule, _):
    for node in gm.graph.nodes:
        if node.target == torch.relu:
            assert False

    return gm


def test_backend_error():
    y = torch.ones(200, 200)
    x = torch.ones(200, 200)
    z = x + y
    a = torch.relu(z)
    return model(a)


compiled_test_backend_error = torch.compile(test_backend_error, backend=toy_compiler)
compiled_test_backend_error()

为了在 TorchDynamo 追踪正向图后运行代码，您可以使用环境变量 TORCHDYNAMO_REPRO_AFTER。使用 TORCHDYNAMO_REPRO_AFTER="dynamo"（或 torch._dynamo.config.repro_after="dynamo"）运行此程序应该会生成 此输出，以及 {torch._dynamo.config.base_dir}/repro.py 中的以下代码。

注意

TORCHDYNAMO_REPRO_AFTER 的另一个选项是 "aot"，它将在反向图生成后运行缩小器。

import torch
import torch._dynamo as dynamo
from torch import tensor, device
import torch.fx as fx
from torch._dynamo.testing import rand_strided
from math import inf
from torch._dynamo.debug_utils import run_fwd_maybe_bwd

from torch.nn import *

class Repro(torch.nn.Module):
    def __init__(self):
        super().__init__()

    def forward(self, add):
        relu = torch.relu(add);  add = None
        return (relu,)


mod = Repro().cuda()
opt_mod = torch.compile(mod, backend="None")


args = [((200, 200), (200, 1), torch.float32, 'cpu', False)]
args = [rand_strided(sh, st, dt, dev).requires_grad_(rg) for (sh, st, dt, dev, rg) in args]


with torch.cuda.amp.autocast(enabled=False):
    ref = run_fwd_maybe_bwd(mod, args)
    res = run_fwd_maybe_bwd(opt_mod, args)

缩小器成功地将图缩小到 toy_compiler 中引发错误的操作。与 TorchInductor 错误 中的过程相比，另一个区别是缩小器在遇到后端编译器错误后会自动运行。成功运行后，缩小器会将 repro.py 写入 torch._dynamo.config.base_dir。

性能分析

访问 TorchDynamo 分析器

TorchDynamo 具有一个内置的 stats 函数，用于收集和显示每个编译阶段所花费的时间。这些统计信息可以通过在执行 Torch._Dynamo 后调用 torch._dynamo.utils.compile_times() 来访问。默认情况下，这将返回每个 TorchDynamo 函数按名称的编译时间字符串表示形式。

使用 TORCH_COMPILE_DEBUG 调试 TorchInductor

TorchInductor 具有一个内置的 stats 和 trace 函数，用于显示每个编译阶段所花费的时间、输出代码、输出图可视化和 IR 转储。这是一个调试工具，旨在简化 TorchInductor 内部机制的理解和故障排除。

让我们使用以下测试程序 (repro.py) 运行一个示例

import torch

@torch.compile()
def test_model(x):
    model = torch.nn.Sequential(
        torch.nn.Linear(10, 10),
        torch.nn.LayerNorm(10),
        torch.nn.ReLU(),
    )
    return model(x)


y = test_model(torch.ones(10, 10))

设置环境变量 TORCH_COMPILE_DEBUG=1 将导致创建一个调试跟踪目录，默认情况下，此目录将在当前目录中，名为 torch_compile_debug（这可以在 torchdynamo 配置字段 debug_dir_root 以及 env var TORCH_COMPILE_DEBUG_DIR 中覆盖）。在此目录中，每次运行都将拥有一个单独的文件夹，文件夹的名称为运行的时间戳和进程 ID

$ env TORCH_COMPILE_DEBUG=1 python repro.py
$ cd torch_compile_debug
$ ls
run_2023_03_01_08_20_52_143510-pid_180167

在运行文件夹中，将有一个 torchdynamo 目录，其中包含调试日志，以及一个 torchinductor 文件夹，其中包含每个已编译内核的子文件夹，以及 inductor 调试工件。

$ cd
run_2023_03_01_08_20_52_143510-pid_180167
$ ls
torchinductor  torchdynamo

进一步进入 torchinductor 目录，\*.log 文件是编译过程中的 AOT Autograd 阶段的日志，model__0_forward_1.0 包含 inductor 调试信息。

$ cd torchinductor
$ ls
aot_model___0_debug.log  model__0_forward_1.0
$ cd model__0_forward_1.0
$ ls
debug.log  fx_graph_readable.py  fx_graph_runnable.py  fx_graph_transformed.py  ir_post_fusion.txt  ir_pre_fusion.txt  output_code.py

以下是内容摘要

• fx_graph_readable.py 和 fx_graph_runnable.py 是 inductor 收到的 fx_graph 的可读和可运行版本。

• fx_graph_transformed.py 是 inductor 运行完所有 fx pass 后的 fx 图。

• ir\*.txt 是 inductor 在融合之前和之后的中介表示。

• output_code.py 是为子图编译的 triton 内核。

以下是测试程序的 示例调试目录内容

import torch

@torch.compile()
def test_model(x):
    model = torch.nn.Sequential(
        torch.nn.Linear(10, 10),
        torch.nn.LayerNorm(10),
        torch.nn.ReLU(),
    )
    return model(x)


y = test_model(torch.ones(10, 10))

调试跟踪中的每个文件都可以通过 torch._inductor.config.trace.* 来启用和禁用。配置文件和图表默认情况下都已禁用，因为它们的生成成本很高。

这种新调试格式中的单个节点看起来像

buf1: SchedulerNode(ComputedBuffer)
buf1.writes =
    {   MemoryDep(name='buf1', index=0, size=()),
        MemoryDep(name='buf1', index=0, size=(s0,))}
buf1.unmet_dependencies = {MemoryDep(name='buf0', index=c0, size=(s0,))}
buf1.met_dependencies = {MemoryDep(name='primals_2', index=c0, size=(s0,))}
buf1.group.device = cuda:0
buf1.group.iteration = (1, s0)
buf1.sizes = ([], [s0])
class buf1_loop_body:
    var_ranges = {z0: s0}
    index0 = z0
    index1 = 0
    def body(self, ops):
        get_index = self.get_index('index0')
        load = ops.load('buf0', get_index, False)
        get_index_1 = self.get_index('index0')
        load_1 = ops.load('primals_2', get_index_1, False)
        add = ops.add(load, load_1)
        get_index_2 = self.get_index('index1')
        reduction = ops.reduction('buf1', torch.float32, torch.float32, 'sum', get_index_2, add)
        return reduction

查看 示例调试目录输出 以获取更多示例。

图中断

给定这样的程序

def some_fun(x):
    ...

compiled_fun = torch.compile(some_fun, ...)
...

TorchDynamo 将尝试将 some_fun 中的所有 torch/tensor 操作编译成单个 FX 图，但它可能无法将所有内容都捕获到一个图中。

一些图中断原因对 TorchDynamo 来说是无法克服的，而且不能轻易修复。 - 调用非 torch 的 C 扩展对 torchdynamo 是不可见的，并且可以执行任意操作而无需 TorchDynamo 引入必要的保护措施（参见 让 Dynamo 安全：保护措施）来确保编译后的程序可以安全地重用。如果产生的片段很小，图中断会阻碍性能。为了最大限度地提高性能，重要的是要尽可能减少图中断。

识别图中断的原因

要识别程序中的所有图中断以及中断的相关原因，可以使用 torch._dynamo.explain。此工具在提供的函数上运行 TorchDynamo 并汇总遇到的图中断。以下是示例用法

import torch
import torch._dynamo as dynamo
def toy_example(a, b):
    x = a / (torch.abs(a) + 1)
    print("woo")
    if b.sum() < 0:
        b = b * -1
    return x * b
explanation = dynamo.explain(toy_example)(torch.randn(10), torch.randn(10))
print(explanation_verbose)
"""
Graph Count: 3
Graph Break Count: 2
Op Count: 5
Break Reasons:
  Break Reason 1:
    Reason: builtin: print [<class 'torch._dynamo.variables.constant.ConstantVariable'>] False
    User Stack:
      <FrameSummary file foo.py, line 5 in toy_example>
  Break Reason 2:
    Reason: generic_jump TensorVariable()
    User Stack:
      <FrameSummary file foo.py, line 6 in torch_dynamo_resume_in_toy_example_at_5>
Ops per Graph:
  ...
Out Guards:
  ...
"""

输出包括

• out_guards - 一个列表，其中每个子列表包含必须通过的保护措施，以确保跟踪的图有效。

• graphs - 成功跟踪的图模块列表。

• ops_per_graph - 一个列表，其中每个子列表包含在图中运行的操作。

要在遇到第一个图中断时抛出错误，请使用 fullgraph 模式。此模式禁用 TorchDynamo 的 Python 回退，并且只有在整个程序都可以转换为单个图时才成功。示例用法

def toy_example(a, b):
   ...

compiled_toy = torch.compile(toy_example, fullgraph=True, backend=<compiler>)(a, b)

过度重新编译

当 TorchDynamo 编译一个函数（或其一部分）时，它会对局部变量和全局变量做出一些假设，以便进行编译器优化，并将这些假设表示为在运行时检查特定值的保护措施。如果这些保护措施中的任何一个失败，Dynamo 将最多重新编译该函数（或部分）torch._dynamo.config.cache_size_limit 次。如果你的程序达到了缓存限制，首先需要确定哪个保护措施失败了，以及程序的哪一部分触发了它。

编译配置文件 自动执行将 TorchDynamo 的缓存限制设置为 1 并在仅观察的“编译器”下运行你的程序的过程，该编译器记录任何保护措施失败的原因。你应该确保你的程序至少运行与你遇到问题时一样长（迭代次数），配置文件将在此期间积累统计数据。

如果你的程序表现出有限量的动态性，你也许能够调整 TorchDynamo 缓存限制，以允许每个变体进行编译和缓存，但如果缓存限制过高，你可能会发现重新编译的成本超过了任何优化带来的益处。

torch._dynamo.config.cache_size_limit = <your desired cache limit>

TorchDynamo 计划支持许多常见的动态张量形状，例如变化的批次大小或序列长度。它不打算支持秩动态。在此期间，可以将特定缓存限制与桶化技术结合使用，以实现某些动态模型的可接受的重新编译次数。

from torch._dynamo.utils import CompileProfiler

def my_model():
    ...

with CompileProfiler() as prof:
    profiler_model = torch.compile(my_model, backend=prof)
    profiler_model()
    print(prof.report())

准确性调试

如果你设置了环境变量 TORCHDYNAMO_REPRO_LEVEL=4，也可以最小化准确性问题，它使用类似于 git bisect 的模型运行，完整的重现可能类似于 TORCHDYNAMO_REPRO_AFTER="aot" TORCHDYNAMO_REPRO_LEVEL=4，我们需要这样做是因为下游编译器将生成代码，无论是 Triton 代码还是 C++ 后端，来自这些下游编译器的数值可能在细微方面有所不同，但会对你的训练稳定性产生重大影响。因此，准确性调试对于我们检测代码生成或后端编译器的错误非常有用。

如果你想确保随机数生成在 torch 和 triton 中相同，那么你可以启用 torch._inductor.config.fallback_random = True

扩展调试

可以使用以下实验性标志启用扩展调试。

TORCHDYNAMO_EXTENDED_DEBUG_GUARD_ADDED - 如果保护措施的字符串表示形式与该标志值匹配，则提供扩展调试信息。例如，将其设置为“Ne(s0, 10)”以在发出保护措施时生成完整的 Python 和 C++ 回溯。 TORCHDYNAMO_EXTENDED_DEBUG_CREATE_SYMBOL - 在分配特定符号时提供扩展调试信息。例如，将其设置为“u2”以在创建此符号时生成完整的 Python 和 C++ 回溯。 TORCHDYNAMO_EXTENDED_DEBUG_CPP - 为所有扩展调试设置以及错误提供扩展调试信息（C++ 回溯）。例如，将其设置为“1”。C++ 回溯速度很慢而且非常繁琐，因此默认情况下不会在扩展调试中包含它。

冷启动计时和缓存损坏调试

为了测量冷启动编译时间或调试缓存损坏，可以传递 TORCHINDUCTOR_FORCE_DISABLE_CACHES=1 或设置 torch._inductor.config.force_disable_caches = True，这将覆盖任何其他缓存配置选项并禁用所有编译时缓存。