调试与性能分析
使用 breakpoint 和 debug_print 检查张量,使用 cProfile 和 line_profiler 分析性能瓶颈,检测常见 AI Bug,配置 TensorBoard
调试与性能分析
最糟糕的 AI Bug 不会崩溃。它们在垃圾数据上默默训练,然后报告一条漂亮的 loss 曲线。
类型: 构建 语言: Python 前置条件: 第 1 课(开发环境),基本 PyTorch 熟悉度 预计时间: ~60 分钟
学习目标
- 使用条件
breakpoint()和debug_print在训练过程中检查张量形状、dtype 和 NaN 值 - 使用
cProfile、line_profiler和tracemalloc分析训练循环的性能瓶颈 - 检测常见 AI Bug:形状不匹配、NaN loss、数据泄漏和设备错误的张量
- 配置 TensorBoard 可视化 loss 曲线、权重直方图和梯度分布
问题所在
AI 代码的失败方式与普通代码不同。Web 应用会崩溃并给出堆栈追踪。一个配置错误的训练循环运行 8 小时,烧掉 $200 的 GPU 时间,产出一个预测每个输入均值的模型。代码从未报错。Bug 是一个在错误设备上的张量、一个被遗忘的 .detach(),或者标签泄漏到了特征中。
你需要能在这些静默失败浪费你的时间和算力之前捕获它们的调试工具。
核心概念
AI 调试在三个层次上操作:
大多数人直接跳到第 3 层(盯着 TensorBoard)。但 80% 的 AI Bug 在第 1 和第 2 层。
动手构建
第 1 部分:打印调试(是的,它有效)
打印调试常被轻视。不应该如此。对于张量代码,一个有针对性的 print 语句比逐步调试器更好,因为你需要同时看到形状、dtype 和值范围。
def debug_print(name, tensor):
print(f"{name}: shape={tensor.shape}, dtype={tensor.dtype}, "
f"device={tensor.device}, "
f"min={tensor.min().item():.4f}, max={tensor.max().item():.4f}, "
f"mean={tensor.mean().item():.4f}, "
f"has_nan={tensor.isnan().any().item()}")
在每个可疑操作后调用它。找到 Bug 后,删除打印。简单。
第 2 部分:Python 调试器(pdb 和 breakpoint)
内置调试器在 AI 工作中被低估了。在训练循环中插入 breakpoint(),交互式检查张量。
def training_step(model, batch, criterion, optimizer):
inputs, labels = batch
outputs = model(inputs)
loss = criterion(outputs, labels)
if loss.item() > 100 or torch.isnan(loss):
breakpoint()
loss.backward()
optimizer.step()
当调试器进入时,有用的命令:
p outputs.shape检查形状p loss.item()查看 loss 值p torch.isnan(outputs).sum()计算 NaN 数量p model.fc1.weight.grad检查梯度c继续,q退出
这是条件调试。你只在看起来有问题时才停下来。对于 10,000 步的训练运行,这很重要。
第 3 部分:Python 日志
当你的调试超出快速检查的范围时,用日志替代 print 语句。
import logging
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s [%(levelname)s] %(message)s",
handlers=[
logging.FileHandler("training.log"),
logging.StreamHandler()
]
)
logger = logging.getLogger(__name__)
logger.info("Starting training: lr=%.4f, batch_size=%d", lr, batch_size)
logger.warning("Loss spike detected: %.4f at step %d", loss.item(), step)
logger.error("NaN loss at step %d, stopping", step)
日志给你时间戳、严重级别和文件输出。当训练在凌晨 3 点失败时,你需要的是日志文件,而不是滚出屏幕的终端输出。
第 4 部分:代码段计时
知道时间花在哪里是优化的第一步。
import time
class Timer:
def __init__(self, name=""):
self.name = name
def __enter__(self):
self.start = time.perf_counter()
return self
def __exit__(self, *args):
elapsed = time.perf_counter() - self.start
print(f"[{self.name}] {elapsed:.4f}s")
with Timer("data loading"):
batch = next(dataloader_iter)
with Timer("forward pass"):
outputs = model(batch)
with Timer("backward pass"):
loss.backward()
常见发现:数据加载占训练时间的 60%。修复方法是在 DataLoader 中设置 num_workers > 0,而不是更快的 GPU。
第 5 部分:cProfile 和 line_profiler
当你需要比手动计时器更多的信息时:
python -m cProfile -s cumtime train.py
这显示每个函数调用按累计时间排序。逐行性能分析:
pip install line_profiler
@profile
def train_step(model, data, target):
output = model(data)
loss = F.cross_entropy(output, target)
loss.backward()
return loss
# 运行:kernprof -l -v train.py
第 6 部分:内存分析
使用 tracemalloc 分析 CPU 内存
import tracemalloc
tracemalloc.start()
# 你的代码
model = build_model()
data = load_dataset()
snapshot = tracemalloc.take_snapshot()
top_stats = snapshot.statistics("lineno")
for stat in top_stats[:10]:
print(stat)
使用 memory_profiler 分析 CPU 内存
pip install memory_profiler
from memory_profiler import profile
@profile
def load_data():
raw = read_csv("data.csv") # 观察内存在这里跳升
processed = preprocess(raw) # 还有这里
return processed
用 python -m memory_profiler your_script.py 运行,查看逐行内存使用。
使用 PyTorch 分析 GPU 内存
import torch
if torch.cuda.is_available():
print(torch.cuda.memory_summary())
print(f"Allocated: {torch.cuda.memory_allocated() / 1e9:.2f} GB")
print(f"Cached: {torch.cuda.memory_reserved() / 1e9:.2f} GB")
遇到 OOM(内存不足)时:
- 减小 batch size(首先尝试,始终如此)
- 使用
torch.cuda.empty_cache()释放缓存内存 - 对大型中间变量使用
del tensor后跟torch.cuda.empty_cache() - 使用混合精度(
torch.cuda.amp)将内存使用减半 - 对非常深的模型使用梯度检查点
第 7 部分:常见 AI Bug 及捕获方法
形状不匹配
最常见的 Bug。张量形状是 [batch, features],但模型期望 [batch, channels, height, width]。
def check_shapes(model, sample_input):
print(f"Input: {sample_input.shape}")
hooks = []
def make_hook(name):
def hook(module, inp, out):
in_shape = inp[0].shape if isinstance(inp, tuple) else inp.shape
out_shape = out.shape if hasattr(out, "shape") else type(out)
print(f" {name}: {in_shape} -> {out_shape}")
return hook
for name, module in model.named_modules():
hooks.append(module.register_forward_hook(make_hook(name)))
with torch.no_grad():
model(sample_input)
for h in hooks:
h.remove()
用一个样本 batch 运行一次。它映射模型中的每个形状变换。
NaN Loss
NaN loss 意味着有东西爆炸了。常见原因:
- 学习率太高
- 自定义 loss 中的除零
- 对零或负数取对数
- RNN 中的梯度爆炸
def detect_nan(model, loss, step):
if torch.isnan(loss):
print(f"NaN loss at step {step}")
for name, param in model.named_parameters():
if param.grad is not None:
if torch.isnan(param.grad).any():
print(f" NaN gradient in {name}")
if torch.isinf(param.grad).any():
print(f" Inf gradient in {name}")
return True
return False
数据泄漏
你的模型在测试集上得到 99% 的准确率。听起来很棒。这是一个 Bug。
def check_data_leakage(train_set, test_set, id_column="id"):
train_ids = set(train_set[id_column].tolist())
test_ids = set(test_set[id_column].tolist())
overlap = train_ids & test_ids
if overlap:
print(f"DATA LEAKAGE: {len(overlap)} samples in both train and test")
return True
return False
还要检查时间泄漏:使用未来数据预测过去。分割前按时间戳排序。
设备错误
不同设备(CPU vs GPU)上的张量会导致运行时错误。但有时一个张量悄悄地留在 CPU 上,而其他一切都在 GPU 上,训练只是运行得很慢。
def check_devices(model, *tensors):
model_device = next(model.parameters()).device
print(f"Model device: {model_device}")
for i, t in enumerate(tensors):
if t.device != model_device:
print(f" WARNING: tensor {i} on {t.device}, model on {model_device}")
第 8 部分:TensorBoard 基础
TensorBoard 展示训练过程中发生了什么。
pip install tensorboard
from torch.utils.tensorboard import SummaryWriter
writer = SummaryWriter("runs/experiment_1")
for step in range(num_steps):
loss = train_step(model, batch)
writer.add_scalar("loss/train", loss.item(), step)
writer.add_scalar("lr", optimizer.param_groups[0]["lr"], step)
if step % 100 == 0:
for name, param in model.named_parameters():
writer.add_histogram(f"weights/{name}", param, step)
if param.grad is not None:
writer.add_histogram(f"grads/{name}", param.grad, step)
writer.close()
启动:
tensorboard --logdir=runs
需要关注的:
- Loss 不下降:学习率太低,或模型架构问题
- Loss 剧烈震荡:学习率太高
- Loss 变成 NaN:数值不稳定(见上方 NaN 部分)
- 训练 loss 下降,验证 loss 上升:过拟合
- 权重直方图收缩到零:梯度消失
- 梯度直方图爆炸:需要梯度裁剪
第 9 部分:VS Code 调试器
对于交互式调试,配置 VS Code 的 launch.json:
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug Training",
"type": "debugpy",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal",
"justMyCode": false
}
]
}
点击行号旁设置断点。使用变量面板检查张量属性。调试控制台让你在执行过程中运行任意 Python 表达式。
适用于逐步调试数据预处理流水线,你想看到每个变换的结果。
实际应用
以下是捕获大多数 AI Bug 的调试工作流:
- 训练前:用样本 batch 运行
check_shapes。验证输入和输出维度符合预期。 - 前 10 步:对 loss、outputs 和 gradients 使用
debug_print。确认没有 NaN 且值在合理范围内。 - 训练期间:记录 loss、学习率和梯度范数。使用 TensorBoard 可视化。
- 出问题时:在失败点插入
breakpoint()。交互式检查张量。 - 性能优化:计时数据加载 vs 前向传播 vs 反向传播。如果接近 OOM 则分析内存。
交付成果
运行调试工具脚本:
python phases/00-setup-and-tooling/12-debugging-and-profiling/code/debug_tools.py
参见 outputs/prompt-debug-ai-code.md,这是一个帮助诊断 AI 特有 Bug 的提示词。
练习
- 运行
debug_tools.py并阅读每部分的输出。修改虚拟模型引入一个 NaN(提示:在前向传播中除零),观察检测器捕获它。 - 用
cProfile分析训练循环,找出最慢的函数。 - 使用
tracemalloc找出数据加载流水线中哪行代码分配了最多内存。 - 为一个简单的训练运行设置 TensorBoard,判断模型是否过拟合。
- 在训练循环中使用
breakpoint()。练习从调试器提示符检查张量形状、设备和梯度值。