MSProbe 调试指南#

在推理或训练过程中,我们常会遇到精度异常问题,例如输出偏离预期、出现数值不稳定(NaN/Inf)现象,或预测结果与标签不再匹配。要定位根本原因,必须监控并捕获模型执行过程中产生的中间数据——包括特征图、权重、激活值和各层输出。通过在特定阶段捕获关键张量、记录核心层的输入输出对,并保留上下文元数据(提示词、张量数据类型、硬件配置等),我们可以系统性地追踪精度退化或数值误差的源头。本指南描述了诊断 AI 模型精度问题的端到端工作流(重点针对 vllm-ascend 服务):准备工作、数据采集以及分析与验证。

0. Background Concepts#

msprobe 支持三种精度级别:

  • L0:在模块级别保存张量,并生成 construct.json 以便可视化工具重建网络结构。需要传入模型或子模块句柄。

  • L1:仅采集算子级统计信息,适用于轻量级故障排查。

  • mix:同时捕获结构信息和算子统计,适用于需要同时进行图重构和数值比较的场景。

1.前提条件#

1.1 安装 msprobe#

使用 pip 安装 msprobe:

pip install mindstudio-probe==8.3.0

1.2 可视化依赖(可选)#

如需对采集的数据进行可视化,请安装以下依赖。

  1. 安装 tb_graph_ascend

    pip install tb_graph_ascend
    

2.使用 msprobe 采集数据#

我们通常采用由粗到细的策略采集数据。首先确定问题出现的 token,然后决定围绕该 token 需要采样的范围。典型工作流程如下所述。

2.1 准备数据采集配置文件#

创建一个可由 PrecisionDebugger 解析的 config.json 文件,并将其置于可访问路径。常见字段如下:

字段

说明

必填

task

采集任务类型。PyTorch 常用取值包括 "statistics""tensor"。统计任务采集张量统计信息(均值、方差、最大值、最小值等),而张量任务则捕获任意张量。

dump_path

采集结果存储目录。如未指定,msprobe 将使用其默认路径。

rank

指定需要采样的设备 rank。空列表表示采集所有 rank。单卡任务必须将此字段设置为 []

step

指定需要采样的 token 迭代次数。空列表表示所有迭代。

level

采集级别字符串("L0""L1""mix")。L0 针对 nn.ModuleL1 针对 torch.apimix 则同时采集两者。

async_dump

是否启用异步采集(PyTorch statistics/tensor 任务支持)。默认值为 false

scope

指定需要采样的模块范围。空列表表示所有模块。

list

指定需要采样的算子范围。空列表表示所有算子。

如需限制捕获的算子范围,可配置 list 块:

  • scope(list[str]):在 PyTorch 动态图场景下,此字段用于限制采集范围。提供两个遵循工具命名约定的模块或 API 名称以锁定范围;仅会采集这两个名称之间的数据。示例:

    "scope": ["Module.conv1.Conv2d.forward.0", "Module.fc2.Linear.forward.0"]
    "scope": ["Cell.conv1.Conv2d.forward.0", "Cell.fc2.Dense.backward.0"]
    "scope": ["Tensor.add.0.forward", "Functional.square.2.forward"]
    

    level 设置决定了可提供的内容——level=L0 时使用模块名,level=L1 时使用 API 名,level=mix 时两者皆可。

  • list(list[str]):自定义算子列表。选项包括:

    • 在 PyTorch 动态图场景中,提供特定 API 的全称以仅采集这些 API。示例:"list": ["Tensor.permute.1.forward", "Tensor.transpose.2.forward", "Torch.relu.3.backward"]

    • level=mix 时,可提供模块名称,采集将扩展至该模块运行时产生的所有内容。示例:"list": ["Module.module.language_model.encoder.layers.0.mlp.ParallelMlp.forward.0"]

    • 提供子字符串(例如 "list": ["relu"])以采集名称包含该子字符串的所有 API。当 level=mix 时,名称包含该子字符串的模块也会被展开采集。

