From 252129ba57bba7d226b78b66f123a1b4f6826d87 Mon Sep 17 00:00:00 2001 From: yu-liang-bin Date: Wed, 27 Aug 2025 09:26:14 +0800 Subject: [PATCH] fix docs msmonitor --- msmonitor/README.md | 16 ++++++++-------- msmonitor/docs/release_notes.md | 2 +- msmonitor/plugin/README.md | 4 ++-- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/msmonitor/README.md b/msmonitor/README.md index e6821f0de..4ff0ae800 100644 --- a/msmonitor/README.md +++ b/msmonitor/README.md @@ -1,7 +1,7 @@ # msMonitor ## 📌 简介 -msMonitor是MindStudio推出的一站式在线监控工具，提供用户在集群场景性能监控定位端到端能力。msMonitor基于[dynolog](https://github.com/facebookincubator/dynolog)开发，结合AI框架（[Ascend PyTorch Profiler](https://www.hiascend.com/document/detail/zh/mindstudio/81RC1/T&ITools/Profiling/atlasprofiling_16_0090.html#ZH-CN_TOPIC_0000002353635602__zh-cn_topic_0000002370275077_section17272160135118)、[MindSpore Profiler](https://www.hiascend.com/document/detail/zh/mindstudio/81RC1/T&ITools/Profiling/atlasprofiling_16_0087.html#ZH-CN_TOPIC_0000002353475766__zh-cn_topic_0000002370195177_section0157845102716)）的动态采集能力和[MSPTI](https://www.hiascend.com/document/detail/zh/mindstudio/81RC1/T&ITools/Profiling/atlasprofiling_16_0021.html)，提供用户**nputrace**和**npumonitor**功能： +msMonitor是MindStudio推出的一站式在线监控工具，提供用户在集群场景性能监控定位端到端能力。msMonitor基于[dynolog](https://github.com/facebookincubator/dynolog)开发，结合AI框架（[Ascend PyTorch Profiler](https://www.hiascend.com/document/detail/zh/mindstudio/81RC1/T&ITools/Profiling/atlasprofiling_16_0090.html#ZH-CN_TOPIC_0000002353635602__zh-cn_topic_0000002370275077_section17272160135118)、[MindSpore Profiler](https://www.hiascend.com/document/detail/zh/mindstudio/81RC1/T&ITools/Profiling/atlasprofiling_16_0087.html#ZH-CN_TOPIC_0000002353475766__zh-cn_topic_0000002370195177_section0157845102716)）的动态采集能力和[MSPTI](https://www.hiascend.com/document/detail/zh/mindstudio/81RC1/T&ITools/Profiling/atlasprofiling_16_0021.html)，为用户提供**nputrace**和**npumonitor**功能： 1. **npumonitor功能**：轻量常驻后台，监控关键算子耗时 2. **nputrace功能**：获取到框架、CANN以及device的详细性能数据 @@ -9,25 +9,25 @@ msMonitor是MindStudio推出的一站式在线监控工具，提供用户在集 如上图所示msMonitor分为三部分： 1. **Dynolog daemon**：dynolog守护进程，每个节点只有一个守护进程，负责接收dyno CLI的RPC请求、触发nputrace和npumonitor功能、上报数据的处理以及最终数据的展示。 -2. **Dyno CLI**：dyno客户端，提供用户nputrace和npumonitor子命令，任意节点都可以安装。 +2. **Dyno CLI**：dyno客户端，为用户提供nputrace和npumonitor子命令，任意节点都可以安装。 3. **MSPTI Monitor**：基于MSPTI实现的监控子模块，通过调用MSPTI的API获取性能数据，并上报给Dynolog daemon。 ## 💻 版本说明 msMonitor由三个文件组成，其中dyno和dynolog可以被打包为deb包或者rpm包。最新的预编译安装包和版本依赖请查看[msMonitor release](./docs/release_notes.md)。目前msMonitor支持在[PyTorch](https://gitee.com/ascend/pytorch)框架和[MindSpore](https://www.mindspore.cn/)框架上运行。 -| 文件名 | 用途 | -|-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| -| dyno | dyno客户端二进制文件 | -| dynolog | dynolog服务端二进制文件 | -| msmonitor_plugin-{mindstudio_version}-cp{version}-cp{version}-linux_{system_architecture}64.whl | MSPTI Monitor、IPC等公共能力工具包，{mindstudio_version}表示mindstudio版本号，{version}表示python版本号，{system_architecture}表示CPU架构系统 | +| 文件名 | 用途 | +|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| dyno | dyno客户端二进制文件 | +| dynolog | dynolog服务端二进制文件 | +| msmonitor_plugin-{mindstudio_version}-cp{python_version}-cp{python_version}-linux_{system_architecture}.whl | MSPTI Monitor、IPC等公共能力工具包，{mindstudio_version}表示mindstudio版本号，{python_version}表示python版本号，{system_architecture}表示CPU架构系统 | ## 🚀 快速上手 ### Step 1: 安装 请参见[msMonitor安装手册](./docs/install.md)，安装msMonitor工具，推荐使用下载软件包安装。 ### Step 2: 运行 -npumonitor和nputrace功能详细说明请参考[npumonitor](./docs/npumonitor.md)或[nputrace](./docs/nputrace.md)特性介绍章节，下面介绍msMonitor常见的使用场景： +npumonitor和nputrace功能详细说明请参考[特性介绍](#-特性介绍)章节，下面介绍msMonitor常见的使用场景： 1. 先使用npumonitor功能获取关键算子耗时 2. 当发现监控到关键算子耗时劣化，使用nputrace功能采集详细性能数据做分析 diff --git a/msmonitor/docs/release_notes.md b/msmonitor/docs/release_notes.md index 06bd673dc..1bb2e5ced 100644 --- a/msmonitor/docs/release_notes.md +++ b/msmonitor/docs/release_notes.md @@ -40,7 +40,7 @@ Step 3: 包安装(以x86版本为例) 3. 安装whl包 ```bash - pip install msmonitor_plugin-*-cp39-*.whl + pip install msmonitor_plugin-{mindstudio_version}-cp{python_version}-cp{python_version}-linux_{system_architecture}.whl ``` 4. 安装dynolog diff --git a/msmonitor/plugin/README.md b/msmonitor/plugin/README.md index c209e8b91..b6e3a4ca2 100644 --- a/msmonitor/plugin/README.md +++ b/msmonitor/plugin/README.md @@ -36,10 +36,10 @@ pip install pybind11 bash ./stub/build_stub.sh python3 setup.py bdist_wheel ``` -以上命令执行完成后在dist目录下生成msMonitor插件whl安装包msmonitor-plugin-{version}.whl +以上命令执行完成后在dist目录下生成msMonitor插件whl安装包msmonitor_plugin-{mindstudio_version}-cp{python_version}-cp{python_version}-linux_{system_architecture}.whl * 安装 ``` -pip install dist/{msmonitor-plugin-{version}.whl} +pip install dist/msmonitor_plugin-{mindstudio_version}-cp{python_version}-cp{python_version}-linux_{system_architecture}.whl ``` * 卸载 ``` -- Gitee