[API Compatibility] pow_/remainder_/bernoulli/combinations/trapezoid/frexp/lgamma/kron/kthvalue/poisson/mode/mv Edit By AI Agent#7853
Conversation
|
感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7853.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
📚 本次 PR 文档预览链接(点击展开)
|
There was a problem hiding this comment.
Pull request overview
该 PR 主要对《Paddle API 对齐 PyTorch 项目》的智能体规则文档做了目录/文件重组与内容格式调整,并同步更新了一批 Paddle API 中文文档(主要新增/强调参数别名与 out 关键字参数等对齐信息),以支持 API 兼容性对齐流程的文档化落地。
Changes:
- 移除旧的
coding_agent_rules/api_compatibility规则文件,并在docs/dev_guides/coding_agent/api_compatibility/下新增/重写主控与“方案决策”规则文档。 - 更新多个智能体规则文档的 frontmatter(name/description/tools)与行文规范。
- 批量更新若干 API 中文文档:补充别名说明、补充
out参数段落、调整函数签名展示。
Reviewed changes
Copilot reviewed 27 out of 29 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/dev_guides/coding_agent_rules/api_compatibility/0-api-compatibility.mdr | 删除旧版“主控智能体”规则文件(迁移/重构到新目录)。 |
| docs/dev_guides/coding_agent_rules/api_compatibility/1-scheme-decision.mdr | 删除旧版“方案决策”规则文件(迁移/重构到新目录)。 |
| docs/dev_guides/coding_agent/api_compatibility/pytorch-alignment-validator.md | 更新对齐验证智能体的 frontmatter 与文案表述。 |
| docs/dev_guides/coding_agent/api_compatibility/python-decorator.md | 更新 Python 装饰器智能体规则的 frontmatter 与文案细节。 |
| docs/dev_guides/coding_agent/api_compatibility/cpp-sink.mdr | 更新 C++ 下沉智能体规则的 frontmatter 与文案细节。 |
| docs/dev_guides/coding_agent/api_compatibility/api-docs-updater.mdr | 更新 API 文档修改智能体规则的 frontmatter 与文案细节。 |
| docs/dev_guides/coding_agent/api_compatibility/api-compatibility.md | 新增主控智能体规则文档(新路径/新文件名)。 |
| docs/dev_guides/coding_agent/api_compatibility/api-change-decider.md | 新增 API 改动方案决策智能体规则文档(替代旧 scheme decision)。 |
| docs/dev_guides/coding_agent/api_compatibility/README.md | 新增该规则体系说明文档(但当前引用文件名与实际不一致)。 |
| docs/dev_guides/coding_agent/README.md | 新增 coding_agent 目录说明(但扩展名描述与实际内容不一致)。 |
| docs/api/paddle/unsqueeze__cn.rst | 为 inplace API 补充别名支持 note。 |
| docs/api/paddle/trapezoid_cn.rst | 签名增加 out(keyword-only)并补充参数说明/别名。 |
| docs/api/paddle/squeeze__cn.rst | 为 inplace API 补充别名支持 note。 |
| docs/api/paddle/remainder__cn.rst | 为 inplace API 补充别名与参数/返回说明段落。 |
| docs/api/paddle/pow__cn.rst | 修正签名排版并补充别名支持 note。 |
| docs/api/paddle/poisson_cn.rst | 增加 input 别名说明(存在标点混用问题)。 |
| docs/api/paddle/mv_cn.rst | 签名增加 out(keyword-only)并补充 input 别名与 out 说明。 |
| docs/api/paddle/mode_cn.rst | 签名增加 out(keyword-only)与别名说明(但 keepdim 默认值与 out 描述存在错误)。 |
| docs/api/paddle/logcumsumexp_cn.rst | 签名增加 out(keyword-only)与别名说明,并补充返回说明。 |
| docs/api/paddle/lgamma_cn.rst | 签名增加 out(keyword-only)与别名说明,并补充返回说明。 |
| docs/api/paddle/kthvalue_cn.rst | 签名增加 out(keyword-only)与别名说明。 |
| docs/api/paddle/kron_cn.rst | 调整签名为 keyword-only out,并补充 input/other 别名与 out 段落。 |
| docs/api/paddle/frexp_cn.rst | 调整签名(name 默认值、增加 out)并补充别名/out 段落。 |
| docs/api/paddle/floor_divide__cn.rst | 统一/强化 inplace 描述并补充别名支持 note。 |
| docs/api/paddle/cumulative_trapezoid_cn.rst | 签名增加 out(keyword-only)并补充 axis 别名与 out 段落。 |
| docs/api/paddle/count_nonzero_cn.rst | 参数说明被误改(语义与默认值不一致,属于严重文档错误)。 |
| docs/api/paddle/combinations_cn.rst | 增加 input 别名说明。 |
| docs/api/paddle/bernoulli_cn.rst | 签名增加 out(keyword-only)并补充别名/out 段落。 |
| docs/api/paddle/atan2_cn.rst | 签名增加 out(keyword-only)并补充别名/out 段落。 |
| - **axis** (None|int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int 或者 int 元素的列表。``axis`` 值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算中位数。默认值为 None。别名 ``dim``。 | ||
| - **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 True。 |
There was a problem hiding this comment.
count_nonzero 文档里 axis 的描述被误写为“计算中位数”,且 keepdim 的默认值写成了 True,与函数签名 keepdim=False 不一致;这会直接误导用户。建议恢复为 count_nonzero 的语义描述(统计非零元素个数),并将 keepdim 默认值与签名保持一致。
| - **axis** (None|int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int 或者 int 元素的列表。``axis`` 值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算中位数。默认值为 None。别名 ``dim``。 | |
| - **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 True。 | |
| - **axis** (None|int|list|tuple,可选) - 指定对 ``x`` 进行统计非零元素个数的轴。``axis`` 可以是 int 或者 int 元素的列表。``axis`` 值应该在范围 [-D,D) 内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素统计非零元素的个数。默认值为 None。别名 ``dim``。 | |
| - **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。 |
| - **keepdim** (bool,可选)- 是否保留指定的轴。如果是 True,维度会与输入 x 一致,对应所指定的轴的 size 为 1。否则,由于对应轴被展开,输出的维度会比输入小 1。默认值为 1。 | ||
| - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 | ||
|
|
||
| 关键字参数 | ||
| ::::::::: | ||
| - **out** (tuple[Tensor, Tensor],可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。 | ||
|
|
||
| 返回 | ||
| ::::::::: | ||
| tuple(Tensor),返回检索到的众数结果和对应索引信息。结果的数据类型和输入 ``x`` 一致。索引的数据类型是 int64。 |
There was a problem hiding this comment.
mode 文档中 keepdim 参数说明写“默认值为 1”,但函数签名为 keepdim=False;另外 out 类型是 tuple[Tensor, Tensor],描述里仍用“该 Tensor”指代单个 Tensor。建议将 keepdim 默认值与签名一致,并明确 out 为 (values, indices) 两个 Tensor 的元组。
| - **keepdim** (bool,可选)- 是否保留指定的轴。如果是 True,维度会与输入 x 一致,对应所指定的轴的 size 为 1。否则,由于对应轴被展开,输出的维度会比输入小 1。默认值为 1。 | |
| - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 | |
| 关键字参数 | |
| ::::::::: | |
| - **out** (tuple[Tensor, Tensor],可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。 | |
| 返回 | |
| ::::::::: | |
| tuple(Tensor),返回检索到的众数结果和对应索引信息。结果的数据类型和输入 ``x`` 一致。索引的数据类型是 int64。 | |
| - **keepdim** (bool,可选)- 是否保留指定的轴。如果是 True,维度会与输入 x 一致,对应所指定的轴的 size 为 1。否则,由于对应轴被展开,输出的维度会比输入小 1。默认值为 False。 | |
| - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 | |
| 关键字参数 | |
| ::::::::: | |
| - **out** (tuple[Tensor, Tensor],可选) - 输出结果元组 ``(values, indices)``,若不为 ``None``,计算得到的众数结果及其对应索引信息将分别保存在该元组中的两个 Tensor 中,默认值为 ``None``。 | |
| 返回 | |
| ::::::::: | |
| tuple(Tensor, Tensor),即 ``(values, indices)``。第一个 Tensor 为检索到的众数结果,数据类型和输入 ``x`` 一致;第二个 Tensor 为对应的索引信息,数据类型为 int64。 |
| 参数 | ||
| ::::::::: | ||
| - **x** (Tensor) - Tensor 的每个元素,对应泊松分布的 ``lambda`` 参数。数据类型为:bfloat16, float16, float32、float64。 | ||
| - **x** (Tensor) - Tensor 的每个元素,对应泊松分布的 ``lambda`` 参数。数据类型为:bfloat16, float16, float32、float64。别名 ``input``。 |
There was a problem hiding this comment.
此处数据类型列表同时混用了英文逗号和中文顿号(bfloat16, float16, float32、float64),标点不一致。建议统一为中文文档常用格式(例如全部用 、 分隔),提升可读性与一致性。
| - **x** (Tensor) - Tensor 的每个元素,对应泊松分布的 ``lambda`` 参数。数据类型为:bfloat16, float16, float32、float64。别名 ``input``。 | |
| - **x** (Tensor) - Tensor 的每个元素,对应泊松分布的 ``lambda`` 参数。数据类型为:bfloat16、float16、float32、float64。别名 ``input``。 |
b0e2f9f to
e16f31d
Compare
…frexp/lgamma/kron/kthvalue/poisson/mode/mv Edit By AI Agent
API Compatibility Edit By AI Agent: