Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

【Hackathon 5th No.35】为 Paddle 新增 histogramdd API 中文文档 #6350

Merged
merged 9 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ tensor 线性代数相关
" :ref:`paddle.dist <cn_api_paddle_dist>` ", "计算 (x-y) 的 p 范数(p-norm)"
" :ref:`paddle.dot <cn_api_paddle_dot>` ", "计算向量的内积"
" :ref:`paddle.histogram <cn_api_paddle_histogram>` ", "计算输入 Tensor 的直方图"
" :ref:`paddle.histogramdd <cn_api_paddle_histogramdd>` ", "计算输入多维 Tensor 的直方图"
" :ref:`paddle.matmul <cn_api_paddle_matmul>` ", "计算两个 Tensor 的乘积,遵循完整的广播规则"
" :ref:`paddle.mv <cn_api_paddle_mv>` ", "计算矩阵 x 和向量 vec 的乘积"
" :ref:`paddle.rank <cn_api_paddle_rank>` ", "计算输入 Tensor 的维度(秩)"
Expand Down
30 changes: 30 additions & 0 deletions docs/api/paddle/histogramdd_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _cn_api_paddle_histogramdd:

histogramdd
-------------------------------

.. py:function:: paddle.histogramdd(x, bins=10, ranges=None, density=False, weights=None, name=None)

计算输入多维 Tensor 的直方图。将最内维度大小为 N 的输入张量的元素解释为 N 维点的集合。将每个点映射到一组 N 维 bin 中,并返回每个 bin 中的点数(或总权重)

输入 x 必须是具有至少 2 个维度的张量。如果输入具有形状 (M,N) 则其 M 行中的每一行定义 N 维空间中的一个点。如果输入有三个或多个维度,则除最后一个维度外的所有维度都将被展平。


参数
::::::::::::

- **input** (Tensor) - 输入多维 Tensor 。
- **bins** (Tensor[]|int[]|int) - 如果为 Tensor 数组,则表示所有 bin 边界。如果为 int 数组,则表示每个维度中等宽 bin 的数量。如果为 int,则表示所有维度的等宽 bin 数量。默认值为 10 ,表示所有维度的等宽 bin 数量为 10 个。
- **ranges** (float[], 可选) - 表示每个维度中最左边和最右边的 bin 边界。如果为 None ,则将每个尺寸的最小值和最大值设置为最左边和最右边。默认值为 None ,表示自动根据最大值与最小值计算 bin 的边界。
- **density** (bool,可选) - 表示是否计算 density ,如果为 False,结果将包含每个 bin 中的计数(或权重)。如果为 True,则将每个计数(权重)除以总计数(总权重),然后再除以相关 bin 的宽度。默认值为 False ,表示不计算 density 。
- **weights** (Tensor,可选) - 表示权重。如果传递 Tensor ,则输入中的每个 N 维坐标将其相关权重贡献给其 bin 的结果。权重应具有与输入张量相同的形状,但不包括其最内维度 N。默认情况下,输入中的每个值的权重为 1 。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
::::::::::::
包含直方图值的 N 维张量,包含 bin 边界信息的 N 个 1D tensor 的序列。

代码示例
::::::::::::

COPY-FROM: paddle.histogramdd