MindSpore文档

View English

简介

此工程提供MindSpore官方网站https://www.mindspore.cn所呈现安装指南、教程、文档的源文件以及API的相关配置。

贡献

我们非常欢迎您贡献文档！如果想要参与，请阅读CONTRIBUTING_DOC_CN.md，务必遵守文档写作规范，并按照流程规则提交，审核通过后，改动会在文档工程和官网中呈现。

同时，如果您对文档有任何意见或建议，请在Issues中提交。

目录结构说明

docs
├───activity // 活动体验记录
|
├───docs // 架构、网络和算子支持等技术文档以及用于生成API的相关配置文件
|    |
|    ├───federated // MindSpore Federated（API工程、相关文档和常见问题）
|    |
|    ├───hub // MindSpore Hub（API工程和相关文档）
|    |
|    ├───lite // MindSpore Lite（API工程、相关文档和常见问题）
|    |
|    ├───mindarmour // MindArmour（API工程、相关文档和常见问题）
|    |
|    ├───mindinsight // MindInsight（相关文档和常见问题）
|    |
|    ├───mindquantum // MindQuantum（API工程和相关文档）
|    |
|    ├───mindspore // MindSpore（API工程、常见问题、迁移指南、说明）
|    |
|    ├───notebook // 体验式文档
|    |
|    ├───probability // MindSpore Probability（API工程和相关文档）
|    |
|    ├───sample_code // 文档对应样例代码
|    |
|    └───serving // MindSpore Serving（API工程、相关文档和常见问题）
|
│───install // 安装指南
|
│───resource // 资源相关文档
|
│───tools // 自动化工具
|
│───tutorials // MindSpore教程相关文档
|
└───README_CN.md // Docs仓说明

文档构建

MindSpore的教程和API文档均可由Sphinx工具生成，构建MindSpore、MindSpore Hub、MindArmour或MindQuantum的API文档之前需完成对应模块的安装。下面以MindSpore Python API文档为例介绍具体步骤，操作前需完成MindSpore的安装。

1. 使用pip安裝MindSpore模块，API文档需要根据安装后的MindSpore模块生成，参考安装。

   pip install mindspore-1.5.0-cp37-cp37m-linux_x86_64.whl

2. 下载MindSpore Docs仓代码。

   git clone https://gitee.com/mindspore/docs.git -b r1.7

3. 进入api目录，安装该目录下requirements.txt文件中的依赖项。

   cd docs/mindspore/api
   pip install -r requirements.txt

4. 在api目录下执行如下命令，完成后会新建build_zh_cn/html目录，该目录中存放了生成后的文档网页，打开build_zh_cn/html/index.html即可查看API文档内容。

   make html

• 构建MindSpore教程、迁移指南文档、深度概率编程文档和MindQuantum文档时还需安装pandoc，下载和安装pandoc请参考https://pandoc.org/installing.html。

• 构建MindSpore和Lite的API时，由于需要使用到一些mindspore仓的资源文件，先克隆mindspore仓，并加入环境变量MS_PATH，构建Lite的API时还需要安装Doxygen：

  git clone https://gitee.com/mindspore/mindspore.git -b r1.7 {MS_REPO PATH}
  sudo apt install doxygen
  export MS_PATH={MS_REPO PATH}

  其中{MS_REPO PATH}为克隆的mindspore仓路径。

• 构建MindInsight的API时，由于需要使用到一些mindinsight仓的资源文件，先克隆mindinsight仓，并加入环境变量MI_PATH：

  git clone https://gitee.com/mindspore/mindinsight.git -b r1.7 {MI_REPO PATH}
  export MI_PATH={MI_REPO PATH}

  其中{MI_REPO PATH}为克隆的mindinsight仓路径。

• 构建MindArmour的API时，由于需要使用到一些mindarmour仓的资源文件，先克隆mindarmour仓，并加入环境变量MA_PATH：

  git clone https://gitee.com/mindspore/mindarmour.git -b r1.7 {MA_REPO PATH}
  export MA_PATH={MA_REPO PATH}

  其中{MA_REPO PATH}为克隆的mindarmour仓路径。

• 构建MindQuantum的API时，由于需要使用到一些mindquantum仓的资源文件，先克隆mindquantum仓，并加入环境变量MQ_PATH：

  git clone https://gitee.com/mindspore/mindquantum.git -b r1.7 {MQ_REPO PATH}
  export MQ_PATH={MQ_REPO PATH}

  其中{MQ_REPO PATH}为克隆的mindquantum仓路径。

• 构建Reinforcement的API时，由于需要使用到一些reinforcement仓的资源文件，先克隆reinforcement仓，并加入环境变量RM_PATH：

  git clone https://gitee.com/mindspore/reinforcement.git -b r1.7 {RM_REPO PATH}
  export RM_PATH={RM_REPO PATH}

  其中{RM_REPO PATH}为克隆的reinforcement仓路径。

• 构建Serving的API时，由于需要使用到一些serving仓的资源文件，先克隆serving仓，并加入环境变量SV_PATH：

  git clone https://gitee.com/mindspore/serving.git -b r1.7 {SV_REPO PATH}
  export SV_PATH={SV_REPO PATH}

  其中{SV_REPO PATH}为克隆的serving仓路径。

• 构建Vision的API时，由于需要使用到一些vision仓的资源文件，先克隆vision仓，并加入环境变量VS_PATH：

  git clone https://gitee.com/mindspore/vision.git -b r1.7 {VS_REPO PATH}
  export VS_PATH={VS_REPO PATH}

  其中{VS_REPO PATH}为克隆的vision仓路径。

版权

• Apache License 2.0
• Creative Commons License version 4.0