diff --git a/mindinsight/debugger/README.md b/mindinsight/debugger/README.md new file mode 100644 index 00000000..bc29c827 --- /dev/null +++ b/mindinsight/debugger/README.md @@ -0,0 +1,23 @@ +# Debugger Introduction + +[查看中文](./README_CN.md) + +## Overview + +MindSpore Debugger is a debugging tool for training in `Graph Mode`. It can be applied to visualize and analyze the intermediate computation results of the computational graph. + +In `Graph Mode` training, the computation results of intermediate nodes in the computational graph can not be acquired from python layer, which makes it difficult for users to do the debugging. By applying MindSpore Debugger, users can: + +- Visualize the computational graph on the UI and analyze the output of the graph node; +- Set conditional breakpoint to monitor training exceptions (such as Nan/Inf), if the condition (Nan/Inf etc.) is met, users can track the cause of the bug when an exception occurs; +- Visualize and analyze the change of parameters, such as weights. + +## Operation Process + +- Launch MindInsight in debugger mode, and set Debugger environment variables for the training; +- At the beginning of the training, set conditional breakpoints to monitor the outputs of the graph nodes; +- Analyze the training progress on MindInsight Debugger UI. + +## Debugger Instructions + +For the details of how to use MindSpore Debugger, please refer to [https://www.mindspore.cn/tutorial/en/master/advanced_use/debugger.html](https://www.mindspore.cn/tutorial/en/master/advanced_use/debugger.html) diff --git a/mindinsight/debugger/README_CN.md b/mindinsight/debugger/README_CN.md new file mode 100644 index 00000000..5e4136a1 --- /dev/null +++ b/mindinsight/debugger/README_CN.md @@ -0,0 +1,23 @@ +# Debugger 介绍 + +[View English](./README.md) + +## Debugger概述 + +MindSpore Debugger是为图模式训练提供的调试工具,可以用来查看并分析计算图节点的中间结果。 + +在MindSpore图模式的训练过程中,用户无法从Python层获取到计算图中间节点的结果,使得训练调试变得很困难。使用MindSpore Debugger,用户可以: + +- 在MindInsight UI结合计算图,查看图节点的输出结果; +- 设置条件断点,监测训练异常情况(比如Nan/Inf),在异常发生时追踪错误原因; +- 查看权重等参数的变化情况。 + +## 操作流程 + +- 以Debugger模式启动MindInsight,配置相关环境变量; +- 训练开始,在MindInsight Debugger UI设置条件断点,监测节点的输出值; +- 在MindInsight Debugger UI分析训练执行情况。 + +## Debugger使用方法 + +MindSpore Debugger的使用方法,请参考[https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/debugger.html](https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/debugger.html) \ No newline at end of file