跳转到主要内容
社区

介绍 depyf：轻松掌握 torch.compile

作者： 2024 年 5 月 11 日2024 年 11 月 21 日暂无评论
depyf logo

我们很高兴地向 PyTorch 生态系统引入新项目 depyf，旨在帮助用户理解、学习和适应 torch.compile！

动机

torch.compile 是 PyTorch 2.x 的基石，只需一行代码即可为训练和推理加速机器学习工作流。仅仅包含 @torch.compile 就可以 显著提升代码性能。然而，找到 torch.compile 的最佳插入点并不容易，更不用说调整各种参数以实现最大效率的复杂性。

torch.compile 堆栈的复杂性，包括 Dynamo、AOTAutograd、Inductor 等，带来了**陡峭的学习曲线**。这些组件对于深度学习性能优化至关重要，但如果缺乏扎实的基础，可能会令人望而生畏。

注意：有关 torch.compile 如何工作的入门示例，请参阅此 逐步讲解。

一个常用工具：TORCH_COMPILE_DEBUG

为了揭开 torch.compile 的神秘面纱，常用的方法是利用 TORCH_COMPILE_DEBUG 环境变量。虽然它提供了更多信息，但解读输出仍然是一项艰巨的任务。

例如，当我们有以下代码时

# test.py
import torch
from torch import _dynamo as torchdynamo
from typing import List

@torch.compile
def toy_example(a, b):
   x = a / (torch.abs(a) + 1)
   if b.sum() < 0:
       b = b * -1
   return x * b

def main():
   for _ in range(100):
       toy_example(torch.randn(10), torch.randn(10))

if __name__ == "__main__":
   main()

并使用 TORCH_COMPILE_DEBUG=1 python test.py 运行它，我们将获得一个名为 torch_compile_debug/run_2024_02_05_23_02_45_552124-pid_9520 的目录，其中包含以下文件

.
├── torchdynamo
│   └── debug.log
└── torchinductor
   ├── aot_model___0_debug.log
   ├── aot_model___10_debug.log
   ├── aot_model___11_debug.log
   ├── model__4_inference_10.1
   │   ├── fx_graph_readable.py
   │   ├── fx_graph_runnable.py
   │   ├── fx_graph_transformed.py
   │   ├── ir_post_fusion.txt
   │   ├── ir_pre_fusion.txt
   │   └── output_code.py
   ├── model__5_inference_11.2
   │   ├── fx_graph_readable.py
   │   ├── fx_graph_runnable.py
   │   ├── fx_graph_transformed.py
   │   ├── ir_post_fusion.txt
   │   ├── ir_pre_fusion.txt
   │   └── output_code.py
   └── model___9.0
       ├── fx_graph_readable.py
       ├── fx_graph_runnable.py
       ├── fx_graph_transformed.py
       ├── ir_post_fusion.txt
       ├── ir_pre_fusion.txt
       └── output_code.py

生成的 文件和日志通常提出的问题比它们解决的问题更多，让开发人员对数据中的含义和关系感到困惑。TORCH_COMPILE_DEBUG 的常见难题包括

  • model__4_inference_10.1 是什么意思？
  • 我有一个函数，但目录中有三个 model__xxx.py，它们之间有什么对应关系？
  • debug.log 中的那些 LOAD_GLOBAL 是什么？

一个更好的工具：depyf 来解救

让我们看看 depyf 如何帮助开发人员解决上述挑战。要使用 depyf，只需执行 pip install depyf 或按照项目页面 https://github.com/thuml/depyf 安装最新版本，然后将主代码包裹在 with depyf.prepare_debug 中。

# test.py
import torch
from torch import _dynamo as torchdynamo
from typing import List

@torch.compile
def toy_example(a, b):
   x = a / (torch.abs(a) + 1)
   if b.sum() < 0:
       b = b * -1
   return x * b

def main():
   for _ in range(100):
       toy_example(torch.randn(10), torch.randn(10))

if __name__ == "__main__":
   import depyf
   with depyf.prepare_debug("depyf_debug_dir"):
       main()

执行 python test.py 后，depyf 将生成一个名为 depyf_debug_dir（prepare_debug 函数的参数）的目录。在该目录下，将有以下文件

