Browse Source

!696 update links of README

Merge pull request !696 from TingWang/update-links
tags/v1.0.0
mindspore-ci-bot Gitee 5 years ago
parent
commit
0b4b29f4d4
13 changed files with 62 additions and 62 deletions
  1. +4
    -4
      README.md
  2. +4
    -4
      README_CN.md
  3. +1
    -1
      RELEASE.md
  4. +1
    -1
      mindinsight/debugger/README.md
  5. +1
    -1
      mindinsight/debugger/README_CN.md
  6. +13
    -13
      mindinsight/mindconverter/README.md
  7. +13
    -13
      mindinsight/mindconverter/README_CN.md
  8. +4
    -4
      mindinsight/profiler/README_GPU.md
  9. +9
    -9
      mindinsight/ui/src/locales/en-us.json
  10. +9
    -9
      mindinsight/ui/src/locales/zh-cn.json
  11. +1
    -1
      mindinsight/wizard/conf/templates/network/alexnet/README.md-tpl
  12. +1
    -1
      mindinsight/wizard/conf/templates/network/lenet/README.md-tpl
  13. +1
    -1
      mindinsight/wizard/conf/templates/network/resnet50/README.md-tpl

+ 4
- 4
README.md View File

@@ -16,8 +16,8 @@ MindInsight provides MindSpore with easy-to-use debugging and tuning capabilitie


![MindInsight Architecture](docs/arch.png) ![MindInsight Architecture](docs/arch.png)


