301 Star 1.2K Fork 457

MindSpore / docs

加入 Gitee
与超过 600 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README_CN.md

MindSpore文档

MindSpore Logo

View English

简介

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

贡献

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

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

目录结构说明

docs
├───activity // 活动体验记录
|
├───docs // 架构、网络和算子支持、编程指南等技术文档以及用于生成API的相关配置文件
|    |
|    ├───federated // MindSpore Federated(API工程、相关文档和常见问题)
|    |
|    ├───hub // MindSpore Hub(API工程和相关文档)
|    |
|    ├───lite // MindSpore Lite(API工程、相关文档和常见问题)
|    |
|    ├───mindarmour // MindArmour(API工程、相关文档和常见问题)
|    |
|    ├───mindinsight // MindInsight(相关文档和常见问题)
|    |
|    ├───mindquantum // MindQuantum(API工程和相关文档)
|    |
|    ├───mindspore // MindSpore(API工程、常见问题、迁移指南、说明和编程指南)
|    |
|    ├───notebook // 体验式文档
|    |
|    ├───probability // MindSpore Probability(API工程和相关文档)
|    |
|    ├───sample_code // 文档对应样例代码
|    |
|    └───serving // MindSpore Serving(API工程、相关文档和常见问题)
|
│───install // 安装指南
|
│───resource // 资源相关文档
|
│───tools // 自动化工具
|
│───tutorials // MindSpore教程相关文档
|
└───README_CN.md // Docs仓说明

文档构建

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

  1. 下载MindSpore Docs仓代码。

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

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

    make html

版权

简介

MindSpore document 展开 收起
Jupyter Notebook 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

docs

贡献者

全部

近期动态

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

搜索帮助