Are you sure you want to delete this task? Once this task is deleted, it cannot be recovered.
mindspore-ci-bot e63b0ea6ec | 3 years ago | |
---|---|---|
.gitee | 4 years ago | |
.github | 4 years ago | |
docs | 3 years ago | |
install | 3 years ago | |
lite | 3 years ago | |
resource | 3 years ago | |
tools | 3 years ago | |
tutorials | 3 years ago | |
.gitignore | 3 years ago | |
CONTRIBUTING_DOC.md | 3 years ago | |
CONTRIBUTING_DOC_CN.md | 3 years ago | |
LICENSE | 4 years ago | |
LICENSE-CC-BY-4.0 | 4 years ago | |
NOTICE | 4 years ago | |
README.md | 3 years ago | |
README_CN.md | 3 years ago |
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
├───docs // Technical documents about architecture, network list, operator list, programming guide and so on. Configuration files for API generation.
│
├───install // Installation guide.
│
├───lite // Summary of all documents related to mindspore lite and their links.
│
├───resource // Resource-related documents.
│
├───tools // Automation tool.
│
├───tutorials // Tutorial-related documents.
│
└───README_CN.md // Docs repository description.
MindSpore tutorials and API documents can be generated by Sphinx. The following uses the Python API document as an example to describe the procedure, and ensure that MindSpore, MindSpore Hub and MindArmour have been installed.
Download code of the MindSpore Docs repository.
git clone https://gitee.com/mindspore/docs.git -b r1.1
Go to the api_python directory and install the dependency items in the requirements.txt
file.
cd docs/api_python
pip install -r requirements.txt
Run the following command in the api_python directory to create the build_zh_cn/html
directory that stores the generated document web page. You can open build_zh_cn/html/index.html
to view the API document.
make html
If you only need to generate the MindSpore API, please modify the
source_zh_cn/conf.py
file, comment theimport mindspore_hub
andimport mindarmour
statements, and then perform this step.
MindSpore document
Jupyter Notebook Markdown Python reStructuredText Gettext Catalog other
Dear OpenI User
Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.
For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》