330 Star 1.4K Fork 770

MindSpore / docs

Create your Gitee Account
Explore and code with more than 8 million developers,Free private repositories !:)
Sign up
Clone or Download
Sync branch
Notice: Creating folder will generate an empty file .keep, because not support in Git

MindSpore Documents

MindSpore Logo



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.


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

├───activity // Record the activity experience.
├───docs // Technical documents about design, specification and so on. Configuration files for API generation.
|    |
|    ├───devtoolkit // MindSpore Dev Toolkit Documents
|    |
|    ├───federated // MindSpore Federated Documents
|    |
|    ├───golden_stick // MindSpore Golden Stick Documents
|    |
|    ├───graphlearning // MindSpore Graph Learning Documents
|    |
|    ├───hub // MindSpore Hub Documents
|    |
|    ├───lite // MindSpore Lite Documents
|    |
|    ├───mindarmour // MindArmour Documents
|    |
|    ├───mindflow // MindFlow Documents
|    |
|    ├───mindelec // MindElec Documents
|    |
|    ├───mindinsight // MindInsight Documents
|    |
|    ├───mindpandas // MindPandas Documents
|    |
|    ├───mindquantum // MindQuantum Documents
|    |
|    ├───mindscience // MindScience Documents
|    |
|    ├───mindsponge // MindSPONGE Documents
|    |
|    ├───mindspore // MindSpore Documents
|    |
|    ├───mindformers // MindSpore Transformer Documents
|    |
|    ├───probability // MindSpore Probability Documents
|    |
|    ├───recommender // MindSpore Recommender Documents
|    |
|    ├───reinforcement // MindSpore Reinforcement Documents
|    |
|    ├───sample_code // Document corresponding sample code
|    |
|    ├───serving // MindSpore Serving Documents
|    |
|    └───xai // MindSpore XAI Documents
│───install // Installation instruction
│───templates // Document templates and examples
│───resource // Resource related documents
│───tools // Automation tool
│───tutorials // MindSpore tutorial related documents
│───CONTRIBUTING_DOC.md // Contributing Documents
└───README.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-*.*.*-cp37-cp37m-linux_x86_64.whl
  2. Download code of the MindSpore Docs repository.

    git clone https://gitee.com/mindspore/docs.git
  3. Go to the api_python directory and install the dependency items in the requirements.txt file.

    cd docs/mindspore
    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


  1. When APIs for different repositories such as MindSpore, MindInsight, and MindQuantum 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/ 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://gitee.com/mindspore/reinforcement.git reinforcement
    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

    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
  3. When MindSpore Tutorials, MindSpore Docs, Deep Probability Programming Docs and MindQuantum Docs are built, pandoc needs to be installed. For downloading and installing pandoc, refer to https://pandoc.org/installing.html



MindSpore document expand collapse
Jupyter Notebook and 6 more languages


No release





Load More
can not load any more