Skip to content

README_CN.md

Latest commit

 

History

History
164 lines (129 loc) · 5.98 KB

README_CN.md

File metadata and controls

164 lines (129 loc) · 5.98 KB
Raw

MindSpore文档

MindSpore Logo

View English

简介

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

贡献

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

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

目录结构说明

docs
├───activity // 活动体验记录
|
├───docs // 设计、规格、FAQ等技术文档，以及用于生成API的相关配置文件
|    |
|    ├───golden_stick // MindSpore Golden Stick文档
|    |
|    ├───lite // MindSpore Lite文档
|    |
|    ├───mindarmour // MindSpore Armour文档
|    |
|    ├───mindchemistry // MindSpore Chemistry文档
|    |
|    ├───mindearth // MindSpore Earth文档
|    |
|    ├───mindelec // MindSpore Elec文档
|    |
|    ├───mindflow // MindSpore Flow文档
|    |
|    ├───mindformers // MindSpore Transformers文档
|    |
|    ├───mindquantum // MindSpore Quantum文档
|    |
|    ├───mindscience // MindScience文档
|    |
|    ├───mindsponge // MindSpore SPONGE文档
|    |
|    ├───mindspore // MindSpore文档
|    |
|    ├───sample_code // 文档对应样例代码
|    |
|    ├───sciai // MindSpore SciAI文档
|    |
|    └───vllm_mindspore // vLLM-MindSpore Plugin文档
|
│───install // 安装指南
|
│───resource // 资源相关文档
|
│───templates // 文档模板和样例
|
│───tools // 自动化工具
|
│───tutorials // MindSpore教程相关文档
|
│───CODEOWNERS //  Maintainer列表
|
│───CONTRIBUTING_DOC.md //  贡献文档英文版
|
│───CONTRIBUTING_DOC_CN.md //  贡献文档中文版
|
│───LICENSE //  LICENSE文档
|
│───NOTICE //  NOTICE文档
|
│───README.md //  Docs仓说明英文版
|
└───README_CN.md // Docs仓说明中文版

文档构建

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

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

    pip install mindspore-*.*.*-cp39-cp39m-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等不同仓的API时，由于会使用到对应不同仓的一些资源文件，需要先克隆对应仓，并配置环境变量，给出以下配置列表供使用：

    对应API的生成 环境变量 仓库链接 仓库名
    MindSpore MS_PATH https://gitee.com/mindspore/mindspore.git mindspore
    MindSpore Lite MSL_PATH https://gitee.com/mindspore/mindspore-lite.git mindspore_lite
    MindSpore Transformers MFM_PATH https://gitee.com/mindspore/mindformers.git mindformers
    MindSpore Golden Stick GS_PATH https://gitee.com/mindspore/golden-stick.git golden_stick
    MindSpore Quantum MQ_PATH https://gitee.com/mindspore/mindquantum.git mindquantum
    MindScience MSC_PATH https://gitee.com/mindspore/mindscience.git mindscience

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

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

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

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

    其中，发布包需要同时包含端侧和云侧，并按以下方式存放：

    LITE_PACKAGE_PATH
├───mindspore-lite-*.*.*-linux-x64.tar.gz
|
└───cloud_fusion
       |
       └───mindspore-lite-*.*.*-linux-x64.tar.gz

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

版权