From 23ffd578adc744065bc6c8b0ac87eb8f5a322b7b Mon Sep 17 00:00:00 2001 From: huan <3174348550@qq.com> Date: Tue, 22 Jul 2025 11:48:50 +0800 Subject: [PATCH] add links in mindstudio --- .../docs/source_zh_cn/feature/performance.md | 2 + .../docs/source_zh_cn/feature/precision.md | 2 + .../docs/source_zh_cn/guide/get_start.md | 2 + .../docs/source_zh_cn/guide/large_model.md | 2 + docs/mindstudio/docs/source_zh_cn/index.rst | 53 ++++++++++++++++--- docs/mindstudio/docs/source_zh_cn/overview.md | 42 --------------- .../version/mindstudio_insight.md | 2 + 7 files changed, 55 insertions(+), 50 deletions(-) delete mode 100644 docs/mindstudio/docs/source_zh_cn/overview.md diff --git a/docs/mindstudio/docs/source_zh_cn/feature/performance.md b/docs/mindstudio/docs/source_zh_cn/feature/performance.md index 2e4d457fd8..72d9963bdf 100644 --- a/docs/mindstudio/docs/source_zh_cn/feature/performance.md +++ b/docs/mindstudio/docs/source_zh_cn/feature/performance.md @@ -1,5 +1,7 @@ # 性能调优 +[![查看源文件](https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg)](https://gitee.com/mindspore/docs/blob/master/docs/mindstudio/docs/source_zh_cn/feature/performance.md) + diff --git a/docs/mindstudio/docs/source_zh_cn/feature/precision.md b/docs/mindstudio/docs/source_zh_cn/feature/precision.md index b351b83bcd..19f8e6c5bf 100644 --- a/docs/mindstudio/docs/source_zh_cn/feature/precision.md +++ b/docs/mindstudio/docs/source_zh_cn/feature/precision.md @@ -1,5 +1,7 @@ # 精度调试 +[![查看源文件](https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg)](https://gitee.com/mindspore/docs/blob/master/docs/mindstudio/docs/source_zh_cn/feature/precision.md) +
工具
diff --git a/docs/mindstudio/docs/source_zh_cn/guide/get_start.md b/docs/mindstudio/docs/source_zh_cn/guide/get_start.md index c805d1f2f8..70035352f8 100644 --- a/docs/mindstudio/docs/source_zh_cn/guide/get_start.md +++ b/docs/mindstudio/docs/source_zh_cn/guide/get_start.md @@ -1,3 +1,5 @@ # 全流程调试调优工具使用指南 +[![查看源文件](https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg)](https://gitee.com/mindspore/docs/blob/master/docs/mindstudio/docs/source_zh_cn/guide/get_start.md) + 为方便开发者快速上手使用调试调优工具，[工具快速入门指南 - 待补充](xxxx，ascend官网的MindSpore入门指导链接)以ResNet50模型为例介绍了精度调试、性能调优过程中工具常用功能的用法，包含使用msprobe工具进行训练前配置检查、训练状态监控、精度数据采集和比对、精度预检，使用Profiler进行性能数据采集，使用msprof-analyze和MindStudio Insight工具进行性能分析等。 diff --git a/docs/mindstudio/docs/source_zh_cn/guide/large_model.md b/docs/mindstudio/docs/source_zh_cn/guide/large_model.md index 69e56cb2a9..128007d324 100644 --- a/docs/mindstudio/docs/source_zh_cn/guide/large_model.md +++ b/docs/mindstudio/docs/source_zh_cn/guide/large_model.md @@ -1,5 +1,7 @@ # 大模型调试调优指南 +[![查看源文件](https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg)](https://gitee.com/mindspore/docs/blob/master/docs/mindstudio/docs/source_zh_cn/guide/large_model.md) + ## 基于MindSpore TransFormers大模型套件的调试调优指南 [MindSpore TransFormers](https://www.mindspore.cn/mindformers/docs/zh-CN/master/index.html)是MindSpore提供的包含大模型预训练、微调、推理、部署的全流程开发套件，也是MindSpore当前常用的大模型开发套件。 diff --git a/docs/mindstudio/docs/source_zh_cn/index.rst b/docs/mindstudio/docs/source_zh_cn/index.rst index 6445389a1f..158ea4c0c6 100644 --- a/docs/mindstudio/docs/source_zh_cn/index.rst +++ b/docs/mindstudio/docs/source_zh_cn/index.rst @@ -9,14 +9,6 @@ MindStudio是面向AI开发者提供的全流程工具链，提供了精度、 代码仓地址： -.. toctree:: - :glob: - :maxdepth: 1 - :caption: 工具概览与安装 - :hidden: - - overview - .. toctree:: :glob: :maxdepth: 1 @@ -42,3 +34,48 @@ MindStudio是面向AI开发者提供的全流程工具链，提供了精度、 guide/large_model +调试调优工具概览与安装说明 +-------------------------------- + +.. raw:: html + +
工具
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
类型名称简介安装指南
精度调试msprobe提供精度数据采集、精度预检、精度比对和溢出检测等精度调试功能。安装msprobe
DumpMindSpore框架内置的精度数据采集工具。安装MindSpore
性能调优ProfilerMindSpore框架内置的性能数据采集、分析工具。安装MindSpore
msprof-anaylze为采集的性能数据提供统计、分析、专家建议等功能。安装msprof-anaylze
msleaks用于模型训内存问题定位，提供Step内和Step间的内存异常检测能力，包括Step内内存泄漏分析和Step间内存对比分析。CANN包提供的命令行工具，需安装MindSpore配套CANN包和CANN包下的Toolkit软件包，并按照教程使能环境变量。安装CANN包
安装Toolkit软件包
MindStudio Insight可视化性能调优工具，提供时间线视图、算子耗时、通信瓶颈分析等功能，辅助快速分析模型性能瓶颈。安装MindStudio Insight
查询版本配套关系
\ No newline at end of file diff --git a/docs/mindstudio/docs/source_zh_cn/overview.md b/docs/mindstudio/docs/source_zh_cn/overview.md deleted file mode 100644 index b48b10097f..0000000000 --- a/docs/mindstudio/docs/source_zh_cn/overview.md +++ /dev/null @@ -1,42 +0,0 @@ -# 调试调优工具概览与安装说明 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
类型名称简介安装指南
精度调试msprobe提供精度数据采集、精度预检、精度比对和溢出检测等精度调试功能。安装msprobe
DumpMindSpore框架内置的精度数据采集工具。安装MindSpore
性能调优ProfilerMindSpore框架内置的性能数据采集、分析工具。安装MindSpore
msprof-anaylze为采集的性能数据提供统计、分析、专家建议等功能。安装msprof-anaylze
msleaks用于模型训内存问题定位，提供Step内和Step间的内存异常检测能力，包括Step内内存泄漏分析和Step间内存对比分析。CANN包提供的命令行工具，需安装MindSpore配套CANN包和CANN包下的Toolkit软件包，并按照教程使能环境变量。安装CANN包
安装Toolkit软件包
MindStudio Insight可视化性能调优工具，提供时间线视图、算子耗时、通信瓶颈分析等功能，辅助快速分析模型性能瓶颈。安装MindStudio Insight
查询版本配套关系
diff --git a/docs/mindstudio/docs/source_zh_cn/version/mindstudio_insight.md b/docs/mindstudio/docs/source_zh_cn/version/mindstudio_insight.md index 1fe3612b27..47f6050290 100644 --- a/docs/mindstudio/docs/source_zh_cn/version/mindstudio_insight.md +++ b/docs/mindstudio/docs/source_zh_cn/version/mindstudio_insight.md @@ -1,5 +1,7 @@ # MindStudio Insight与MindSpore版本配套 +[![查看源文件](https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg)](https://gitee.com/mindspore/docs/blob/master/docs/mindstudio/docs/source_zh_cn/version/mindstudio_insight.md) + MindStudio Insight可视化工具，需要与采集性能数据时使用的MindSpore版本配套。 当前最新MindStudio Insight版本xxxx(待补充)： -- Gitee