配置示例:

cat <<'JSON' > /data/msprobe_config.json
{
  "task": "statistics",
  "dump_path": "/home/data_dump",
  "rank": [],
  "step": [],
  "level": "L1",
  "async_dump": false,

  "statistics": {
    "scope": [],
    "list": [],
    "tensor_list": [],
    "data_mode": ["all"],
    "summary_mode": "statistics"
  }
}
JSON

2.在 vllm-ascend 中启用 msprobe#

  1. 通过添加 --enforce-eager 以动态图模式启动 vLLM(暂不支持静态图场景),并通过 --additional-config 传递配置路径:

    vllm serve Qwen/Qwen2.5-0.5B-Instruct \
      --dtype float16 \
      --enforce-eager \
      --host 0.0.0.0 \
      --port 8000 \
      --additional-config '{"dump_config_path": "/data/msprobe_config.json"}' &
    

3.发送请求并采集数据#

  1. 按常规方式发送推理请求,例如:

    curl http://localhost:8000/v1/completions \
      -H "Content-Type: application/json" \
      -d '{
            "model": "Qwen/Qwen2.5-0.5B-Instruct",
            "prompt": "Explain gravity in one sentence.",
            "max_tokens": 32,
            "temperature": 0
          }' | python -m json.tool
    
  2. 每个请求都会驱动序列 msprobe: start -> forward/backward -> stop -> step。运行器在每个代码路径都会调用 step(),因此即使推理提前返回,您也能获得完整的数据集。

  3. 采集文件将写入 dump_path。通常包含以下内容:

    • 按算子或模块分组的张量文件。

    • 记录 dtype、形状、最小值/最大值以及 requires_grad 等元数据的 dump.json

    • levelL0mix 时生成的 construct.json(可视化必需)。

    目录结构示例:

    ├── dump_path
    │   ├── step0
    │   │   ├── rank0
    │   │   │   ├── dump_tensor_data
    │   │   │   │    ├── Tensor.permute.1.forward.pt
    │   │   │   │    ├── Functional.linear.5.backward.output.pt    # Format: {api_type}.{api_name}.{call_count}.{forward/backward}.{input/output}.{arg_index}.
    │   │   │   │    │                                              # arg_index is the nth input or output of the API. If an input is a list, keep numbering with decimals (e.g., 1.1 is the first element of the first argument).
    │   │   │   │    ├── Module.conv1.Conv2d.forward.0.input.0.pt          # Format: {Module}.{module_name}.{class_name}.{forward/backward}.{call_count}.{input/output}.{arg_index}.
    │   │   │   │    ├── Module.conv1.Conv2d.forward.0.parameters.bias.pt  # Module parameter data: {Module}.{module_name}.{class_name}.forward.{call_count}.parameters.{parameter_name}.
    │   │   │   │    └── Module.conv1.Conv2d.parameters_grad.weight.pt     # Module parameter gradients: {Module}.{module_name}.{class_name}.parameters_grad.{parameter_name}. Gradients do not include call_count because the same gradient updates all invocations.
    │   │   │   │                                                          # When the `model` argument passed to dump is a List[torch.nn.Module] or Tuple[torch.nn.Module], module-level data names also include the index inside the list ({Module}.{index}.*), e.g., Module.0.conv1.Conv2d.forward.0.input.0.pt.
    │   │   │   ├── dump.json
    │   │   │   ├── stack.json
    │   │   │   ├── dump_error_info.log
    │   │   │   └── construct.json
    │   │   ├── rank1
    │   │   │   ├── dump_tensor_data
    │   │   │   │   └── ...
    │   │   │   ├── dump.json
    │   │   │   ├── stack.json
    │   │   │   ├── dump_error_info.log
    │   │   │   └── construct.json
    │   │   ├── ...
    │   │   │
    │   │   └── rank7
    │   ├── step1
    │   │   ├── ...
    │   ├── step2
    
    • rank:设备 ID。每张卡将其数据写入对应的 rank{ID} 目录。在非分布式场景中,目录仅命名为 rank

    • dump_tensor_data:采集到的张量数据。

    • dump.json:每个 API 或模块前向/反向数据的统计信息,包括名称、dtype、形状、最大值、最小值、均值、L2 范数(L2 方差的平方根),以及在 summary_mode="md5" 时的 CRC-32。详情请参阅 dump.json 文件说明

    • dump_error_info.log:仅在采集工具遇到错误时生成,记录失败日志。

    • stack.json:API/模块的调用栈信息。

    • construct.json:分层结构描述。level=L1 时为空。

