PaddlePaddle / PaddlePaddle/docs
部分API文档中的API名称或方法名称错误
Open
@sunzhongkai588 is already working on this.
Since Jun 12, 2024.
- Dominant language
- Python
- Stars
- 284
- Forks
- 906
- PR merge metrics
- No merged PRs in 30d
Description
文档链接&描述 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`。
有误位置:
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)`?
有误位置:
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`?
有误位置:
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`?
有误位置:
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)`?
有误位置:
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)`?
有误位置:
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)`?
有误位置:
请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.