msProbe 开发指南

本文面向 msProbe 的开发和维护人员，介绍源码目录、构建方式、功能开发流程、功能改动后的验证方法，以及资料联动更新要求。本文重点结合 msProbe 当前仓库和现有文档内容编写，适用于新增命令参数、扩展工具能力、增加交付件或维护软件包安装方式等场景。

1. msProbe 开发概述

msProbe 提供 AI 任务运行精度数据的采集、预检与比对等能力。围绕开发工作，通常可以分为以下几类：

开发对象	典型内容
采集能力	包括训练和推理模块的精度数据采集能力
预检能力	`msprobe acc_check`、`msprobe multi_acc_check`
比对能力	`msprobe compare、msprobe compare -m atb、offline_model`、`msprobe graph_visualize`等
溢出检测	`msprobe overflow_check`
扩展功能	训练前配置检查、训练状态监测、 checkpoint比对、趋势可视化等
文档资料	安装指南、快速入门、功能说明、数据文件参考、扩展功能

根据当前仓库资料，msProbe 项目主要目录如下：

目录	说明
`ccsrc`	C/C++源码目录
`cmake`	存放解析C化部分cmake文件
`docs`	文档目录
`examples`	工具配置样例存放目录
`output`	交付件生成目录
`plugins`	插件类代码总入口
`python/msprobe/core`	工具核心功能模块
`python/msprobe/infer`	推理工具模块
`python/msprobe/mindspore`	MindSpore工具模块
`python/msprobe/msaccucmp`	msaccucmp工具模块
`python/msprobe/overflow_check`	溢出检测模块
`python/msprobe/pytorch`	PyTorch工具模块
`python/msprobe/visualization`	可视化模块
`scripts`	存放安装卸载升级脚本
`test`	测试代码目录
`docs/zh`	中文文档

按照《msProbe 安装指南 — 源码安装》章节完成编译和测试环境的搭建。

说明： 环境镜像的构建方法及配套软件版本由 MindStudio 统一镜像制作指南维护，本仓库不重复定义。

进入编译容器后，可执行启动界面提示的命令（如 py310）切换至对应的 Python 版本环境。

git clone https://gitcode.com/Ascend/msprobe.git
cd msprobe

python3 build.py
cd ./artifacts
pip install ./mindstudio_probe*.whl

编译工具包时还可以选择编译的功能模块，通过–include-mod参数配置，详见《msProbe工具安装指南》

安装完成后，建议立即校验：

which msprobe
msprobe --help

仓库提供了统一的单元测试入口：

# Python单元测试
python3 build.py test

功能开发完成后，若改动影响用户使用方式或输出结果，需要同步更新文档。

改动类型	需同步更新的文档
安装、编译、升级方式	`docs/zh/install_guide/msprobe_install_guide.md`
快速入门	`docs/zh/quick_start`
功能文档	`docs/zh/user_guide/dump`
性能基线文档	`docs/zh/baseline`
案例文档	`docs/zh/best_practices`
FAQ	`docs/zh/support`

若新增文档、截图或示意图：