Click to view the [Design document](https://www.mindspore.cn/docs/en/master/design.html),learn more about the design.
Click to view the [Tutorial documentation](https://www.mindspore.cn/tutorial/en/master/advanced_use/visualization_tutorials.html) learn more about the MindInsight tutorial.
Click to view the [Design document](https://www.mindspore.cn/doc/note/en/master/design.html),learn more about the design.
Click to view the [Tutorial documentation](https://www.mindspore.cn/tutorial/training/en/master/advanced_use/visualization_tutorials.html) learn more about the MindInsight tutorial.


## Installation ## Installation
Download whl package from [MindSpore download page](https://www.mindspore.cn/versions/en), and install the package. Download whl package from [MindSpore download page](https://www.mindspore.cn/versions/en), and install the package.
@@ -31,7 +31,7 @@ For more details on how to install MindInsight, click on the MindInsight section
## Quick Start ## Quick Start
Before using MindInsight, the data in the training process should be recorded. When starting MindInsight, the directory of the saved data should be specified. After successful startup, the data can be viewed through the web page. Here is a brief introduction to recording training data, as well as starting and stopping MindInsight. Before using MindInsight, the data in the training process should be recorded. When starting MindInsight, the directory of the saved data should be specified. After successful startup, the data can be viewed through the web page. Here is a brief introduction to recording training data, as well as starting and stopping MindInsight.


[SummaryCollector](https://www.mindspore.cn/api/en/master/api/python/mindspore/mindspore.train.html?highlight=summarycollector#mindspore.train.callback.SummaryCollector) is the interface MindSpore provides for a quick and easy collection of common data about computational graphs, loss values, learning rates, parameter weights, and so on. Below is an example of using `SummaryCollector` for data collection, specifying the directory where the data is stored in `./summary_dir`.
[SummaryCollector](https://www.mindspore.cn/doc/api_python/en/master/mindspore/mindspore.train.html#mindspore.train.callback.SummaryCollector) is the interface MindSpore provides for a quick and easy collection of common data about computational graphs, loss values, learning rates, parameter weights, and so on. Below is an example of using `SummaryCollector` for data collection, specifying the directory where the data is stored in `./summary_dir`.
``` ```
... ...


@@ -40,7 +40,7 @@ summary_collector = SummaryCollector(summary_dir='./summary_dir')
model.train(epoch=1, ds_train, callbacks=[summary_collector]) model.train(epoch=1, ds_train, callbacks=[summary_collector])
``` ```


For more ways to record visual data, see the [MindInsight Tutorial](https://www.mindspore.cn/tutorial/en/master/advanced_use/visualization_tutorials.html).
For more ways to record visual data, see the [MindInsight Tutorial](https://www.mindspore.cn/tutorial/training/en/master/advanced_use/visualization_tutorials.html).


After you've collected the data, when you launch MindInsight, specify the directory in which the data has been stored. After you've collected the data, when you launch MindInsight, specify the directory in which the data has been stored.
``` ```


+ 4
- 4
README_CN.md View File

@@ -16,8 +16,8 @@ MindInsight为MindSpore提供了简单易用的调优调试能力。在训练过


![MindInsight Architecture](docs/arch.png) ![MindInsight Architecture](docs/arch.png)


点击查看[设计文档](https://www.mindspore.cn/docs/zh-CN/master/design.html),了解更多设计详情。
点击查看[教程文档](https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/visualization_tutorials.html),了解更多MindInsight教程。
点击查看[设计文档](https://www.mindspore.cn/doc/note/zh-CN/master/design.html),了解更多设计详情。
点击查看[教程文档](https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/visualization_tutorials.html),了解更多MindInsight教程。


## 安装 ## 安装
请从[MindSpore下载页面](https://www.mindspore.cn/versions)下载并安装whl包。 请从[MindSpore下载页面](https://www.mindspore.cn/versions)下载并安装whl包。
@@ -32,7 +32,7 @@ pip install -U mindinsight-{version}-cp37-cp37m-linux_{arch}.whl
使用MindInsight前,需要先将训练过程中的数据记录下来,启动MindInsight时,指定所保存的数据的位置,启动成功后, 使用MindInsight前,需要先将训练过程中的数据记录下来,启动MindInsight时,指定所保存的数据的位置,启动成功后,
即可通过可视化页面查看数据。下面将简单介绍记录训练过程数据,以及启动、停止MindInsight服务。 即可通过可视化页面查看数据。下面将简单介绍记录训练过程数据,以及启动、停止MindInsight服务。


[SummaryCollector](https://www.mindspore.cn/api/zh-CN/master/api/python/mindspore/mindspore.train.html?highlight=summarycollector#mindspore.train.callback.SummaryCollector)是MindSpore提供的快速简易地收集一些常见信息的接口,收集的信息包括计算图、损失值、学习率、参数权重等。
[SummaryCollector](https://www.mindspore.cn/doc/api_python/zh-CN/master/mindspore/mindspore.train.html#mindspore.train.callback.SummaryCollector)是MindSpore提供的快速简易地收集一些常见信息的接口,收集的信息包括计算图、损失值、学习率、参数权重等。
下面是使用 `SummaryCollector` 进行数据收集的示例,其中指定存放数据的目录为 `./summary_dir`。 下面是使用 `SummaryCollector` 进行数据收集的示例,其中指定存放数据的目录为 `./summary_dir`。
``` ```
... ...
@@ -42,7 +42,7 @@ summary_collector = SummaryCollector(summary_dir='./summary_dir')
model.train(epoch=1, ds_train, callbacks=[summary_collector]) model.train(epoch=1, ds_train, callbacks=[summary_collector])
``` ```


更多记录可视化数据的方法,请点击查看[MindInsight使用教程](https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/visualization_tutorials.html)。
更多记录可视化数据的方法,请点击查看[MindInsight使用教程](https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/visualization_tutorials.html)。


收集好数据后,启动MindInsight时指定存放数据的目录。 收集好数据后,启动MindInsight时指定存放数据的目录。
``` ```


+ 1
- 1
RELEASE.md View File

@@ -122,7 +122,7 @@ Contributions of any kind are welcome!


## Major Features and Improvements ## Major Features and Improvements
* Parameter distribution graph (Histogram). * Parameter distribution graph (Histogram).
Now you can use [`HistogramSummary`](https://www.mindspore.cn/api/zh-CN/master/api/python/mindspore/mindspore.ops.operations.html#mindspore.ops.operations.HistogramSummary) and MindInsight to record and visualize distribution info of tensors. See our [tutorial](https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/visualization_tutorials.html) for details.
Now you can use [`HistogramSummary`](https://www.mindspore.cn/doc/api_python/zh-CN/master/mindspore/mindspore.ops.html#mindspore.ops.HistogramSummary) and MindInsight to record and visualize distribution info of tensors. See our [tutorial](https://www.mindspore.cn/tutorial/training/en/master/advanced_use/visualization_tutorials.html) for details.
* Lineage support Custom information * Lineage support Custom information
* GPU support * GPU support
* Model and dataset tracking linkage support * Model and dataset tracking linkage support


+ 1
- 1
mindinsight/debugger/README.md View File

@@ -20,4 +20,4 @@ In `Graph Mode` training, the computation results of intermediate nodes in the c


## Debugger Instructions ## 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)
For the details of how to use MindSpore Debugger, please refer to <https://www.mindspore.cn/tutorial/training/en/master/advanced_use/debugger.html>.

+ 1
- 1
mindinsight/debugger/README_CN.md View File

@@ -20,4 +20,4 @@ MindSpore Debugger是为图模式训练提供的调试工具,可以用来查


## Debugger使用方法 ## 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)
MindSpore Debugger的使用方法,请参考<https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/debugger.html>。

+ 13
- 13
mindinsight/mindconverter/README.md View File

@@ -4,18 +4,18 @@


<!-- TOC --> <!-- TOC -->


- [MindConverter tutorial](#mindConverter-tutorial)
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [Scenario](#scenario)
- [Example](#example)
- [AST-Based Conversion](#ast-based-conversion)
- [Graph-Based Conversion](#graph-based-conversion)
- [Caution](#caution)
- [Unsupported-situation-of-AST-mode](#unsupported-situation-of-ast-mode)
- [Situation1](#situation1)
- [Situation2](#situation2)
- [MindConverter tutorial](#mindconverter-tutorial)
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [Scenario](#scenario)
- [Example](#example)
- [AST-Based Conversion](#ast-based-conversion)
- [Graph-Based Conversion](#graph-based-conversion)
- [Caution](#caution)
- [Unsupported situation of AST mode](#unsupported-situation-of-ast-mode)
- [Situation1](#situation1)
- [Situation2](#situation2)


<!-- /TOC --> <!-- /TOC -->


@@ -124,7 +124,7 @@ In the conversion report, non-transformed code is listed as follows:
line <row>:<col> [UnConvert] 'operator' didn't convert. ... line <row>:<col> [UnConvert] 'operator' didn't convert. ...
``` ```


For non-transformed operators, the original code keeps. Please manually migrate them. [Click here](https://www.mindspore.cn/docs/en/master/index.html#operator_api) for more information about operator mapping.
For non-transformed operators, the original code keeps. Please manually migrate them. [Click here](https://www.mindspore.cn/doc/note/en/master/specification_note.html#operator_api) for more information about operator mapping.




Here is an example of the conversion report: Here is an example of the conversion report:


+ 13
- 13
mindinsight/mindconverter/README_CN.md View File

@@ -4,18 +4,18 @@


<!-- TOC --> <!-- TOC -->


- [MindConverter教程](#MindConverter教程)
- [概述](#概述)
- [安装](#安装)
- [用法](#用法)
- [使用场景](#使用场景)
- [使用示例](#使用示例)
- [基于AST的脚本转换示例](#基于AST的脚本转换示例)
- [基于图结构的脚本生成示例](#基于图结构的脚本生成示例)
- [注意事项](#注意事项)
- [AST方案不支持场景](#AST方案不支持场景)
- [场景1](#场景1)
- [场景1](#场景2)
- [MindConverter教程](#mindconverter教程)
- [概述](#概述)
- [安装](#安装)
- [命令行用法](#命令行用法)
- [使用场景](#使用场景)
- [使用示例](#使用示例)
- [基于AST的脚本转换示例](#基于ast的脚本转换示例)
- [基于图结构的脚本生成示例](#基于图结构的脚本生成示例)
- [注意事项](#注意事项)
- [AST方案不支持场景](#ast方案不支持场景)
- [场景1](#场景1)
- [场景2](#场景2)


<!-- /TOC --> <!-- /TOC -->


@@ -107,7 +107,7 @@ mindconverter --in_file /home/user/model.py \
--report /home/user/output/report --report /home/user/output/report
``` ```


转换报告中,对于未转换的代码行形式为如下,其中x, y指明的是原PyTorch脚本中代码的行、列号。对于未成功转换的算子,可参考[MindSporeAPI映射查询功能](https://www.mindspore.cn/docs/zh-CN/master/index.html#operator_api) 手动对代码进行迁移。对于工具无法迁移的算子,会保留原脚本中的代码。
转换报告中,对于未转换的代码行形式为如下,其中x, y指明的是原PyTorch脚本中代码的行、列号。对于未成功转换的算子,可参考[MindSporeAPI映射查询功能](https://www.mindspore.cn/doc/note/zh-CN/master/specification_note.html#operator_api) 手动对代码进行迁移。对于工具无法迁移的算子,会保留原脚本中的代码。


```text ```text
line x:y: [UnConvert] 'operator' didn't convert. ... line x:y: [UnConvert] 'operator' didn't convert. ...


+ 4
- 4
mindinsight/profiler/README_GPU.md View File

@@ -2,7 +2,7 @@
<!-- TOC --> <!-- TOC -->
- [性能调试(GPU)](#性能调试(GPU))
- [性能调试(GPU)](#性能调试gpu)
- [概述](#概述) - [概述](#概述)
- [操作流程](#操作流程) - [操作流程](#操作流程)
- [准备训练脚本](#准备训练脚本) - [准备训练脚本](#准备训练脚本)
@@ -19,7 +19,7 @@
> 操作流程可以参考Ascend 910上profiler的操作: > 操作流程可以参考Ascend 910上profiler的操作:
> >
> https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/performance_profiling.html#id3
> https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/performance_profiling.html#id3
## 准备训练脚本 ## 准备训练脚本
@@ -29,11 +29,11 @@
> 样例代码与Ascend使用方式一致可以参考: > 样例代码与Ascend使用方式一致可以参考:
> >
> https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/performance_profiling.html#id4
> https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/performance_profiling.html#id4
## 启动MindInsight ## 启动MindInsight
启动命令请参考[MindInsight相关命令](https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/mindinsight_commands.html)。
启动命令请参考[MindInsight相关命令](https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/mindinsight_commands.html)。
### 性能分析 ### 性能分析


+ 9
- 9
mindinsight/ui/src/locales/en-us.json View File

@@ -73,13 +73,13 @@
"dataProcessTipSecond": "to display the data processing and augmentation information of single model training.", "dataProcessTipSecond": "to display the data processing and augmentation information of single model training.",
"imageTipFirst": "specified image ", "imageTipFirst": "specified image ",
"imageTipSecond": "for display.", "imageTipSecond": "for display.",
"guidUrl": "https://www.mindspore.cn/tutorial/en/master/advanced_use/summary_record.html",
"scalarUrl": "https://www.mindspore.cn/tutorial/en/master/advanced_use/dashboard.html#scalar-visualization",
"histogramUrl": "https://www.mindspore.cn/tutorial/en/master/advanced_use/dashboard.html#parameter-distribution-visualization",
"tensorUrl": "https://www.mindspore.cn/tutorial/en/master/advanced_use/dashboard.html#tensor-visualization",
"graphUrl": "https://www.mindspore.cn/tutorial/en/master/advanced_use/dashboard.html#computational-graph-visualization",
"dataProcessUrl": "https://www.mindspore.cn/tutorial/en/master/advanced_use/dashboard.html#dataset-graph-visualization",
"imageUrl": "https://www.mindspore.cn/tutorial/en/master/advanced_use/dashboard.html#image-visualization"
"guidUrl": "https://www.mindspore.cn/tutorial/training/en/master/advanced_use/summary_record.html",
"scalarUrl": "https://www.mindspore.cn/tutorial/training/en/master/advanced_use/dashboard.html#scalar-visualization",
"histogramUrl": "https://www.mindspore.cn/tutorial/training/en/master/advanced_use/dashboard.html#parameter-distribution-visualization",
"tensorUrl": "https://www.mindspore.cn/tutorial/training/en/master/advanced_use/dashboard.html#tensor-visualization",
"graphUrl": "https://www.mindspore.cn/tutorial/training/en/master/advanced_use/dashboard.html#computational-graph-visualization",
"dataProcessUrl": "https://www.mindspore.cn/tutorial/training/en/master/advanced_use/dashboard.html#dataset-graph-visualization",
"imageUrl": "https://www.mindspore.cn/tutorial/training/en/master/advanced_use/dashboard.html#image-visualization"
}, },
"modelTraceback": { "modelTraceback": {
"summaryPath": "Summary Path", "summaryPath": "Summary Path",
@@ -298,10 +298,10 @@
"desc": "How Do I Use Profiler for Profiling?", "desc": "How Do I Use Profiler for Profiling?",
"anchor": ["desc"], "anchor": ["desc"],
"url": [ "url": [
"https://www.mindspore.cn/tutorial/en/master/advanced_use/performance_profiling.html"
"https://www.mindspore.cn/tutorial/training/en/master/advanced_use/performance_profiling.html"
], ],
"gpuUrl": [ "gpuUrl": [
"https://www.mindspore.cn/tutorial/en/master/advanced_use/performance_profiling_gpu.html"
"https://www.mindspore.cn/tutorial/training/en/master/advanced_use/performance_profiling_gpu.html"
] ]
}, },
"step_trace-proposer_type_label": { "step_trace-proposer_type_label": {


+ 9
- 9
mindinsight/ui/src/locales/zh-cn.json View File

@@ -73,13 +73,13 @@
"dataProcessTipSecond": "以供展示单次模型训练的数据处理和数据增强信息。", "dataProcessTipSecond": "以供展示单次模型训练的数据处理和数据增强信息。",
"imageTipFirst": "指定图片", "imageTipFirst": "指定图片",
"imageTipSecond": "以供展示。", "imageTipSecond": "以供展示。",
"guidUrl": "https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/summary_record.html",
"scalarUrl": "https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/dashboard.html#id3",
"histogramUrl": "https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/dashboard.html#id4",
"tensorUrl": "https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/dashboard.html#id8",
"graphUrl": "https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/dashboard.html#id5",
"dataProcessUrl": "https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/dashboard.html#id6",
"imageUrl": "https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/dashboard.html#id7"
"guidUrl": "https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/summary_record.html",
"scalarUrl": "https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/dashboard.html#id3",
"histogramUrl": "https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/dashboard.html#id4",
"tensorUrl": "https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/dashboard.html#id8",
"graphUrl": "https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/dashboard.html#id5",
"dataProcessUrl": "https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/dashboard.html#id6",
"imageUrl": "https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/dashboard.html#id7"
}, },
"modelTraceback": { "modelTraceback": {
"summaryPath": "训练日志路径", "summaryPath": "训练日志路径",
@@ -297,10 +297,10 @@
"desc": "如何使用Profiler进行性能分析", "desc": "如何使用Profiler进行性能分析",
"anchor": ["desc"], "anchor": ["desc"],
"url": [ "url": [
"https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/performance_profiling.html"
"https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/performance_profiling.html"
], ],
"gpuUrl": [ "gpuUrl": [
"https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/performance_profiling_gpu.html"
"https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/performance_profiling_gpu.html"
] ]
}, },
"step_trace-proposer_type_label": { "step_trace-proposer_type_label": {


+ 1
- 1
mindinsight/wizard/conf/templates/network/alexnet/README.md-tpl View File

@@ -90,7 +90,7 @@ bash run_distribute_train.sh rank_table.json ~/cifar-10-batches-bin
bash run_standalone_train.sh ~/cifar-10-batches-bin bash run_standalone_train.sh ~/cifar-10-batches-bin
``` ```


> About rank_table.json, you can refer to the [distributed training tutorial](https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/distributed_training_ascend.html).
> About rank_table.json, you can refer to the [distributed training tutorial](https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/distributed_training_ascend.html).


##### Result ##### Result




+ 1
- 1
mindinsight/wizard/conf/templates/network/lenet/README.md-tpl View File

@@ -75,7 +75,7 @@ bash run_distribute_train.sh rank_table.json ~/MNIST_data
bash run_standalone_train.sh ~/MNIST_data bash run_standalone_train.sh ~/MNIST_data
``` ```


> About rank_table.json, you can refer to the [distributed training tutorial](https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/distributed_training_ascend.html).
> About rank_table.json, you can refer to the [distributed training tutorial](https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/distributed_training_ascend.html).


##### Result ##### Result




+ 1
- 1
mindinsight/wizard/conf/templates/network/resnet50/README.md-tpl View File

@@ -91,7 +91,7 @@ bash run_distribute_train.sh rank_table.json ~/cifar-10-batches-bin
bash run_standalone_train.sh ~/cifar-10-batches-bin bash run_standalone_train.sh ~/cifar-10-batches-bin
``` ```


> About rank_table.json, you can refer to the [distributed training tutorial](https://www.mindspore.cn/tutorial/zh-CN/master/advanced_use/distributed_training_ascend.html).
> About rank_table.json, you can refer to the [distributed training tutorial](https://www.mindspore.cn/tutorial/training/zh-CN/master/advanced_use/distributed_training_ascend.html).


##### Result ##### Result




Loading…
Cancel
Save