From 883fbf9f77a9653733211f79eeb22173a60c46af Mon Sep 17 00:00:00 2001 From: thunder95 <290844930@qq.com> Date: Sat, 23 Jul 2022 17:14:40 +0800 Subject: [PATCH 1/3] add doc for count_nonzero --- docs/api/api_label | 1 + docs/api/paddle/Overview_cn.rst | 1 + docs/api/paddle/Tensor/Overview_en.rst | 1 + docs/api/paddle/Tensor_cn.rst | 9 +++++++++ docs/api/paddle/count_nonzero_cn.rst | 24 ++++++++++++++++++++++++ 5 files changed, 36 insertions(+) create mode 100644 docs/api/paddle/count_nonzero_cn.rst diff --git a/docs/api/api_label b/docs/api/api_label index 756d6b6b33d..b19ecfae517 100644 --- a/docs/api/api_label +++ b/docs/api/api_label @@ -138,6 +138,7 @@ paddle.concat .. _api_paddle_concat: paddle.conj .. _api_paddle_conj: paddle.cos .. _api_paddle_cos: paddle.cosh .. _api_paddle_cosh: +paddle.count_nonzero .. _api_paddle_count_nonzero: paddle.cross .. _api_paddle_cross: paddle.cumsum .. _api_paddle_cumsum: paddle.dist .. _api_paddle_dist: diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 4b987b6e9df..dd3d0bd2f34 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -50,6 +50,7 @@ tensor数学操作 " :ref:`paddle.conj ` ", "逐元素计算Tensor的共轭运算" " :ref:`paddle.cos ` ", "余弦函数" " :ref:`paddle.cosh ` ", "双曲余弦函数" + " :ref:`paddle.count_nonzero ` ", "沿给定的轴 axis 统计非零元素的数量" " :ref:`paddle.cumsum ` ", "沿给定 axis 计算张量 x 的累加和" " :ref:`paddle.cumprod ` ", "沿给定 dim 计算张量 x 的累乘" " :ref:`paddle.digamma ` ", "逐元素计算输入x的digamma函数值" diff --git a/docs/api/paddle/Tensor/Overview_en.rst b/docs/api/paddle/Tensor/Overview_en.rst index 59b37485376..bd5a99f1a60 100644 --- a/docs/api/paddle/Tensor/Overview_en.rst +++ b/docs/api/paddle/Tensor/Overview_en.rst @@ -104,6 +104,7 @@ Methods copy_ cos cosh + count_nonzero cpu cross cuda diff --git a/docs/api/paddle/Tensor_cn.rst b/docs/api/paddle/Tensor_cn.rst index d41cda4a713..e83a8c0c8e9 100755 --- a/docs/api/paddle/Tensor_cn.rst +++ b/docs/api/paddle/Tensor_cn.rst @@ -626,6 +626,15 @@ cosh(name=None) print(out) # [1.08107237 1.02006674 1.00500417 1.04533851] +count_nonzero(axis=None, keepdim=False, name=None) +::::::::: + +返回：沿给定的轴 ``axis`` 统计输入Tensor ``x`` 中非零元素的个数。 + +返回类型：Tensor + +请参考 :ref:`cn_api_tensor_cn_count_nonzero` + cpu() ::::::::: diff --git a/docs/api/paddle/count_nonzero_cn.rst b/docs/api/paddle/count_nonzero_cn.rst new file mode 100644 index 00000000000..1429df41aae --- /dev/null +++ b/docs/api/paddle/count_nonzero_cn.rst @@ -0,0 +1,24 @@ +.. _cn_api_tensor_cn_count_nonzero: + +count_nonzero +------------------------------- + +.. py:function:: paddle.count_nonzero(x, axis=None, keepdim=False, name=None) + +沿给定的轴 ``axis`` 统计输入Tensor ``x`` 中非零元素的个数。 + +参数 +:::::::::: +　　- x (Tensor) - 输入的Tensor，数据类型为：bool、float16、float32、float64、int32、int64。 +　　- axis (None|int|list|tuple，可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int或者int元素的列表。``axis`` 值应该在范围[-D， D)内，D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0，则等价于 :math:`axis + D`。如果 ``axis`` 是None，则对 ``x`` 的全部元素计算中位数。默认值为None。 +　　- keepdim (bool，可选) - 是否在输出Tensor中保留减小的维度。如果 ``keepdim`` 为True，则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为1)。否则，输出Tensor的形状会在 ``axis`` 上进行squeeze操作。默认值为True。 +　　- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 + + +返回 +:::::::::: + ``Tensor``，沿着 ``axis`` 统计输入Tensor中非零元素的个数，数据类型int64。 + +代码示例 +:::::::::: +COPY-FROM: paddle.count_nonzero:count_nonzero-example \ No newline at end of file From 088b96c1ab392de364964252dd26ce8c5351bb66 Mon Sep 17 00:00:00 2001 From: thunder95 <290844930@qq.com> Date: Wed, 27 Jul 2022 08:57:03 +0800 Subject: [PATCH 2/3] fix format error --- docs/api/paddle/count_nonzero_cn.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/paddle/count_nonzero_cn.rst b/docs/api/paddle/count_nonzero_cn.rst index 1429df41aae..d9cc2a5d759 100644 --- a/docs/api/paddle/count_nonzero_cn.rst +++ b/docs/api/paddle/count_nonzero_cn.rst @@ -9,10 +9,10 @@ count_nonzero 参数 :::::::::: -　　- x (Tensor) - 输入的Tensor，数据类型为：bool、float16、float32、float64、int32、int64。 -　　- axis (None|int|list|tuple，可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int或者int元素的列表。``axis`` 值应该在范围[-D， D)内，D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0，则等价于 :math:`axis + D`。如果 ``axis`` 是None，则对 ``x`` 的全部元素计算中位数。默认值为None。 -　　- keepdim (bool，可选) - 是否在输出Tensor中保留减小的维度。如果 ``keepdim`` 为True，则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为1)。否则，输出Tensor的形状会在 ``axis`` 上进行squeeze操作。默认值为True。 -　　- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 + - x (Tensor) - 输入的Tensor，数据类型为：bool、float16、float32、float64、int32、int64。 + - axis (None|int|list|tuple，可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int或者int元素的列表。``axis`` 值应该在范围[-D， D)内，D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0，则等价于 :math:`axis + D`。如果 ``axis`` 是None，则对 ``x`` 的全部元素计算中位数。默认值为None。 + - keepdim (bool，可选) - 是否在输出Tensor中保留减小的维度。如果 ``keepdim`` 为True，则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为1)。否则，输出Tensor的形状会在 ``axis`` 上进行squeeze操作。默认值为True。 + - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 @@ -21,4 +21,4 @@ count_nonzero 代码示例 :::::::::: -COPY-FROM: paddle.count_nonzero:count_nonzero-example \ No newline at end of file +COPY-FROM: paddle.count_nonzero:count_nonzero-example From 2f7bff03ee9e3cd577e3f9ad4dff49cf02714776 Mon Sep 17 00:00:00 2001 From: Ligoml <39876205+Ligoml@users.noreply.github.com> Date: Wed, 27 Jul 2022 14:24:08 +0800 Subject: [PATCH 3/3] Update count_nonzero_cn.rst --- docs/api/paddle/count_nonzero_cn.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/paddle/count_nonzero_cn.rst b/docs/api/paddle/count_nonzero_cn.rst index d9cc2a5d759..a7c7283ac87 100644 --- a/docs/api/paddle/count_nonzero_cn.rst +++ b/docs/api/paddle/count_nonzero_cn.rst @@ -9,9 +9,9 @@ count_nonzero 参数 :::::::::: - - x (Tensor) - 输入的Tensor，数据类型为：bool、float16、float32、float64、int32、int64。 - - axis (None|int|list|tuple，可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int或者int元素的列表。``axis`` 值应该在范围[-D， D)内，D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0，则等价于 :math:`axis + D`。如果 ``axis`` 是None，则对 ``x`` 的全部元素计算中位数。默认值为None。 - - keepdim (bool，可选) - 是否在输出Tensor中保留减小的维度。如果 ``keepdim`` 为True，则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为1)。否则，输出Tensor的形状会在 ``axis`` 上进行squeeze操作。默认值为True。 + - **x** (Tensor) - 输入的Tensor，数据类型为：bool、float16、float32、float64、int32、int64。 + - **axis** (None|int|list|tuple，可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int或者int元素的列表。``axis`` 值应该在范围[-D， D)内，D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0，则等价于 :math:`axis + D`。如果 ``axis`` 是None，则对 ``x`` 的全部元素计算中位数。默认值为None。 + - **keepdim** (bool，可选) - 是否在输出Tensor中保留减小的维度。如果 ``keepdim`` 为True，则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为1)。否则，输出Tensor的形状会在 ``axis`` 上进行squeeze操作。默认值为True。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。