From dc7582922f9de3db599c6698044031519f9ea21d Mon Sep 17 00:00:00 2001 From: leonwanghui Date: Tue, 7 Apr 2020 10:15:01 +0800 Subject: [PATCH] Fix some format errors Signed-off-by: leonwanghui --- CONTRIBUTING_DOC.md | 8 ++++---- README.md | 10 +++++----- install/mindspore_cpu_install.md | 3 +-- install/mindspore_cpu_install_en.md | 4 ++-- install/mindspore_d_install.md | 16 ++++++++-------- install/mindspore_d_install_en.md | 16 ++++++++-------- install/mindspore_gpu_install.md | 1 - install/mindspore_gpu_install_en.md | 6 ++---- resource/release/release_list_en.md | 7 ++----- resource/release/release_list_zh_cn.md | 9 ++++----- resource/statement/en/legal_statement.md | 1 - resource/statement/en/privacy_policy.md | 2 +- resource/statement/zh_cn/legal_statement.md | 1 - resource/statement/zh_cn/privacy_policy.md | 2 +- 14 files changed, 38 insertions(+), 48 deletions(-) diff --git a/CONTRIBUTING_DOC.md b/CONTRIBUTING_DOC.md index e600fc888c..93f03a5a9a 100644 --- a/CONTRIBUTING_DOC.md +++ b/CONTRIBUTING_DOC.md @@ -45,17 +45,17 @@ The procedure for submitting the modification is the same as that for submitting ``` > Precautions - ``` + ``` - References should be listed at the end of the document and marked in the document. - + ``` Add a [number] after the referenced text or image description. ## References [1] Author. [Document Name](http://xxx). - + [2] Author. Document Name. ``` @@ -87,4 +87,4 @@ The procedure for submitting the modification is the same as that for submitting Figure 1: xxx The following content. - ``` \ No newline at end of file + ``` diff --git a/README.md b/README.md index 700e3c469b..9957788d3a 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,15 @@ If you have any comments or suggestions on the documents, submit them in Issues. ``` docs ├───api // Configuration files for API generation. -│ +│ ├───docs // Introduction to documents. -│ +│ ├───install // Installation guide. -│ +│ ├───resource // Resource-related documents. -│ +│ ├───tutorials // Tutorial-related documents. -│ +│ └───README.md // Docs repository description. ``` diff --git a/install/mindspore_cpu_install.md b/install/mindspore_cpu_install.md index 8681979ad4..2b2820fd49 100644 --- a/install/mindspore_cpu_install.md +++ b/install/mindspore_cpu_install.md @@ -49,7 +49,7 @@ ```bash git clone https://gitee.com/mindspore/mindspore.git ``` - + 2. 在源码根目录下执行如下命令编译MindSpore。 ```bash @@ -108,4 +108,3 @@ ```bash python -c 'import mindarmour' ``` - diff --git a/install/mindspore_cpu_install_en.md b/install/mindspore_cpu_install_en.md index 12ce0ff9f9..05361b5daa 100644 --- a/install/mindspore_cpu_install_en.md +++ b/install/mindspore_cpu_install_en.md @@ -49,7 +49,7 @@ This document describes how to quickly install MindSpore on a CPU environment. ```bash git clone https://gitee.com/mindspore/mindspore.git ``` - + 2. Run the following command in the root directory of the source code to compile MindSpore: ```bash @@ -71,6 +71,7 @@ This document describes how to quickly install MindSpore on a CPU environment. ```bash python -c 'import mindspore' ``` + # Installing MindArmour If you need to conduct AI model security research or enhance the security of the model in you applications, you can install MindArmour. @@ -108,4 +109,3 @@ If you need to conduct AI model security research or enhance the security of the ```bash python -c 'import mindarmour' ``` - diff --git a/install/mindspore_d_install.md b/install/mindspore_d_install.md index 1cd65d583a..b7a85377af 100644 --- a/install/mindspore_d_install.md +++ b/install/mindspore_d_install.md @@ -26,7 +26,7 @@ - Ascend 910 AI处理器 > - 申请方式：填写[申请表](https://www.mindspore.cn/table)发送至contact@mindspore.cn，审核通过即可获取云上资源。 - > - 需为每张卡预留至少32G内存。 + > - 需为每张卡预留至少32G内存。 ### 系统要求和软件依赖 @@ -74,7 +74,7 @@ ```bash git clone https://gitee.com/mindspore/mindspore.git ``` - + 2. 在源码根目录下，执行如下命令编译MindSpore。 ```bash @@ -94,7 +94,7 @@ ## 配置环境变量 - 安装好MindSpore之后，需要导出Runtime相关环境变量。 - + ```bash # control log level. 0-DEBUG, 1-INFO, 2-WARNING, 3-ERROR, default level is WARNING. export GLOG_v=2 @@ -111,7 +111,7 @@ ## 安装验证 - 安装并配置好环境变量后，执行如下python脚本： - + ```bash import numpy as np from mindspore import Tensor @@ -123,7 +123,7 @@ y = Tensor(np.ones([1,3,3,4]).astype(np.float32)) print(F.tensor_add(x, y)) ``` - + - 若出现如下结果，即安装验证通过。 ``` @@ -173,16 +173,16 @@ pip install -r requirements.txt python setup.py install ``` - + (2) 构建whl包进行安装。 - + 进入源码的build目录，执行MindInsight编译脚本。 ```bash cd mindinsight/build bash build.sh ``` - + 进入源码的output目录，即可查看生成的MindInsight安装包，执行安装命令。 ```bash diff --git a/install/mindspore_d_install_en.md b/install/mindspore_d_install_en.md index 7439bfc76d..4c5b2810d0 100644 --- a/install/mindspore_d_install_en.md +++ b/install/mindspore_d_install_en.md @@ -24,8 +24,8 @@ This document describes how to quickly install MindSpore on an Ascend AI process ### Hardware Requirements - Ascend 910 AI processor - - > - Reserve at least 32 GB memory for each card. + + > - Reserve at least 32 GB memory for each card. ### System Requirements and Software Dependencies @@ -73,7 +73,7 @@ The compilation and installation must be performed on the Ascend 910 AI processo ```bash git clone https://gitee.com/mindspore/mindspore.git ``` - + 2. Run the following command in the root directory of the source code to compile MindSpore: ```bash @@ -93,7 +93,7 @@ The compilation and installation must be performed on the Ascend 910 AI processo ## Configuring Environment Variables - After MindSpore is installed, export runtime-related environment variables. - + ```bash # control log level. 0-DEBUG, 1-INFO, 2-WARNING, 3-ERROR, default level is WARNING. export GLOG_v=2 @@ -110,7 +110,7 @@ The compilation and installation must be performed on the Ascend 910 AI processo ## Installation Verification - After configuring the environment variables, execute the following Python script： - + ```bash import numpy as np from mindspore import Tensor @@ -172,16 +172,16 @@ If you need to analyze information such as model scalars, graphs, and model trac pip install -r requirements.txt python setup.py install ``` - + (2) Create a .whl package to install MindInsight. - + Access the build directory of the source code and run the MindInsight compilation script. ```bash cd mindinsight/build bash build.sh ``` - + Access the output directory of the source code, where the generated MindInsight installation package is stored, and run the installation command. ```bash diff --git a/install/mindspore_gpu_install.md b/install/mindspore_gpu_install.md index 205a77d61b..edd98090fc 100644 --- a/install/mindspore_gpu_install.md +++ b/install/mindspore_gpu_install.md @@ -139,4 +139,3 @@ ```bash python -c 'import mindarmour' ``` - diff --git a/install/mindspore_gpu_install_en.md b/install/mindspore_gpu_install_en.md index f9f7db7539..16c98d944f 100644 --- a/install/mindspore_gpu_install_en.md +++ b/install/mindspore_gpu_install_en.md @@ -74,7 +74,7 @@ This document describes how to quickly install MindSpore on a NVIDIA GPU environ ## Installation Verification - After Installation, execute the following Python script： - + ```bash import numpy as np from mindspore import Tensor @@ -86,7 +86,7 @@ This document describes how to quickly install MindSpore on a NVIDIA GPU environ y = Tensor(np.ones([1,3,3,4]).astype(np.float32)) print(F.tensor_add(x, y)) ``` - + - The outputs should be same as: ```bash @@ -134,10 +134,8 @@ If you need to conduct AI model security research or enhance the security of the python setup.py install ``` - 3. Run the following command. If no loading error message such as `No module named 'mindarmour'` is displayed, the installation is successful. ```bash python -c 'import mindarmour' ``` - diff --git a/resource/release/release_list_en.md b/resource/release/release_list_en.md index 86f922aaee..95bf94833f 100644 --- a/resource/release/release_list_en.md +++ b/resource/release/release_list_en.md @@ -37,14 +37,13 @@ | | | EulerOS-aarch64 | | f354fcdbb3d8b4022fda5a6636e763f8091aca2167dc23e60b7f7b6d710523cb | | | GPU CUDA 9.2/GPU CUDA 10.1/CPU | Ubuntu-x86 | | 7796b6c114ee4962ce605da59a9bc47390c8910acbac318ecc0598829aad6e8c | - ### Tutorials ### API - + ### Docs @@ -58,10 +57,8 @@ ### API - + ### Docs - - diff --git a/resource/release/release_list_zh_cn.md b/resource/release/release_list_zh_cn.md index 550b41ab52..3f8182870c 100644 --- a/resource/release/release_list_zh_cn.md +++ b/resource/release/release_list_zh_cn.md @@ -35,12 +35,11 @@ | | | EulerOS-aarch64 | | f354fcdbb3d8b4022fda5a6636e763f8091aca2167dc23e60b7f7b6d710523cb | | | GPU CUDA 9.2/GPU CUDA 10.1/CPU | Ubuntu-x86 | | 7796b6c114ee4962ce605da59a9bc47390c8910acbac318ecc0598829aad6e8c | - ### 教程 ### API - + ### 文档 @@ -49,9 +48,9 @@ ### 教程 + ### API - + + ### 文档 - - diff --git a/resource/statement/en/legal_statement.md b/resource/statement/en/legal_statement.md index febf853782..48e4cb535e 100644 --- a/resource/statement/en/legal_statement.md +++ b/resource/statement/en/legal_statement.md @@ -22,4 +22,3 @@ All logos and trademarks used on this website () belon ## Third-Party Links This website () may contain links to third party sites. Access to any other Internet site linked to this website is at the user's own risk and MindSpore open source project is not responsible for the accuracy or reliability of any information, data, opinions, suggestions or statements made on these sites. MindSpore open source project provides these links merely as a convenience and the inclusion of such links does not imply an endorsement, recommendation, or advertisement. - diff --git a/resource/statement/en/privacy_policy.md b/resource/statement/en/privacy_policy.md index 9dcce41ab3..b7bff51f10 100644 --- a/resource/statement/en/privacy_policy.md +++ b/resource/statement/en/privacy_policy.md @@ -46,4 +46,4 @@ You can manage or delete cookies based on your preferences. For details, see [Ab If you have any questions, contact us at contact@mindspore.cn. -Last update: March, 2020 \ No newline at end of file +Last update: March, 2020 diff --git a/resource/statement/zh_cn/legal_statement.md b/resource/statement/zh_cn/legal_statement.md index 0e4a9cbb02..4e22e26da7 100644 --- a/resource/statement/zh_cn/legal_statement.md +++ b/resource/statement/zh_cn/legal_statement.md @@ -22,4 +22,3 @@ MindSpore开源项目网站上使用和显示的所有商标、标志皆属MindS ## 第三方链接 MindSpore开源项目网站可能保留有与第三方网站或网址的链接，访问这些链接将由用户自己作出决定，MindSpore开源项目并不保证这些链接上所提供的任何信息、数据、观点、图片、陈述或建议的准确性、完整性、充分性和可靠性。MindSpore开源项目提供这些链接仅仅在于提供方便，并不表示MindSpore开源项目对这些信息的认可和推荐，也不是用于宣传或广告目的。 - diff --git a/resource/statement/zh_cn/privacy_policy.md b/resource/statement/zh_cn/privacy_policy.md index a8537aba63..e17a9cea9e 100644 --- a/resource/statement/zh_cn/privacy_policy.md +++ b/resource/statement/zh_cn/privacy_policy.md @@ -46,4 +46,4 @@ 如您有任何疑问，可通过contact@mindspore.cn联系我们。 -最近更新时间：2020年3月 \ No newline at end of file +最近更新时间：2020年3月 -- Gitee