PaddlePaddle / PaddlePaddle/docs

部分API的rst文档的`代码示例`与API名称不符

Open
#6,659 2 comments 0 reactions 3 assignees View on GitHub

@ooooo-create is already working on this.

Since Jun 18, 2024.

Dominant language
Python
Stars
284
Forks
906
PR merge metrics
No merged PRs in 30d

Description

文档链接&描述 Document Links & Description

您好,

部分API的rst文档的代码示例中,COPY-FROM后给出的内容与API名称不符,通常多出一个“子命名空间”。

这可能不是文档bug,因为我并不了解代码示例的真实含义。

我仅从字面上理解,认为代码示例的内容应与API名称一致,因此报告此类错误。

1.多出layers

paddle.audio.features.MFCC
  rst文档路径:docs/api/paddle/audio/features/MFCC_cn.rst

paddle.audio.features.LogMelSpectrogram
  rst文档路径:docs/api/paddle/audio/features/LogMelSpectrogram_cn.rst

2.多出communication

paddle.distributed.stream.all_gather
  rst文档路径:docs/api/paddle/distributed/stream/all_gather_cn.rst

paddle.distributed.stream.all_reduce
  rst文档路径:docs/api/paddle/distributed/stream/all_reduce_cn.rst

paddle.distributed.stream.alltoall
  rst文档路径:docs/api/paddle/distributed/stream/alltoall_cn.rst

paddle.distributed.stream.alltoall_single
  rst文档路径:docs/api/paddle/distributed/stream/alltoall_single_cn.rst

paddle.distributed.stream.broadcast
  rst文档路径:docs/api/paddle/distributed/stream/broadcast_cn.rst

paddle.distributed.stream.recv
  rst文档路径:docs/api/paddle/distributed/stream/recv_cn.rst

paddle.distributed.stream.reduce
  rst文档路径:docs/api/paddle/distributed/stream/reduce_cn.rst

paddle.distributed.stream.reduce_scatter
  rst文档路径:docs/api/paddle/distributed/stream/reduce_scatter_cn.rst

paddle.distributed.stream.scatter
  rst文档路径:docs/api/paddle/distributed/stream/scatter_cn.rst

paddle.distributed.stream.send
  rst文档路径:docs/api/paddle/distributed/stream/send_cn.rst

3.多出:code-static, code-example2等内容

如:paddle.optimizer.lr.LinearLR:code-static、paddle.profiler.make_scheduler:code-example2、paddle.regularizer.L1Decay:code-example2、paddle.regularizer.L2Decay:code-example2等
请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it

认为:COPY-FROM后给出的API名称应该与目前的API名称保持一致

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.