2022-6 飞桨API文档体验评估

请务必评估飞桨官网 develop 分支对应的API文档，谢谢！
请务必评估飞桨官网 develop 分支对应的API文档，谢谢！
请务必评估飞桨官网 develop 分支对应的API文档，谢谢！
*
1.
个人信息
您的微信昵称
您的微信昵称
您评估的API文档名称
您评估的API文档名称
*
2.
红线
满足不满足
API文档对该API的描述，是否与API的行为保持一致？
API文档对该API的描述，是否与API的行为保持一致？
API文档提供的示例代码能否跑通？
API文档提供的示例代码能否跑通？
中英文API文档的内容是否严格一致？
中英文API文档的内容是否严格一致？
*
4.
结构：是否按API文档推荐的结构书写，并且没有遗漏（无需写的部分可以省略）？

API文档推荐的书写结构如下：API名称、API功能描述、API参数、API返回、API代码示例、API属性(class)、API方法(methods)
注：对于Linear, Conv2D, L1Loss 这些class形式的API，需要写清楚当这个callable被调用时的输入输出的形状（i,e.forward函数的参数），位置在API参数后面。
满足
不满足
*
6.
内容
满足不满足
全文语句通畅、准确、易理解。
全文语句通畅、准确、易理解。
API描述部分是否描述清楚，在什么场景下使用该API？
API描述部分是否描述清楚，在什么场景下使用该API？
API参数，是否描述清楚不同参数下，API的行为区别？
API参数，是否描述清楚不同参数下，API的行为区别？
示例代码是否以注释给出了运行结果？
示例代码是否以注释给出了运行结果？
没有死链、错字、错误标点等低级错误。
没有死链、错字、错误标点等低级错误。
*
9.
格式评估
参考链接：深度学习常用术语表
满足不满足
是否使用深度学习领域通用的词汇和说法？
是否使用深度学习领域通用的词汇和说法？
API文档格式是否满足格式规范？
API文档格式是否满足格式规范？
示例代码是否仅使用Paddle API，没有使用numpy等创建输入？
示例代码是否仅使用Paddle API，没有使用numpy等创建输入？
*
11.
加分项：是否有图或其他内容显著提高内容易读性？
满足
不满足
*
12.
主观评价：请对您评估的文档做整体主观评价
*
13.
请在下方选择您对文档的主观打分
很不满意
很满意
问卷星提供技术支持
举报