【文档】API文档整改规则 · Issue #I83A16 · MindSpore/mindformers

原值

API的注释统一规范

以 https://gitee.com/mindspore/mindformers/pulls/1192/files 这个PR为例

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]]

新值

 **API的注释统一规范** 

 **以 https://gitee.com/mindspore/mindformers/pulls/1192/files 这个PR为例** 

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]]

原值

 **API的注释统一规范** 

 **以 https://gitee.com/mindspore/mindformers/pulls/1192/files 这个PR为例** 

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]]

新值

 **API的注释统一规范** 

 **以 https://gitee.com/mindspore/mindformers/pulls/1192/files 这个PR为例** 

 **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]]

原值

 **API的注释统一规范** 

 **以 https://gitee.com/mindspore/mindformers/pulls/1192/files 这个PR为例** 

 **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]]

新值

 **API的注释统一规范** 

 **以 https://gitee.com/mindspore/mindformers/pulls/1192/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]]

原值

 **API的注释统一规范** 

 **以 https://gitee.com/mindspore/mindformers/pulls/1192/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]]

新值

 **API的注释统一规范** 

需要检查的部分：

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

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

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

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

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

模型部分

 **以 https://gitee.com/mindspore/mindformers/pulls/1192/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]]

GVP MindSpore/mindformers

内容风险标识

【文档】API文档整改规则置顶

评论 (0)

GVPMindSpore/mindformers

内容风险标识

【文档】API文档整改规则 置顶

评论 (0)

搜索帮助

GVP MindSpore/mindformers

【文档】API文档整改规则置顶