1 Star 0 Fork 851

yeyunpeng2020 / docs

forked from MindSpore / docs 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

MindSpore文档

MindSpore Logo

View English

简介

此工程提供MindSpore官方网站https://www.mindspore.cn所呈现安装指南、教程、文档的源文件以及API的相关配置。

贡献

我们非常欢迎您贡献文档!如果想要参与,请阅读CONTRIBUTING_DOC_CN.md,务必遵守文档写作规范,并按照流程规则提交,审核通过后,改动会在文档工程和官网中呈现。

同时,如果您对文档有任何意见或建议,请在Issues中提交。

目录结构说明

docs
├───activity // 活动体验记录
|
├───docs // 设计、规格、FAQ等技术文档,以及用于生成API的相关配置文件
|    |
|    ├───devtoolkit // MindSpore Dev Toolkit文档
|    |
|    ├───federated // MindSpore Federated文档
|    |
|    ├───golden_stick // MindSpore Golden Stick文档
|    |
|    ├───graphlearning // MindSpore Graph Learning文档
|    |
|    ├───hub // MindSpore Hub文档
|    |
|    ├───lite // MindSpore Lite文档
|    |
|    ├───mindarmour // MindArmour文档
|    |
|    ├───mindearth // MindEarth文档
|    |
|    ├───mindflow // MindFlow文档
|    |
|    ├───mindelec // MindElec文档
|    |
|    ├───mindinsight // MindInsight文档
|    |
|    ├───mindpandas // MindPandas文档
|    |
|    ├───mindquantum // MindQuantum文档
|    |
|    ├───mindscience // MindScience文档
|    |
|    ├───mindsponge // MindSPONGE文档
|    |
|    ├───mindspore // MindSpore文档
|    |
|    ├───mindformers // mindformers文档
|    |
|    ├───probability // MindSpore Probability文档
|    |
|    ├───recommender // MindSpore Recommender文档
|    |
|    ├───reinforcement // MindSpore Reinforcement文档
|    |
|    ├───sample_code // 文档对应样例代码
|    |
|    ├───sciai // MindSpore SciAI文档
|    |
|    ├───serving // MindSpore Serving文档
|    |
|    └───xai // MindSpore XAI文档
|
│───install // 安装指南
|
│───templates // 文档模板和样例
|
│───resource // 资源相关文档
|
│───tools // 自动化工具
|
│───tutorials // MindSpore教程相关文档
|
│───CONTRIBUTING_DOC_CN.md //  贡献文档
|
└───README_CN.md // Docs仓说明

文档构建

MindSpore的教程和API文档均可由Sphinx工具生成,构建MindSpore等各组件API文档之前需完成对应模块的安装。下面以MindSpore Python API文档为例介绍具体步骤,操作前需完成MindSpore的安装。

  1. 使用pip安裝MindSpore模块,API文档需要根据安装后的MindSpore模块生成,参考安装

    pip install mindspore-*.*.*-cp37-cp37m-linux_x86_64.whl
  2. 下载MindSpore Docs仓代码。

    git clone https://gitee.com/mindspore/docs.git
  3. 进入api目录,安装该目录下requirements.txt文件中的依赖项。

    cd docs/mindspore
    pip install -r requirements.txt
  4. 在api目录下执行如下命令,完成后会新建build_zh_cn/html目录,该目录中存放了生成后的文档网页,打开build_zh_cn/html/index.html即可查看API文档内容。

    make html

注意事项

  1. 构建MindSpore、MindInsight、MindQuantum等不同仓的API时,由于会使用到对应不同仓的一些资源文件,需要先克隆对应仓,并配置环境变量,给出以下配置列表供使用:

    对应API的生成 环境变量 仓库链接 仓库名
    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://github.com/mindspore-lab/mindrl.git mindrl
    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

    克隆仓库以及设置环境变量的代码如下:

    git clone 仓库链接
    export 环境变量 = 对应克隆仓在本地的路径
  2. 构建Lite的API时,还需要安装Doxygen,且要下载最新的Lite tar包,并将本地的包路径配置到LITE_PACKAGE_PATH环境变量:

    sudo apt install doxygen
    export LITE_PACKAGE_PATH = 本地的Lite包路径
  3. 构建MindSpore教程MindSpore文档深度概率编程文档MindQuantum文档时还需安装pandoc,下载和安装pandoc请参考https://pandoc.org/installing.html

版权

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

MindSpore document 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/yeyunpeng2020/docs.git
git@gitee.com:yeyunpeng2020/docs.git
yeyunpeng2020
docs
docs
master

搜索帮助

14c37bed 8189591 565d56ea 8189591