【Hackathon 5th No.35】为 Paddle 新增 histogramdd API 中文文档 #6350
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-6350.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
docs/api/paddle/histogramdd_cn.rst
Outdated
Comment on lines
16
to
21
| - **input** (Tensor) - 输入多维 Tensor 。 | ||
| - **bins** (Tensor[], int[], or int) - 如果张量数组，则表示所有 bin 边界。如果 int 数组，则表示每个维度中等宽 bin 的数量。如果为 int，则定义所有维度的等宽 bin 数量。 | ||
| - **ranges** (sequence of float, optional) - 定义每个维度中最左边和最右边的 bin 边界。如果为 None ，则将每个尺寸的最小值和最大值设置为最左边和最右边。 | ||
| - **density** (bool，可选) - 如果为 False（默认值），结果将包含每个 bin 中的计数（或权重）。如果为 True，则将每个计数（权重）除以总计数（总权重），然后再除以相关 bin 的宽度。 | ||
| - **weights** (Tensor，可选) - 默认情况下，输入中的每个值的权重为 1。如果传递权重张量，则输入中的每个 N 维坐标将其相关权重贡献给其 bin 的结果。权重张量应具有与输入张量相同的形状，但不包括其最内维度 N。 | ||
| - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 |
There was a problem hiding this comment.
参数描述不太规范，请参考 API参数 及 常用文档写法。 以
bins参数为例，- **bins** (Tensor[]|int[]|int) - 如果为 Tensor 数组，则表示......。默认值为...表示...。
已修改，辛苦review~ @sunzhongkai588
Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
26 tasks
24 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add cn doc for
histogramddapiPR: