From 6f8235bf2a14a73024a1c326d882a8e95f514a83 Mon Sep 17 00:00:00 2001 From: andyjpaddle Date: Tue, 30 Nov 2021 07:01:27 +0000 Subject: [PATCH 1/8] add diff chinese doc, test=develop --- docs/api/paddle/Overview_cn.rst | 1 + docs/api/paddle/diff_cn.rst | 53 +++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 docs/api/paddle/diff_cn.rst diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 4a46417a212..60c3439c11d 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -112,6 +112,7 @@ tensor数学操作 " :ref:`paddle.diagonal ` ", "根据给定的轴 axis 返回输入 Tensor 的局部视图" " :ref:`paddle.trunc ` ", "对输入 Tensor 每个元素的小数部分进行截断" " :ref:`paddle.log1p ` ", "该OP计算Log1p（加一的自然对数）结果" + " :ref:`paddle.diff ` ", "沿着指定维度对输入Tensor计算n阶的前向差值" .. _tensor_logic: diff --git a/docs/api/paddle/diff_cn.rst b/docs/api/paddle/diff_cn.rst new file mode 100644 index 00000000000..14aff9edce1 --- /dev/null +++ b/docs/api/paddle/diff_cn.rst @@ -0,0 +1,53 @@ +.. _cn_api_tensor_diff: + +diff +------------------------------- + +.. py:function:: paddle.diff(x, n=1, axis=-1, prepend=None, append=None, name=None) + +沿着指定轴计算n阶的前向差值，一阶的前向差值计算公式如下： + +.. math:: + out[i] = x[i+1] - x[i] + +高阶的前向差值可以通过递归方式进行计算，目前只支持n=1。 + +参数: +::::::::: + + - **x** (Tensor) - 待计算前向差值的输入 `Tensor`。 + - **n** (int, 可选) - 需要计算前向差值的次数，目前仅支持 `n=1`，默认值为1。 + - **axis** (int, 可选) - 沿着哪一维度计算前向差值，默认值为-1，也即最后一个维度。 + - **prepend** (Tensor, 可选) - 在计算前向差值之前，沿着指定维度axis附加到输入x的前面，它的维度需要和输入一致，并且除了axis维外，其他维度的形状也要和输入一致，默认值为None。 + - **prepend** (Tensor, 可选) - 在计算前向差值之前，沿着指定维度axis附加到输入x的后面，它的维度需要和输入一致，并且除了axis维外，其他维度的形状也要和输入一致，默认值为None。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + +返回 +::::::::: +前向差值计算后的Tensor，数据类型和输入一致。 + +代码示例: +::::::::: + +.. code-block:: python + + import paddle + x = paddle.to_tensor([1, 4, 5, 2]) + out = paddle.diff(x) + print(out) + # out: + # [3, 1, -3] + y = paddle.to_tensor([7, 9]) + out = paddle.diff(x, append=y) + print(out) + # out: + # [3, 1, -3, 5, 2] + z = paddle.to_tensor([[1, 2, 3], [4, 5, 6]]) + out = paddle.diff(z, axis=0) + print(out) + # out: + # [[3, 3, 3]] + out = paddle.diff(z, axis=1) + print(out) + # out: + # [[1, 1], [1, 1]] \ No newline at end of file From 3945c211a190145451640499906caaeac1ab0b04 Mon Sep 17 00:00:00 2001 From: andyjpaddle Date: Wed, 1 Dec 2021 11:49:44 +0000 Subject: [PATCH 2/8] update diff doc --- docs/api/paddle/diff_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/diff_cn.rst b/docs/api/paddle/diff_cn.rst index 14aff9edce1..cf48b1c4878 100644 --- a/docs/api/paddle/diff_cn.rst +++ b/docs/api/paddle/diff_cn.rst @@ -5,7 +5,7 @@ diff .. py:function:: paddle.diff(x, n=1, axis=-1, prepend=None, append=None, name=None) -沿着指定轴计算n阶的前向差值，一阶的前向差值计算公式如下： +沿着指定轴计算输入Tensor的n阶前向差值，一阶的前向差值计算公式如下： .. math:: out[i] = x[i+1] - x[i] From 939d21c7018e95ab8e5a385fb5bac28ffda92730 Mon Sep 17 00:00:00 2001 From: andyjpaddle Date: Thu, 2 Dec 2021 02:19:40 +0000 Subject: [PATCH 3/8] add isclose diff to tensor ch doc --- docs/api/paddle/Tensor/Overview_en.rst | 2 ++ docs/api/paddle/Tensor_cn.rst | 18 ++++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/docs/api/paddle/Tensor/Overview_en.rst b/docs/api/paddle/Tensor/Overview_en.rst index 0b66e16ee97..683c9d4310d 100644 --- a/docs/api/paddle/Tensor/Overview_en.rst +++ b/docs/api/paddle/Tensor/Overview_en.rst @@ -113,6 +113,7 @@ Methods dist divide dot + diff eigvals equal equal_all @@ -143,6 +144,7 @@ Methods index_sample index_select inverse + isclose is_empty is_tensor isfinite diff --git a/docs/api/paddle/Tensor_cn.rst b/docs/api/paddle/Tensor_cn.rst index 53ae7d96efe..27caecef72c 100755 --- a/docs/api/paddle/Tensor_cn.rst +++ b/docs/api/paddle/Tensor_cn.rst @@ -271,6 +271,15 @@ allclose(y, rtol=1e-05, atol=1e-08, equal_nan=False, name=None) 请参考 :ref:`cn_api_tensor_allclose` +isclose(x, y, rtol=1e-05, atol=1e-08, equal_nan=False, name=None) +::::::::: + +返回：计算后的Tensor + +返回类型：Tensor + +请参考 :ref:`cn_api_tensor_isclose` + any(axis=None, keepdim=False, name=None) ::::::::: @@ -748,6 +757,15 @@ dot(y, name=None) 请参考 :ref:`cn_api_paddle_tensor_linalg_dot` +diff(x, n=1, axis=-1, prepend=None, append=None, name=None) +::::::::: + +返回：计算后的Tensor + +返回类型：Tensor + +请参考 :ref:`cn_api_tensor_diff` + equal(y, name=None) ::::::::: From b26295b2b806350e31a6ec871583da3d2790676b Mon Sep 17 00:00:00 2001 From: andyjpaddle Date: Thu, 2 Dec 2021 09:10:24 +0000 Subject: [PATCH 4/8] fix args description --- docs/api/paddle/diff_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/diff_cn.rst b/docs/api/paddle/diff_cn.rst index cf48b1c4878..dd651147e6e 100644 --- a/docs/api/paddle/diff_cn.rst +++ b/docs/api/paddle/diff_cn.rst @@ -19,7 +19,7 @@ diff - **n** (int, 可选) - 需要计算前向差值的次数，目前仅支持 `n=1`，默认值为1。 - **axis** (int, 可选) - 沿着哪一维度计算前向差值，默认值为-1，也即最后一个维度。 - **prepend** (Tensor, 可选) - 在计算前向差值之前，沿着指定维度axis附加到输入x的前面，它的维度需要和输入一致，并且除了axis维外，其他维度的形状也要和输入一致，默认值为None。 - - **prepend** (Tensor, 可选) - 在计算前向差值之前，沿着指定维度axis附加到输入x的后面，它的维度需要和输入一致，并且除了axis维外，其他维度的形状也要和输入一致，默认值为None。 + - **append** (Tensor, 可选) - 在计算前向差值之前，沿着指定维度axis附加到输入x的后面，它的维度需要和输入一致，并且除了axis维外，其他维度的形状也要和输入一致，默认值为None。 - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 返回 From 532381d124608b5b3535c71355952d9492099c0f Mon Sep 17 00:00:00 2001 From: andyjpaddle Date: Thu, 2 Dec 2021 09:12:40 +0000 Subject: [PATCH 5/8] fix some note --- docs/api/paddle/diff_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/diff_cn.rst b/docs/api/paddle/diff_cn.rst index dd651147e6e..7b726cbbdbc 100644 --- a/docs/api/paddle/diff_cn.rst +++ b/docs/api/paddle/diff_cn.rst @@ -10,7 +10,7 @@ diff .. math:: out[i] = x[i+1] - x[i] -高阶的前向差值可以通过递归方式进行计算，目前只支持n=1。 +高阶的前向差值可以通过递归方式进行计算，目前只支持 `n=1` 。 参数: ::::::::: From 1b36d891b3ae0eb8ac4e6a82880d4abd83c812f2 Mon Sep 17 00:00:00 2001 From: andyjpaddle Date: Thu, 2 Dec 2021 09:50:08 +0000 Subject: [PATCH 6/8] add some note --- docs/api/paddle/diff_cn.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/paddle/diff_cn.rst b/docs/api/paddle/diff_cn.rst index 7b726cbbdbc..bec96e7a228 100644 --- a/docs/api/paddle/diff_cn.rst +++ b/docs/api/paddle/diff_cn.rst @@ -10,7 +10,8 @@ diff .. math:: out[i] = x[i+1] - x[i] -高阶的前向差值可以通过递归方式进行计算，目前只支持 `n=1` 。 +.. note:: + 高阶的前向差值可以通过递归方式进行计算，目前只支持 `n=1` 。 参数: ::::::::: From 477db781f46628f7e0a4c0a6c9aa8ca90a544945 Mon Sep 17 00:00:00 2001 From: andyjpaddle Date: Thu, 2 Dec 2021 09:54:48 +0000 Subject: [PATCH 7/8] add some note --- docs/api/paddle/diff_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/diff_cn.rst b/docs/api/paddle/diff_cn.rst index bec96e7a228..82639f2a266 100644 --- a/docs/api/paddle/diff_cn.rst +++ b/docs/api/paddle/diff_cn.rst @@ -11,7 +11,7 @@ diff out[i] = x[i+1] - x[i] .. note:: - 高阶的前向差值可以通过递归方式进行计算，目前只支持 `n=1` 。 + 高阶的前向差值可以通过递归方式进行计算，目前只支持 n=1。 参数: ::::::::: From 2def0272c76e48b5e97e34812728136c3981a73a Mon Sep 17 00:00:00 2001 From: andyjpaddle Date: Thu, 2 Dec 2021 10:00:20 +0000 Subject: [PATCH 8/8] add some note --- docs/api/paddle/diff_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/diff_cn.rst b/docs/api/paddle/diff_cn.rst index 82639f2a266..53bd5f30243 100644 --- a/docs/api/paddle/diff_cn.rst +++ b/docs/api/paddle/diff_cn.rst @@ -11,7 +11,7 @@ diff out[i] = x[i+1] - x[i] .. note:: - 高阶的前向差值可以通过递归方式进行计算，目前只支持 n=1。 + 高阶的前向差值可以通过递归的方式进行计算，目前只支持 n=1。 参数: :::::::::