PaddlePaddle / docs

Documentations for PaddlePaddle
https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html
Apache License 2.0
243 stars 732 forks source link

部分API文档中的API名称或方法名称错误 #6658

Open Zoeeeeey opened 5 months ago

Zoeeeeey commented 5 months ago

文档链接&描述 Document Links & Description

您好,

以下是在浏览API文档时,发现可能存在doc bug的地方。

1.方法命名有误:paddle.optimizer.Adam

API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/optimizer/Adam_cn.html#state-dict-state-dict
问题描述:
  state_dict方法的标题命名是否应为`state_dict()`,而不是`state_dict(state_dict)`?
  因为这个方法并没有输入参数,而返回值的类型是`dict`。

有误位置:

image

2.API名称不完整:paddle.distributed.new_group

API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/distributed/new_group_cn.html
问题描述:缺少内容。
  API名称不完整,是否应为`paddle.distributed.new_group(ranks=None, backend=None)`,而不是`new_group(ranks=None, backend=None)`?

有误位置:

image

Version

paddlepaddle - 2.6

3.API名称错误:paddle.incubate.xpu.resnet_block.ResNetBasicBlock

API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/incubate/xpu/resnet_block/ResNetBasicBlock_cn.html
问题描述:缺少内容。
  按照所属及代码示例,API名称是否应该为`paddle.incubate.xpu.resnet_block.ResNetBasicBlock`,而不是`paddle.incubate.xpu.ResNetBasicBlock`?

有误位置:

image

4.API名称错误:paddle.vision.models.GoogLeNet

API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/vision/models/GoogLeNet__upper_cn.html
问题描述:大小写有误。
  按照所属及描述等内容,API名称是否应该为`paddle.vision.models.GoogLeNet`,而不是`paddle.vision.models.googlenet`?

有误位置:

image

5.API名称不完整:paddle.distributed.destroy_process_group

API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/distributed/destroy_process_group_cn.html
问题描述:缺少内容。
  API名称不完整,是否应为`paddle.distributed.destroy_process_group(group=None)`,而不是`destroy_process_group(group=None)`?

有误位置:

image

6.API名称不完整:paddle.distributed.get_group

API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/distributed/get_group_cn.html
问题描述:缺少内容。
  API名称不完整,是否应为`paddle.distributed.get_group(id=0)`,而不是`get_group(id=0)`?

有误位置:

image

7.API名称不完整:paddle.distributed.to_static

API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/distributed/get_group_cn.html
问题描述:缺少内容。
  API名称不完整,是否应为`paddle.distributed.to_static(layer, loader, loss=None, optimizer=None, strategy=None)`,而不是`to_static(layer, loader, loss=None, optimizer=None, strategy=None)`?

有误位置:

image

请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it

No response

Zoeeeeey commented 5 months ago
8.缺少类名:paddle.optimizer.Optimizer
API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/optimizer/Optimizer_cn.html
问题描述:缺少类名
  此处是否应当补充`class paddle.optimizer.Optimizer(learning_rate=0.001, parameters=None, weight_decay=None, grad_clip=None, name=None)[源代码]`?

有误位置:

image

9.缺少文档:paddle.optimizer.ASGD
RST文档链接:https://github.com/PaddlePaddle/docs/blob/4be8fb41a653efc767265f524401eff06315fc8c/docs/api/paddle/optimizer/ASGD_cn.rst
问题描述:缺少API文档
  在API文档中,是否应当补充对`paddle.optimizer.ASGD`的说明?

有误位置:

image

10.目录统计个数有误:paddle.distributed.fleet.Fleet
问题描述:
  左侧检索框目录个数有误,是否应该区分大小写?
  即,是否应为`1个`,而不是`2个`?

有误位置:

image

11.API文档与rst文档不一致:paddle.Model
API文档链接:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/Model_cn.html
RST文档链接:https://github.com/PaddlePaddle/docs/blob/4be8fb41a653efc767265f524401eff06315fc8c/docs/api/paddle/optimizer/ASGD_cn.rst
问题描述:参数类型描述不一致
  在paddle.Model的API文档和RST文档中,input、labels的参数类型描述不一致。

API文档位置: image

RST文档位置: image

12.方法名缺少参数:paddle.nn.LayerList
API文档:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/nn/LayerList_cn.html#append
问题描述:
  方法名中缺少传入参数,是否应为`append(sublayer), insert(index, sublayers), extend(sublayers)`,而不是`append(), insert(), extend()`?

有误位置:

image

13.缺少部分参数描述:paddle.nn.SyncBatchNorm
API文档:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/nn/SyncBatchNorm_cn.html
问题描述:
  缺少对参数data_format、name的描述。

有误位置:

image

14.部分方法名缺少参数:paddle.nn.LayerDict
API文档:
问题描述:
  方法pop、update缺少参数,是否应为`pop(key), update(sublayers)`,而不是`pop(), update()`?

有误位置:

image

15.API名称部分参数缺少默认值:paddle.static.IpuCompiledProgram
API文档:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/static/IpuCompiledProgram_cn.html
问题描述:
  参数program为可选、且默认值为None,则在API名称中,是否应为`paddle.static.IpuCompiledProgram(program=None, scope=None, ipu_strategy=None)`,
  而不是`paddle.static.IpuCompiledProgram(program, scope=None, ipu_strategy=None)`?

有误位置:

image

Zoeeeeey commented 5 months ago
16.API签名部分参数名错误:paddle.histogramdd
API文档:https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/histogramdd_cn.html
问题描述:
  paddle.histogramdd的第一个输入参数在API签名中设置为`x`,在参数定义中设置为`input`,前后不统一。

有误位置:

image

sunzhongkai588 commented 4 months ago
图片描述