Info
更多信息，欢迎查看源码仓: mspti
MindStudio Profiler Tools Interface
昇腾 Profiling 工具接口
✨ 最新消息¶
🔹 [2026.02.06]：版本说明新增 26.0.0-alpha.1 发布记录，兼容 CANN > 8.5.0，详情请参见 《版本说明》。
ℹ️ 简介¶
msPTI（MindStudio Profiler Tools Interface）是面向 Ascend 设备的 Profiling API 集合，帮助开发者为 NPU 应用构建性能采集与分析工具，适用于推理与训练场景。
msPTI 主要提供以下能力：
Tracing：采集 CANN API、Kernel、内存拷贝、通信、打点等时间戳及附加信息，用于定位执行链路中的性能瓶颈。Profiling：单独采集一个或一组 Kernel 的 NPU 性能指标，支撑计算与通信分析。
⚙️ 功能介绍¶
| 模块 | 功能简介 | 文档 |
|---|---|---|
Activity API |
采集 API、Kernel、Memory、HCCL、Marker、External Correlation 等活动数据，用于构建 Tracing / Profiling 工具。 | C API 参考 |
Callback API |
订阅 Runtime / HCCL 回调，在 API 调用前后执行自定义逻辑或关联采集数据。 | C API 参考 |
Python API |
提供 KernelMonitor、HcclMonitor、MstxMonitor、CommunicationMonitor 等接口，快速接入 Python 场景分析能力。 |
Python API 参考 |
样例集 |
覆盖 callback、activity、correlation、HCCL、Python monitor 等典型场景，便于快速上手。 | 样例说明 / 样例指南 |
🚀 快速入门¶
快速入门介绍msPTI工具的使用流程，具体请参见《msPTI快速入门》。
📦 安装指南¶
msPTI 运行依赖配套版本的 CANN 环境。安装 msPTI 前，请先完成以下环境准备：
完成上述准备后，可通过以下两种方式安装 msPTI：
- 方式一：从 releases 页面 下载预构建的
run包，执行 MD5 校验后安装。 - 方式二：从源码仓执行
bash scripts/build.sh [<version>]先构建run包，再安装。
完整环境准备、两种安装方式的详细步骤、安装参数与示例命令请参见 《msPTI 工具安装指南》。
📘 使用指南¶
工具的详细使用方法，请参见 《msPTI 使用指南》。
💡 典型案例¶
通过典型问题场景帮助用户理解并掌握工具使用，请参见《msPTI 典型案例》。
📚 API 参考¶
包含 C API 接口和 Python API 接口两种类型，请参见 《C API 参考》和《Python API 参考》。
🌌 智能检索¶
为提升文档查阅效率，我们提供多种高效检索方式：
🔹 AI 问答（DeepWiki）：自然语言问答，快速把握项目架构与模块关系。
🔹 AI 问答（ZRead）：中文问答体验更优，精准定位功能用法与细节。
🔹 精确搜索（ReadTheDocs）：关键词全文检索，直达接口、参数与报错等信息。
🛠️ 贡献指南¶
欢迎参与项目贡献，请参见 《贡献指南》。
📝 相关说明¶
🤝 建议与交流¶
欢迎大家为社区做贡献。如果有任何疑问或建议，请提交 Issues，我们会尽快回复。感谢您的支持。
| 💬 即时互动（微信群） | 📢 官方资讯（公众号） | 深度支持（助手/论坛） |
|---|---|---|
 扫码直接加入技术交流群 |
 扫码关注获取最新动态 |
扫码入群并关注公众号，直达 MindStudio 用户与开发者最快捷的交流平台： 快速提问： 与社区小伙伴即时探讨技术问题 掌握动态： 第一时间获取版本发布与功能更新通知 经验共享： 与广大开发者交流最佳实践与实战心得 🛠️ 更多支持渠道：👉 昇腾助手：  👉 昇腾论坛： |
🙏 致谢¶
本工具由华为公司的下列部门贡献：
🔹 昇腾计算MindStudio开发部
感谢来自社区的每一个PR，欢迎贡献。