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.
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
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.
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
Download code of the MindSpore Docs repository.
git clone https://gitee.com/mindspore/docs.git
Go to the api_python directory and install the dependency items in the requirements.txt file.
cd docs/mindspore pip install -r requirements.txt
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.
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|
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
When the API of Lite is built, Doxygen needs to be installed:
sudo apt install doxygen
：Code submit frequency
：React/respond to issue & PR etc.
：Well-balanced team members and collaboration
：Recent popularity of project
：Star counts, download counts etc.