113 Star 784 Fork 444

MindSpore / mindformers

 / 详情

【文档】API文档整改规则

TODO
Documentation 成员
创建于  
2023-09-21 15:42

API的注释统一规范

需要检查的部分:

  1. 检查机翻效果是否通顺,不通顺需要修改

  2. 样例检查,样例copy直接执行是否能够跑通,不能跑通需要进行补充

  3. 除部分特殊样例外,均需要有输出结果

  4. 内容检查,过于简短的接口,要检查是否有['说明','输入', '返回','样例'],没有的需要自行补充,或找相关负责人补充。

非模型公共接口部分,对外接口API check:Args/Returns 这两个部分对外接口必须由,examples非必须,建议添加。

模型部分
!1192:Description of the API related to the model beginning B./files 这个PR为例

请下载附件《Mindformers参数说明表》,参考其中通用语义进行注释。

Model部分 :仅写对外开放的API接口部分,其余不做要求;
1. Examples:使用from_pretrained("model_type")示例。仅打印type(model)即可,不使用输入和输出值(模型部分有随机性,不好界定标准输出)
2. 所有模型统一需要有Args部分
3. construct部分参考Bloom模型写Args和Retruns

Processor部分
1. 写Args,LLM模型参考本PR中的Processor写法
2. 写Examples,给出输出结果

ModelConfig
1. 写Args,统一入参含义,LLM可以参考本PR中Bloom模型的

Examples测试统一规范https://docs.python.org/zh-cn/3.7/library/doctest.html#how-are-docstring-examples-recognized

需要额外注意输出行 不能有空以及>>>或者..., 输出行需要手动删除额外空行
例如:
[1, 1]

[1, 1]]
输入中间的空行需要手动删除
[[1, 1]
[1, 1]]

附件
Lin 2023-09-21 17:03

评论 (0)

AHHOZP 创建了Documentation
AHHOZP 修改了描述
AHHOZP 修改了描述
Lin 修改了描述
AHHOZP 修改了描述
Xinrui Chen 置顶等级设置为
展开全部操作日志

登录 后才可以发表评论

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

搜索帮助