• MindSpore Documents
• • Overview
  • Contributions
  • Directory Structure Description
  • Document Construction
  • • Note
  • License

MindSpore Documents

查看中文

Overview

This project provides the source files of the installation guide, tutorials, and other documents, as well as API configurations on the MindSpore official website https://www.mindspore.cn.

Contributions

You are welcome to contribute documents. If you want to contribute documents, read the CONTRIBUTING_DOC.md. Please comply with the document writing specifications, and submit documents according to the process rules. After the documents are approved, the changes will be displayed in the document project and on the official website.

If you have any comments or suggestions on the documents, submit them in Issues.

Directory Structure Description

docs
├───activity // Record the activity experience.
|
├───docs // Technical documents about design, specification and so on. Configuration files for API generation.
|    |
|    ├───golden_stick // MindSpore Golden Stick Documents
|    |
|    ├───lite // MindSpore Lite Documents
|    |
|    ├───mindarmour // MindSpore Armour Documents
|    |
|    ├───mindchemistry // MindSpore Chemistry Documents
|    |
|    ├───mindearth // MindSpore Earth Documents
|    |
|    ├───mindelec // MindSpore Elec Documents
|    |
|    ├───mindflow // MindSpore Flow Documents
|    |
|    ├───mindformers // MindSpore Transformers Documents
|    |
|    ├───mindquantum // MindSpore Quantum Documents
|    |
|    ├───mindscience // MindScience Documents
|    |
|    ├───mindsponge // MindSpore SPONGE Documents
|    |
|    ├───mindspore // MindSpore Documents
|    |
|    ├───sample_code // Document corresponding sample code
|    |
|    ├───sciai // MindSpore SciAI Documents
|    |
|    └───vllm_mindspore // vLLM-MindSpore Plugin Documents
|
│───install // Installation instruction
|
│───resource // Resource related documents
|
│───templates // Document templates and examples
|
│───tools // Automation tool
|
│───tutorials // MindSpore tutorial related documents
|
│───CODEOWNERS //  Maintainer list
|
│───CONTRIBUTING_DOC.md //  English version of contribution document
|
│───CONTRIBUTING_DOC_CN.md //  Chinese version of contribution document
|
│───LICENSE //  LICENSE document
|
│───NOTICE //  NOTICE document
|
│───README.md //  English version of docs repository description
|
└───README_CN.md // Chinese version of docs repository description

Document Construction

MindSpore tutorials and API documentation can be generated by the Sphinx tool. Before building API documentation for MindSpore, MindSpore Hub, MindArmour or MindQuantum, the corresponding module must be completed installation. The following takes the MindSpore Python API document as an example to introduce the specific steps. The installation of MindSpore must be completed before the operation.

1. Use pip to install MindSpore module, which API documentation needs to built base on the installation, refe to install.

   pip install mindspore-*.*.*-cp39-cp39m-linux_x86_64.whl
   

2. Download code of the MindSpore Docs repository.

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

3. Go to the directory where the API is located, docs/mindspore, and install the dependency items in the requirements.txt file.

   cd docs/mindspore
   pip install -r requirements.txt
   

4. Open the configuration file Makefile under the directory docs/mindspore where the API is located, and configure it according to the language in the generated documentation. SOURCEDIR refers to the source folder and BUILDDIR refers to the name of the folder where the documentation will be built.

   SOURCEDIR     = source_zh_cn
   BUILDDIR      = build_zh_cn
   

   • To build Chinese documentation, configure SOURCEDIR to source_zh_cn and BUILDDIR to build_zh_cn.
   • To build the English documentation, configure SOURCEDIR as source_en and BUILDDIR as build_en.

5. After the file Makefile is configured, execute the following command under the directory docs/mindspore where the API is located to build the documentation:

   make html
   

   • Build Chinese documentation: After completion, a new build_zh_cn/html directory will be created, which stores the generated Chinese documentation web pages, open build_zh_cn/html/index.html to view the contents of the API documentation.
   • Build the English documentation: After completion, a new build_en/html directory will be created, which stores the generated English documentation web pages, open build_en/html/index.html to view the contents of the API documentation.

Note

1. When APIs for different repositories such as MindSpore are built, the following configuration list is given for use because some resource files corresponding to different repositories are used, and the corresponding repositories need to be cloned and the environment variables are configured:

   Generation of the corresponding APIs	Environment variables	Repository links	Repository names
   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

   The code to clone the repositories and set the environment variables is as follows:

   git clone repository_link
   export environment_variable = corresponds_to_the_local_path_of_the_clone_repository
   

2. When the API of Lite is built, Doxygen needs to be installed. Then download the latest Lite tar package, and configure the local packet path to the LITE_PACKAGE_PATH environment variable:

   sudo apt install doxygen
   export LITE_PACKAGE_PATH = local_path_of_the_Lite_package
   

   The release package needs to include both the device-side and cloud-side, and be stored in the following way:

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

3. When MindSpore Tutorials, MindSpore Docs, and MindQuantum Docs are built, pandoc needs to be installed. For downloading and installing pandoc, refer to https://pandoc.org/installing.html.

License

• Apache License 2.0