Paddle 【2.0 API文档内测】paddle.metric.Auc文档问题

js81xvg6  于 2021-11-30  发布在  Java
关注(0)|答案(0)|浏览(301)

文档问题描述:

API文档描述是否清晰?

中文:3分:
1、目录应该摘要显示每个子函数,而非“参数”“返回”等。
2、未给出构造函数参数表。
英文:3分:
1、构造函数描述中多了一个.metric。
2、示例代码格式错误,跑到了代码框外边(浏览器firefox 83.0/ubuntu1804)。尝试点击复制按钮,仅能复制到一个空行。

参数说明是否清晰

中文:3分:
1、构造函数的curve参数从源代码看好像没用,从描述看好像要区分ROC和PR两种计算模式,但也不清楚。
2、update函数未对额外参数(*args)的使用场景作出说明。函数名里参数为pred和label,描述里是preds和labels,不一致。源代码里是有s的。
英文:4分
英文update函数的参数描述是上下一致的。

返回/形状说明是否清晰

中文:5分:
1、从代码看label参数的形状可以不为[batch_size, 1],[batch_size]也能处理。实测可以处理。
英文:5分

示例代码是否有效?

中文:5分,示例代码基本能展示API的功能,实测有效。
英文:5分

中英文内容是否一致?

英文里多了一个compute函数,应该是Metric基类里的。

其他

总评分:3分。整体感觉格式太差了,第一眼看不清文档的层次结构,尤其是英文文档,建议降低“参数”“返回”这些标题的显著性。此外还有一些细节瑕疵。

暂无答案!

目前还没有任何答案,快来回答吧!

相关问题