【开源实习】API文档内容优化-Part1

【任务分值】50分

【任务背景】
MindSpore API文档是用户使用MindSpore时最常用的文档之一，优质的内容和样例可以帮助用户快速上手MindSpore，并自主解决API使用问题。
https://www.mindspore.cn/docs/zh-CN/master/api_python/index.html

【任务需求】
从现有ops、mint、numpy模块的API文档中，每周选取10个（5周共计50个），进行以下内容优化，并合入mindspore仓master分支（每个API提交1个PR，并把样例代码的运行结果写在PR描述中）：

1. 参考业界主流API文档写法，以及MindSpore文档写作规则（单独提供），优化现有MindSpore API文档中的接口描述、参数描述等内容。（可通过官网master页面中的“在Gitee上查看源文件”获取API文档源文件）
2. 在Ascend（Linux）、CPU（Linux、Windows、macOS）环境下，验证现有API文档样例代码是否可运行、运行结果是否与文档描述一致，修正现有样例的问题。
3. 参考业界主流API文档写法，丰富和优化现有API文档的样例代码。

【参考资料】
 **指导材料**  https://gitee.com/mindspore/mindspore/issues/ID1CJT
1. API文档链接：
- ops：https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore.ops.html
- mint：https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore.mint.html
- numpy：https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore.numpy.html
2. 代码仓链接：
- 中文：https://gitee.com/mindspore/mindspore/tree/master/docs/api/api_python
- 英文：https://gitee.com/mindspore/mindspore/tree/master/mindspore/python/mindspore

【验收标准】
1. 优化并修改API文档源文件（包括中文rst和英文py，样例代码在英文py中），提交PR并通过检视后合入。
2. 提供每个接口的样例代码在Ascend（Linux）、CPU（Linux、Windows、macOS）环境下的运行结果，以及与文档描述的一致性结果。

【任务技术要求】
1. 熟悉Python编程
2. 了解AI框架基本使用

【任务成果仓库】
mindspore仓master分支
中文：docs/api/api_python目录
英文：mindspore/python/mindspore目录
（提交PR按完成工作进度分段提交，所有工作完成后经导师审核通过即完成任务）

【导师邮箱】
王老师：kathy.wangting@huawei.com

**认领任务的同学请先发简历给导师，谢谢合作**

MindSpore/community
关闭

内容风险标识

评论 (10)

MindSpore/community关闭 .gitee-modal { width: 500px !important; }

内容风险标识