.
├── __compiled_fn_0 AFTER POST GRAD 0.py
├── __compiled_fn_0 Captured Graph 0.py
├── __compiled_fn_0 Forward graph 0.py
├── __compiled_fn_0 kernel 0.py
├── __compiled_fn_3 AFTER POST GRAD 0.py
├── __compiled_fn_3 Captured Graph 0.py
├── __compiled_fn_3 Forward graph 0.py
├── __compiled_fn_3 kernel 0.py
├── __compiled_fn_4 AFTER POST GRAD 0.py
├── __compiled_fn_4 Captured Graph 0.py
├── __compiled_fn_4 Forward graph 0.py
├── __compiled_fn_4 kernel 0.py
├── __transformed_code_0_for_torch_dynamo_resume_in_toy_example_at_8.py
├── __transformed_code_0_for_toy_example.py
├── __transformed_code_1_for_torch_dynamo_resume_in_toy_example_at_8.py
└── full_code_for_toy_example_0.py

并且有两个明显的优点

  1. 长而难以理解的 torchdynamo/debug.log 消失了。其内容被清理并显示为人类可读的源代码，在 full_code_for_xxx.py 和 __transformed_code_{n}_for_xxx.py 中。值得注意的是，depyf 最繁琐和困难的工作是将 torchdynamo/debug.log 中的字节码反编译为 Python 源代码，从而将开发人员从 Python 令人望而生畏的内部中解放出来。
  2. 函数名和计算图之间的对应关系得到了尊重。例如，在 __transformed_code_0_for_toy_example.py 中，我们可以看到一个名为 __compiled_fn_0 的函数，我们会立即知道其对应的计算图在 __compiled_fn_0_xxx.py 中，因为它们共享相同的 __compiled_fn_0 前缀名。

从 full_code_for_xxx.py 开始，并遵循所涉及的函数，用户将清楚地了解 torch.compile 对其代码做了什么。

还有一件事：单步调试能力

使用调试器逐行单步执行代码是理解代码工作原理的好方法。然而，在 TORCH_COMPILE_DEBUG 下，这些文件仅供用户参考，不能用用户关心的数据执行。

注意：“调试”指的是检查和改进程序的过程，而不是纠正有错误的代码。

**depyf 的一个突出特点是它能够促进 torch.compile 的单步调试**：它生成的所有文件都与 Python 解释器中的运行时代码对象相关联，我们可以在这些文件中设置断点。用法很简单，只需添加一个上下文管理器 with depyf.debug()，它就能起作用

# test.py
import torch
from torch import _dynamo as torchdynamo
from typing import List

@torch.compile
def toy_example(a, b):
   x = a / (torch.abs(a) + 1)
   if b.sum() < 0:
       b = b * -1
   return x * b

def main():
   for _ in range(100):
       toy_example(torch.randn(10), torch.randn(10))

if __name__ == "__main__":
   import depyf
   with depyf.prepare_debug("depyf_debug_dir"):
       main()
   with depyf.debug():
       main()

只有一个注意事项：调试 torch.compile 的工作流程偏离了标准的调试工作流程。使用 torch.compile，许多代码是**动态**生成的。因此，我们需要

  1. 启动程序
  2. 当程序退出 with depyf.prepare_debug("depyf_debug_dir") 时，代码将在 depyf_debug_dir 中可用。
  3. 当程序进入 with depyf.debug() 时，它将自动在内部设置一个断点，以便程序暂停。
  4. 导航到 depyf_debug_dir 设置断点。
  5. 继续运行代码，调试器将命中这些断点！
depyf screenshot

这是它看起来的屏幕截图。所有代码和张量变量都是实时的，我们可以检查任何变量，并单步执行代码，就像我们日常的调试工作流程一样！唯一的区别是我们正在调试 torch.compile 生成的代码而不是人类编写的代码。

结论

torch.compile 是一个非常有价值的工具，可以轻松加速 PyTorch 代码。对于那些希望深入了解 torch.compile 的人，无论是为了充分发挥其潜力还是集成自定义操作，学习曲线都可能非常陡峭。depyf 旨在降低这个障碍，提供用户友好的体验来理解、学习和适应 torch.compile。

探索 depyf 并亲身体验它的好处吧！该项目是开源的，可在 https://github.com/thuml/depyf 获取。通过 pip install depyf 安装非常简单。我们希望 depyf 能够增强每个人的 torch.compile 开发工作流程。