4.分析结果#

4.1前提条件#

通常需要两个采集数据集:一个来自“问题侧”(暴露精度或数值错误的运行),另一个来自“基准侧”(良好的基线)。这些数据集不必完全相同——它们可以来自不同的分支、框架版本,甚至不同的实现(算子替换、不同的图优化开关等)。只要它们使用相同或相似的输入、硬件拓扑和采样点(步数/token),msprobe 就能进行比较并定位差异节点。如果找不到完全干净的基准,可以先采集问题侧数据,手动构建最小可复现案例,然后进行自比较。下文中,我们假设问题采集目录为 problem_dump,基准采集目录为 bench_dump

4.2 可视化#

使用 msprobe graph_visualize 生成可在 tb_graph_ascend 中打开的结果。

  1. 确保采集数据包含 construct.json(即 level = L0level = mix)。

  2. 准备对比文件(例如 compare.json)。其格式和生成流程在 msprobe_visualization.md 第 3.1.3 节中有描述。示例(最小可运行代码片段):

    {
      "npu_path": "./problem_dump",
      "bench_path": "./bench_dump",
      "is_print_compare_log": true
    }
    

    在调用 msprobe graph_visualize 之前,将路径替换为您的采集目录。如果只需要构建单个图,可省略 bench_path 以可视化单个采集数据。支持多 rank 场景(单 rank、多 rank 或多步多 rank)。npu_pathbench_path 必须包含名为 rank+数字 的文件夹,且每个 rank 文件夹必须包含非空的 construct.json 以及 dump.jsonstack.json。如果任何 construct.json 为空,请确认采集级别包含 L0mix。比较图形时,npu_pathbench_path 必须包含相同的一组 rank 文件夹,以便它们可以一对一配对。

    ├── npu_path or bench_path
    |   ├── rank0
    |   |   ├── dump_tensor_data (only when the `tensor` option is enabled)
    |   |   |    ├── Tensor.permute.1.forward.pt
    |   |   |    ├── MyModule.0.forward.input.pt
    |   |   |    ...
    |   |   |    └── Function.linear.5.backward.output.pt
    |   |   ├── dump.json         # Tensor metadata
    |   |   ├── stack.json        # Operator call stack information
    |   |   └── construct.json    # Hierarchical structure; empty when `level=L1`
    |   ├── rank1
    |   |   ├── dump_tensor_data
    |   |   |   └── ...
    |   |   ├── dump.json
    |   |   ├── stack.json
    |   |   └── construct.json
    |   ├── ...
    |   |
    |   └── rankn
    
  3. 运行:

    msprobe graph_visualize \
        --input_path ./compare.json \
        --output_path ./graph_output
    

    比较完成后,将在 graph_output 下创建 *.vis.db 文件。

    • 图构建:build_{timestamp}.vis.db

    • 图比较:compare_{timestamp}.vis.db

  4. 启动 tensorboard 并加载输出目录,以检查结构差异、数值比较、溢出检测结果、跨设备通信节点以及过滤器/搜索功能。将包含 .vis.db 文件的目录传递给 --logdir

    tensorboard --logdir out_path --bind_all --port [optional_port]
    
  5. 检查可视化界面。UI 通常会显示整体模型结构,包括算子、参数和张量输入/输出。点击任意节点可展开其子节点。

    • 差异可视化:比较结果使用不同颜色突出显示差异节点(差异越大,节点越红)。点击节点可查看其详细信息,包括张量输入/输出、参数和算子类型。分析数据差异及其周围连接,以精确定位具体差异点。

    • 辅助功能

      • 切换 rank/step:快速检查不同 rank 和步数上的差异节点。

      • 搜索/过滤:使用搜索框按算子名称等过滤节点。

      • 手动映射:自动映射无法覆盖所有情况,因此该工具允许您在生成比较结果之前,手动映射问题和基准图中的节点。

