2.3K Star 8.1K Fork 4.3K

GVPMindSpore / mindspore

 / 详情

[MS][API][Doc] The API mindspore are not summarized according to usage scenarios

DONE
Bug-Report
创建于  
2021-08-09 11:40
name about labels
Bug Report Use this template for reporting a bug kind/bug

Environment

  • Hardware Environment(Ascend/GPU/CPU):

Uncomment only one /device <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/device ascend
/device gpu
/device cpu

  • Software Environment:
    -- MindSpore version (source or binary):master 2021.8.9 commit_id = ''[sha1]:5e1d8c1a,[branch]:(HEAD,origin/master,origin/HEAD,master)''
    -- Python version (e.g., Python 3.7.5):3.7.5
    -- OS platform and distribution (e.g., Linux Ubuntu 16.04):Ubuntu 18.04
    -- GCC/Compiler version (if compiled from source): 7.3.0

Related testcase

evaluation_development_005

Steps to reproduce the issue

  1. view https://www.mindspore.cn/docs/api/zh-CN/master/api_python/mindspore.html

Describe the current behavior

1.展示规范问题:mindspore下API混乱无序,未依据使用场景分类汇总
enter image description here
enter image description here
参考pytorch
enter image description here

Describe the expected behavior

API展示分类合理,参考pytorch

Related log / screenshot

Special notes for this issue

API mindspore混乱无序,未依据使用场景分类汇总

评论 (5)

liyanjun 创建了Bug-Report
liyanjun 关联分支设置为master
liyanjun 计划截止日期设置为2021-12-31
liyanjun 关联仓库设置为MindSpore/mindspore
liyanjun 负责人设置为TingWang
liyanjun 里程碑设置为B-DOC
liyanjun 计划开始日期设置为2021-08-09
liyanjun 优先级设置为次要
liyanjun 添加了usability/api(已删除)标签
liyanjun 添加了
 
kind/bug
标签
展开全部操作日志

Please add labels (comp or sig),also you can visit "https://gitee.com/mindspore/community/blob/master/sigs/dx/docs/labels.md" to find more.
为了让问题更快得到响应,请您为该issue打上 组件(comp)或兴趣组(sig) 标签,打上标签的问题可以直接推送给责任人进行处理。更多的标签可以查看
https://gitee.com/mindspore/community/blob/master/sigs/dx/docs/labels.md
以组件问题为例,如果你发现问题是data组件造成的,你可以这样评论:
//comp/data
当然你也可以向data SIG组求助,可以这样写:
//comp/data
//sig/data
如果是一个简单的问题,你可以留给刚进入社区的小伙伴来回答,这时候你可以这样写:
//good-first-issue
恭喜你,你已经学会了使用命令来打标签,接下来就在下面的评论里打上标签吧!

TingWang 添加协作者TingWang
TingWang 负责人TingWang 修改为yi
TingWang 任务状态TODO 修改为ACCEPTED
TingWang 任务状态ACCEPTED 修改为WIP

问题原因:

未采用表格的写法

解决办法:

相关rst文件采用表格写法
TingWang 负责人yi 修改为未设置
TingWang 负责人设置为TingWang

//func/parse
//attr/EOU
//stage/coding

mindspore-dx-bot 添加了func/parse(已删除)标签
mindspore-dx-bot 添加了attr/EOU(已删除)标签
mindspore-dx-bot 添加了
 
stage/coding
标签
TingWang 任务状态WIP 修改为VALIDATION
TingWang 负责人TingWang 修改为liyanjun
TingWang 里程碑B-DOC 修改为B-SolutionTest

*【Regression testing Version】:master 8.23 commit_id = ''[sha1]:a6fade32,[branch]:(HEAD->master,origin/master,origin/HEAD)''
*【Regression testing steps】:
enter image description here
enter image description here
*【Basic function verify】:OK
*【Regression testing conclusin】:PASS
*【Regression testing date】:2021/8/23

liyanjun 任务状态VALIDATION 修改为DONE
liyanjun 移除了usability/api(已删除)标签
liyanjun 移除了attr/usability(已删除)标签
liyanjun 移除了func/parse(已删除)标签

登录 后才可以发表评论

状态
负责人
项目
里程碑
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
预计工期 (小时)
参与者(4)
8777557 test bot 1617846881 6574983 liyanjun10 1585220975
Python
1
https://gitee.com/mindspore/mindspore.git
git@gitee.com:mindspore/mindspore.git
mindspore
mindspore
mindspore

搜索帮助