Open Zoeeeeey opened 1 month ago
其他:
1.方法名称缺少参数
paddle.nn.LayerList.append, paddle.nn.LayerList.insert, paddle.nn.LayerList.extend
rst文档路径:docs/api/paddle/nn/LayerList_cn.rst
paddle.nn.LayerDict的方法pop, update
rst文档路径:docs/api/paddle/nn/LayerDict_cn.rst
2.部分参数缺少描述
paddle.nn.SyncBatchNorm
缺少对参数data_format、name的描述
rst文档路径:docs/api/paddle/nn/SyncBatchNorm_cn.rst
认为:COPY-FROM后给出的API名称应该与目前的API名称保持一致
是的,两者应该保持一致。同时 COPY-FROM
以及 API名称
也都需要使用是 API 的公开路径(简单来说,在英文 api 文档中可以查到的 api 目前都属于公开 API,暴露的位置就是公开位置)。
COPY-FROM 的用法可以参考这里 COPY-FROM。
多出:code-static, code-example2等内容
这些可以参考 COPY-FROM 里面对于name 标识的设计
.多出layers,多出communication
文档链接&描述 Document Links & Description
您好,
部分API的rst文档的
代码示例
中,COPY-FROM
后给出的内容与API名称不符,通常多出一个“子命名空间”。这可能不是文档bug,因为我并不了解代码示例的真实含义。
我仅从字面上理解,认为代码示例的内容应与API名称一致,因此报告此类错误。
1.多出
layers
2.多出
communication
3.多出
:code-static
,code-example2
等内容请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it
认为:
COPY-FROM
后给出的API名称应该与目前的API名称保持一致