5.故障排除#

  • RuntimeError: Please enforce eager mode:重启 vLLM 并添加 --enforce-eager 标志。

  • 无采集文件:确认 JSON 路径正确且每个节点都有写权限。在分布式场景中,设置 keep_all_ranks 以便每个 rank 写入自己的采集数据。

  • 采集数据过大:从 statistics 任务开始以定位异常张量,然后使用 scope/list/tensor_listfilterstoken_range 等缩小范围。


附录#

dump.json 文件说明#

L0 级别#

L0 级别的 dump.json 包含模块的前向/反向输入输出以及参数和参数梯度。以 PyTorch 的 Conv2d 为例,网络代码如下:

output = self.conv2(input)  # self.conv2 = torch.nn.Conv2d(64, 128, 5, padding=2, bias=True)

dump.json 包含以下条目:

  • Module.conv2.Conv2d.forward.0:模块的前向数据。input_args 表示位置输入,input_kwargs 表示关键字输入,output 存储前向输出,parameters 存储权重/偏置。

  • Module.conv2.Conv2d.parameters_grad:参数梯度(权重和偏置)。

  • Module.conv2.Conv2d.backward.0:模块的反向数据。input 表示流入模块的梯度(前向输出的梯度),output 表示流出模块的梯度(模块输入的梯度)。

注意:当传递给采集 API 的 model 参数为 List[torch.nn.Module]Tuple[torch.nn.Module] 时,模块级名称会包含其在列表中的索引({Module}.{index}.*)。例如:Module.0.conv1.Conv2d.forward.0

{
 "task": "tensor",
 "level": "L0",
 "framework": "pytorch",
 "dump_data_dir": "/dump/path",
 "data": {
  "Module.conv2.Conv2d.forward.0": {
   "input_args": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      8,
      16,
      14,
      14
     ],
     "Max": 1.638758659362793,
     "Min": 0.0,
     "Mean": 0.2544615864753723,
     "Norm": 70.50277709960938,
     "requires_grad": true,
     "data_name": "Module.conv2.Conv2d.forward.0.input.0.pt"
    }
   ],
   "input_kwargs": {},
   "output": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      8,
      32,
      10,
      10
     ],
     "Max": 1.6815717220306396,
     "Min": -1.5120246410369873,
     "Mean": -0.025344856083393097,
     "Norm": 149.65576171875,
     "requires_grad": true,
     "data_name": "Module.conv2.Conv2d.forward.0.output.0.pt"
    }
   ],
   "parameters": {
    "weight": {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      32,
      16,
      5,
      5
     ],
     "Max": 0.05992485210299492,
     "Min": -0.05999220535159111,
     "Mean": -0.0006165213999338448,
     "Norm": 3.421217441558838,
     "requires_grad": true,
     "data_name": "Module.conv2.Conv2d.forward.0.parameters.weight.pt"
    },
    "bias": {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      32
     ],
     "Max": 0.05744686722755432,
     "Min": -0.04894155263900757,
     "Mean": 0.006410328671336174,
     "Norm": 0.17263513803482056,
     "requires_grad": true,
     "data_name": "Module.conv2.Conv2d.forward.0.parameters.bias.pt"
    }
   }
  },
  "Module.conv2.Conv2d.parameters_grad": {
   "weight": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      32,
      16,
      5,
      5
     ],
     "Max": 0.018550323322415352,
     "Min": -0.008627401664853096,
     "Mean": 0.0006675920449197292,
     "Norm": 0.26084786653518677,
     "requires_grad": false,
     "data_name": "Module.conv2.Conv2d.parameters_grad.weight.pt"
    }
   ],
   "bias": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      32
     ],
     "Max": 0.014914230443537235,
     "Min": -0.006656786892563105,
     "Mean": 0.002657240955159068,
     "Norm": 0.029451673850417137,
     "requires_grad": false,
     "data_name": "Module.conv2.Conv2d.parameters_grad.bias.pt"
    }
   ]
  },
  "Module.conv2.Conv2d.backward.0": {
   "input": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      8,
      32,
      10,
      10
     ],
     "Max": 0.0015069986693561077,
     "Min": -0.001139344065450132,
     "Mean": 3.3215508210560074e-06,
     "Norm": 0.020567523315548897,
     "requires_grad": false,
     "data_name": "Module.conv2.Conv2d.backward.0.input.0.pt"
    }
   ],
   "output": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      8,
      16,
      14,
      14
     ],
     "Max": 0.0007466732058674097,
     "Min": -0.00044813455315306783,
     "Mean": 6.814070275140693e-06,
     "Norm": 0.01474067009985447,
     "requires_grad": false,
     "data_name": "Module.conv2.Conv2d.backward.0.output.0.pt"
    }
   ]
  }
 }
}

