Skip to content

Latest commit

 

History

History
172 lines (139 loc) · 6.89 KB

README_CN.md

File metadata and controls

172 lines (139 loc) · 6.89 KB
Raw

MindSpore文档

MindSpore Logo

View English

简介

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

贡献

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

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

目录结构说明

docs
├───activity // 活动体验记录
|
├───docs // 设计、规格、FAQ等技术文档，以及用于生成API的相关配置文件
|    |
|    ├───devtoolkit // MindSpore Dev Toolkit文档
|    |
|    ├───federated // MindSpore Federated文档
|    |
|    ├───golden_stick // MindSpore Golden Stick文档
|    |
|    ├───graphlearning // MindSpore Graph Learning文档
|    |
|    ├───hub // MindSpore Hub文档
|    |
|    ├───lite // MindSpore Lite文档
|    |
|    ├───mindarmour // MindArmour文档
|    |
|    ├───mindearth // MindEarth文档
|    |
|    ├───mindflow // MindFlow文档
|    |
|    ├───mindelec // MindElec文档
|    |
|    ├───mindinsight // MindInsight文档
|    |
|    ├───mindpandas // MindPandas文档
|    |
|    ├───mindquantum // MindQuantum文档
|    |
|    ├───mindscience // MindScience文档
|    |
|    ├───mindsponge // MindSPONGE文档
|    |
|    ├───mindspore // MindSpore文档
|    |
|    ├───mindformers // mindformers文档
|    |
|    ├───probability // MindSpore Probability文档
|    |
|    ├───recommender // MindSpore Recommender文档
|    |
|    ├───reinforcement // MindSpore Reinforcement文档
|    |
|    ├───sample_code // 文档对应样例代码
|    |
|    ├───sciai // MindSpore SciAI文档
|    |
|    ├───serving // MindSpore Serving文档
|    |
|    └───xai // MindSpore XAI文档
|
│───install // 安装指南
|
│───templates // 文档模板和样例
|
│───resource // 资源相关文档
|
│───tools // 自动化工具
|
│───tutorials // MindSpore教程相关文档
|
│───CONTRIBUTING_DOC_CN.md //  贡献文档
|
└───README_CN.md // Docs仓说明

文档构建

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

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

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

  2. 下载MindSpore Docs仓代码。

    git clone https://gitee.com/mindspore/docs.git

  3. 进入API所在目录docs/mindspore，安装该目录下requirements.txt文件中的依赖项。

    cd docs/mindspore
pip install -r requirements.txt

  4. 在API所在目录docs/mindspore下打开配置文件Makefile，根据要生成文档的语言进行配置。其中SOURCEDIR指源文件夹，BUILDDIR指构建完成后文档的文件夹名称。

    SOURCEDIR     = source_zh_cn
BUILDDIR      = build_zh_cn
    • 构建中文文档，将SOURCEDIR配置成source_zh_cn，将BUILDDIR配置成build_zh_cn。
    • 构建英文文档，将SOURCEDIR配置成source_en，将BUILDDIR配置成build_en。

  5. 文件Makefile配置完成后，在API所在目录docs/mindspore下执行如下命令进行文档构建：

    make html
    • 中文构建：完成后会新建build_zh_cn/html目录，该目录中存放了生成后的中文文档网页，打开build_zh_cn/html/index.html即可查看API文档内容。
    • 英文构建：完成后会新建build_en/html目录，该目录中存放了生成后的英文文档网页，打开build_en/html/index.html即可查看API文档内容。

注意事项

  1. 构建MindSpore、MindInsight、MindQuantum等不同仓的API时，由于会使用到对应不同仓的一些资源文件，需要先克隆对应仓，并配置环境变量，给出以下配置列表供使用：

    对应API的生成 环境变量 仓库链接 仓库名
    MindSpore/ MindSpore Lite MS_PATH https://gitee.com/mindspore/mindspore.git mindspore
    MindInsight MI_PATH https://gitee.com/mindspore/mindinsight.git mindinsight
    MindArmour MA_PATH https://gitee.com/mindspore/mindarmour.git mindarmour
    MindQuantum MQ_PATH https://gitee.com/mindspore/mindquantum.git mindquantum
    Reinforcement RM_PATH https://github.com/mindspore-lab/mindrl.git mindrl
    Serving SV_PATH https://gitee.com/mindspore/serving.git serving
    Hub HB_PATH https://gitee.com/mindspore/hub.git hub
    XAI XA_PATH https://gitee.com/mindspore/xai.git xai
    Golden Stick GS_PATH https://gitee.com/mindspore/golden-stick.git golden_stick
    DevToolkit DT_PATH https://gitee.com/mindspore/ide-plugin.git devtoolkit
    Federated MF_PATH https://gitee.com/mindspore/federated.git federated
    MindPandas MP_PATH https://gitee.com/mindspore/mindpandas.git mindpandas
    MindScience MSC_PATH https://gitee.com/mindspore/mindscience.git mindscience
    Recommender RD_PATH https://gitee.com/mindspore/recommender.git recommender
    Graphlearning GL_PATH https://gitee.com/mindspore/graphlearning.git graphlearning
    MindFormers MFM_PATH https://gitee.com/mindspore/mindformers.git mindformers

    克隆仓库以及设置环境变量的代码如下：

    git clone 仓库链接
export 环境变量 = 对应克隆仓在本地的路径

  2. 构建Lite的API时，还需要安装Doxygen，且要下载最新的Lite tar包，并将本地的包路径配置到LITE_PACKAGE_PATH环境变量：

    sudo apt install doxygen
export LITE_PACKAGE_PATH = 本地的Lite包路径

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

版权