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 architecture, network list, operator list and so on. Configuration files for API generation.
|    |
|    ├───federated // MindSpore Federated (API project, related documents and FAQ)
|    |
|    ├───hub // MindSpore Hub (API project and FAQ)
|    |
|    ├───lite // MindSpore Lite (API project, related documents and FAQ)
|    |
|    ├───mindarmour // MindArmour (API project, related documents and FAQ)
|    |
|    ├───mindinsight // MindInsight (related documents and FAQ)
|    |
|    ├───mindquantum // MindQuantum (API project and related documents)
|    |
|    ├───mindspore // MindSpore (API project, FAQ, migration guide, instructions)
|    |
|    ├───notebook // Experiential documentation
|    |
|    ├───probability // MindSpore Probability (API project and related documents)
|    |
|    ├───sample_code // Document corresponding sample code
|    |
|    └───serving // MindSpore Serving (API project, related documents and FAQ)
|
│───install // Installation instruction
|
│───resource // Resource related documents
|
│───tools // Automation tool
|
│───tutorials // MindSpore tutorial related documents
|
└───README_CN.md // 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-1.5.0-cp37-cp37m-linux_x86_64.whl

2. Download code of the MindSpore Docs repository.

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

3. Go to the api_python directory and install the dependency items in the requirements.txt file.

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

4. Run the following command in the api_python directory to create the build_en/html directory that stores the generated document web page. You can open build_en/html/index.html to view the API document.

   make html

• Build MindSpore Tutorial, Migration Guide Document, Depth Probability Programming Document and MindQuantum Documentation. If you need to install pandoc, please refer to https://pandoc.org/installing.html to download and install pandoc.

• When building the MindSpore and Lite API, you need to clone the mindspore repository because of some resource files will be used in it, and add the environment variable MS_PATH, Doxygen needs to be installed when building Lite API:

  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} is the path of mindspore repository on your computer.

• When building the MindInsight, you need to clone the mindinsight repository because of some resource files will be used in it, and add the environment variable 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} is the path of mindinsight repository on your computer.

• When building the MindArmour, you need to clone the mindarmour repository because of some resource files will be used in it, and add the environment variable 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} is the path of mindarmour repository on your computer.

• When building the MindQuantum, you need to clone the mindquantum repository because of some resource files will be used in it, and add the environment variable 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} is the path of mindquantum repository on your computer.

• When building the Reinforcement, you need to clone the reinforcement repository because of some resource files will be used in it, and add the environment variable 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} is the path of reinforcement repository on your computer.

• When building the Serving, you need to clone the serving repository because of some resource files will be used in it, and add the environment variable 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} is the path of serving repository on your computer.

• When building the Vision, you need to clone the vision repository because of some resource files will be used in it, and add the environment variable 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} is the path of vision repository on your computer.

License

• Apache License 2.0
• Creative Commons License version 4.0