L1 级别#

L1 级别的 dump.json 记录 API 的前向/反向输入输出。以 PyTorch 的 relu 函数为例(output = torch.nn.functional.relu(input)),文件包含:

  • Functional.relu.0.forward:API 的前向数据。input_args 是位置输入,input_kwargs 是关键字输入,output 存储前向输出。

  • Functional.relu.0.backward:API 的反向数据。input 表示前向输出的梯度,output 表示流回前向输入的梯度。

{
 "task": "tensor",
 "level": "L1",
 "framework": "pytorch",
 "dump_data_dir":"/dump/path",
 "data": {
  "Functional.relu.0.forward": {
   "input_args": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      32,
      16,
      28,
      28
     ],
     "Max": 1.3864083290100098,
     "Min": -1.3364859819412231,
     "Mean": 0.03711778670549393,
     "Norm": 236.20692443847656,
     "requires_grad": true,
     "data_name": "Functional.relu.0.forward.input.0.pt"
    }
   ],
   "input_kwargs": {},
   "output": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      32,
      16,
      28,
      28
     ],
     "Max": 1.3864083290100098,
     "Min": 0.0,
     "Mean": 0.16849493980407715,
     "Norm": 175.23345947265625,
     "requires_grad": true,
     "data_name": "Functional.relu.0.forward.output.0.pt"
    }
   ]
  },
  "Functional.relu.0.backward": {
   "input": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      32,
      16,
      28,
      28
     ],
     "Max": 0.0001815402356442064,
     "Min": -0.00013352684618439525,
     "Mean": 0.00011915402356442064,
     "Norm": 0.007598237134516239,
     "requires_grad": false,
     "data_name": "Functional.relu.0.backward.input.0.pt"
    }
   ],
   "output": [
    {
     "type": "torch.Tensor",
     "dtype": "torch.float32",
     "shape": [
      32,
      16,
      28,
      28
     ],
     "Max": 0.0001815402356442064,
     "Min": -0.00012117840378778055,
     "Mean": 2.0098118724831693e-08,
     "Norm": 0.006532244384288788,
     "requires_grad": false,
     "data_name": "Functional.relu.0.backward.output.0.pt"
    }
   ]
  }
 }
}  

mix 级别#

mix 级别的 dump.json 同时包含 L0 和 L1 级别的数据;文件格式与上述示例相同。