From 612d45693dbef84c7d6f336962cabe6e56fce352 Mon Sep 17 00:00:00 2001 From: Ainavo Date: Fri, 8 Jul 2022 14:05:15 +0800 Subject: [PATCH 1/4] docs --- docs/api/api_label | 1 + docs/api/paddle/nn/Overview_cn.rst | 1 + docs/api/paddle/nn/PairwiseDistance_cn.rst | 12 ++++---- .../nn/functional/pairwise_distance_cn.rst | 29 +++++++++++++++++++ 4 files changed, 37 insertions(+), 6 deletions(-) create mode 100644 docs/api/paddle/nn/functional/pairwise_distance_cn.rst diff --git a/docs/api/api_label b/docs/api/api_label index fb622f16792..ec5e70fd4f9 100644 --- a/docs/api/api_label +++ b/docs/api/api_label @@ -945,6 +945,7 @@ paddle.nn.functional.conv1d_transpose .. _api_paddle_nn_functional_conv1d_transp paddle.nn.functional.conv3d_transpose .. _api_paddle_nn_functional_conv3d_transpose: paddle.nn.functional.pixel_shuffle .. _api_paddle_nn_functional_pixel_shuffle: paddle.nn.functional.softmax_ .. _api_paddle_nn_functional_softmax_: +paddle.nn.functional.pairwise_distance .. _api_paddle_nn_functional_pairwise_distance: paddle.nn.functional.log_sigmoid .. _api_paddle_nn_functional_log_sigmoid: paddle.nn.functional.softshrink .. _api_paddle_nn_functional_softshrink: paddle.nn.functional.embedding .. _api_paddle_nn_functional_embedding: diff --git a/docs/api/paddle/nn/Overview_cn.rst b/docs/api/paddle/nn/Overview_cn.rst index efef26d508b..73e97d960b5 100644 --- a/docs/api/paddle/nn/Overview_cn.rst +++ b/docs/api/paddle/nn/Overview_cn.rst @@ -508,6 +508,7 @@ Embedding相关函数 " :ref:`paddle.nn.functional.fold ` ", "该Op用于将一个滑动局部块组合成一个大的张量,通常也被称为col2im。" " :ref:`paddle.nn.functional.gather_tree ` ", "整个束搜索结束后使用,获得每个时间步选择的的候选词 id 及其对应的在搜索树中的 parent 节点" " :ref:`paddle.nn.functional.glu ` ", "门控线性单元" + " :ref:`paddle.nn.functional.pairwise_distance ` ", "计算两组向量之间pairwise的距离。" " :ref:`paddle.nn.functional.interpolate ` ", "用于调整一个batch中图片的大小" " :ref:`paddle.nn.functional.sequence_mask ` ", "根据输入 x 和 maxlen 输出一个掩码，数据类型为 dtype" " :ref:`paddle.nn.functional.temporal_shift ` ", "用于对输入X做时序通道T上的位移操作，为TSM中使用的操作" diff --git a/docs/api/paddle/nn/PairwiseDistance_cn.rst b/docs/api/paddle/nn/PairwiseDistance_cn.rst index afc56e3dd19..f0c027b2144 100644 --- a/docs/api/paddle/nn/PairwiseDistance_cn.rst +++ b/docs/api/paddle/nn/PairwiseDistance_cn.rst @@ -5,7 +5,7 @@ PairwiseDistance .. py:class:: paddle.nn.PairwiseDistance(p=2., epsilon=1e-6, keepdim=False, name=None) -该OP计算两个向量（输入 ``x``、``y`` ）之间pairwise的距离。该距离通过p范数计算： +该 API 计算两组向量（输入 ``x``、``y``）之间 pairwise 的距离。该距离通过 p 范数计算： .. math:: @@ -13,16 +13,16 @@ PairwiseDistance 参数 :::::::: - - **p** （float，可选）- 指定p阶的范数。默认值为2。 - - **epsilon** （float，可选）- 添加到分母的一个很小值，避免发生除零错误。默认值为1e-6。 - - **keepdim** （bool，可选）- 是否保留输出张量减少的维度。输出结果相对于 ``|x-y|`` 的结果减少一维，除非 :attr:`keepdim` 为True，默认值为False。 + - **p** (float，可选)- 指定 p 阶的范数。默认值为 2。 + - **epsilon** (float，可选)- 添加到分母的一个很小值，避免发生除零错误。默认值为 1e-6。 + - **keepdim** (bool，可选)- 是否保留输出张量减少的维度。输出结果相对于 ``|x-y|`` 的结果减少一维，除非 :attr:`keepdim` 为True，默认值为False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 :::::::: - - **x** (Tensor) - :math:`(N, D)`，其中D是向量的维度，数据类型为float32或float64。 + - **x** (Tensor) - :math:`(N, D)`，其中 D 是向量的维度，数据类型为 float32 或 float64。 - **y** (Tensor) - :math:`(N, D)`，与 ``x`` 的形状、数据类型相同。 - - **output** (Tensor) - :math:`(N)`，如果 :attr:`keepdim` 为True，则形状为 :math:`(N, 1)`。数据类型与 ``x``、 ``y`` 相同。 + - **output** (Tensor) - :math:`(N)`，如果 :attr:`keepdim` 为 True，则形状为 :math:`(N, 1)`。数据类型与 ``x``、 ``y`` 相同。 代码示例 :::::::: diff --git a/docs/api/paddle/nn/functional/pairwise_distance_cn.rst b/docs/api/paddle/nn/functional/pairwise_distance_cn.rst new file mode 100644 index 00000000000..a83dfc19522 --- /dev/null +++ b/docs/api/paddle/nn/functional/pairwise_distance_cn.rst @@ -0,0 +1,29 @@ +.. _cn_api_nn_functional_pairwise_distance: + +pairwise_distance +------------------------------- + +.. py:function:: paddle.nn.functional.pairwise_distance(x, y, p=2., epsilon=1e-6, keepdim=False, name=None) + +该 API 计算两组向量（输入 `x`、 `y`）之间 pairwise 的距离。该距离通过 p 范数计算： + + .. math:: + + \Vert x \Vert _p = \left( \sum_{i=1}^n \vert x_i \vert ^ p \right ) ^ {1/p}. + +参数 +:::::::: + - **x** (Tensor) - (N,D)或(D,) ，其中 D 是向量的维度，数据类型为 float32 或 float64。 + - **y** (Tensor) - (N,D)或(D,) ，其中 D 是向量的维度，数据类型为 float32 或 float64。 + - **p** (float，可选) - 指定 p 阶的范数。默认值为 2。 + - **epsilon** (float，可选) - 添加到分母的一个很小值，避免发生除零错误。默认值为 1e-6。 + - **keepdim** (bool，可选) - 是否保留输出张量减少的维度。输出结果相对于 ``|x-y|`` 的结果减少一维，除非 :attr:`keepdim` 为 True，默认值为 False。 + - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 + +返回 +:::::::: + 输出**Tensor**。 如果 keepdim 为 True，则形状为(N,1) 。数据类型与 x、 y 相同。 + +代码示例 +::::::::: +COPY-FROM: paddle.nn.functional.pairwise_distance \ No newline at end of file From c04c83fae84f971355c86c7e6cfb521f918e1cb0 Mon Sep 17 00:00:00 2001 From: SigureMo Date: Sat, 9 Jul 2022 17:39:35 +0800 Subject: [PATCH 2/4] fix some style issue by docufix --- docs/api/paddle/nn/PairwiseDistance_cn.rst | 4 ++-- docs/api/paddle/nn/functional/pairwise_distance_cn.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/paddle/nn/PairwiseDistance_cn.rst b/docs/api/paddle/nn/PairwiseDistance_cn.rst index f0c027b2144..02f9ca9a378 100644 --- a/docs/api/paddle/nn/PairwiseDistance_cn.rst +++ b/docs/api/paddle/nn/PairwiseDistance_cn.rst @@ -15,7 +15,7 @@ PairwiseDistance :::::::: - **p** (float，可选)- 指定 p 阶的范数。默认值为 2。 - **epsilon** (float，可选)- 添加到分母的一个很小值，避免发生除零错误。默认值为 1e-6。 - - **keepdim** (bool，可选)- 是否保留输出张量减少的维度。输出结果相对于 ``|x-y|`` 的结果减少一维，除非 :attr:`keepdim` 为True，默认值为False。 + - **keepdim** (bool，可选)- 是否保留输出张量减少的维度。输出结果相对于 ``|x-y|`` 的结果减少一维，除非 :attr:`keepdim` 为 True，默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 @@ -27,4 +27,4 @@ PairwiseDistance 代码示例 :::::::: -COPY-FROM: paddle.nn.PairwiseDistance \ No newline at end of file +COPY-FROM: paddle.nn.PairwiseDistance diff --git a/docs/api/paddle/nn/functional/pairwise_distance_cn.rst b/docs/api/paddle/nn/functional/pairwise_distance_cn.rst index a83dfc19522..6ee4fbc9d0c 100644 --- a/docs/api/paddle/nn/functional/pairwise_distance_cn.rst +++ b/docs/api/paddle/nn/functional/pairwise_distance_cn.rst @@ -26,4 +26,4 @@ pairwise_distance 代码示例 ::::::::: -COPY-FROM: paddle.nn.functional.pairwise_distance \ No newline at end of file +COPY-FROM: paddle.nn.functional.pairwise_distance From c9816ff76908fd134c847ebca068cfe0b87181fe Mon Sep 17 00:00:00 2001 From: SigureMo Date: Sat, 9 Jul 2022 18:59:36 +0800 Subject: [PATCH 3/4] refine docs --- docs/api/paddle/nn/PairwiseDistance_cn.rst | 20 ++++++++++-------- .../nn/functional/pairwise_distance_cn.rst | 21 +++++++++++-------- 2 files changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/api/paddle/nn/PairwiseDistance_cn.rst b/docs/api/paddle/nn/PairwiseDistance_cn.rst index 02f9ca9a378..347ee851876 100644 --- a/docs/api/paddle/nn/PairwiseDistance_cn.rst +++ b/docs/api/paddle/nn/PairwiseDistance_cn.rst @@ -5,24 +5,26 @@ PairwiseDistance .. py:class:: paddle.nn.PairwiseDistance(p=2., epsilon=1e-6, keepdim=False, name=None) -该 API 计算两组向量（输入 ``x``、``y``）之间 pairwise 的距离。该距离通过 p 范数计算： +计算两组向量（输入 ``x``、``y``）两两之间的距离。该距离通过 p 范数计算： - .. math:: +.. math:: - \Vert x \Vert _p = \left( \sum_{i=1}^n \vert x_i \vert ^ p \right ) ^ {1/p}. + \Vert x \Vert _p = \left( \sum_{i=1}^n \vert x_i \vert ^ p \right ) ^ {1/p}. 参数 :::::::: - - **p** (float，可选)- 指定 p 阶的范数。默认值为 2。 - - **epsilon** (float，可选)- 添加到分母的一个很小值，避免发生除零错误。默认值为 1e-6。 - - **keepdim** (bool，可选)- 是否保留输出张量减少的维度。输出结果相对于 ``|x-y|`` 的结果减少一维，除非 :attr:`keepdim` 为 True，默认值为 False。 + - **p** (float，可选) - 指定 p 阶的范数。默认值为 :math:`2.0`。 + - **epsilon** (float，可选) - 添加到分母的一个很小值，避免发生除零错误。默认值为 :math:`1e-6`。 + - **keepdim** (bool，可选) - 是否保留输出张量减少的维度。输出结果相对于 :math:`|x-y|` 的结果减少一维，除非 :attr:`keepdim` 为 True，默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 :::::::: - - **x** (Tensor) - :math:`(N, D)`，其中 D 是向量的维度，数据类型为 float32 或 float64。 - - **y** (Tensor) - :math:`(N, D)`，与 ``x`` 的形状、数据类型相同。 - - **output** (Tensor) - :math:`(N)`，如果 :attr:`keepdim` 为 True，则形状为 :math:`(N, 1)`。数据类型与 ``x``、 ``y`` 相同。 + - **x** (Tensor) - :math:`[N, D]` 或 :math:`[D]`，其中 :math:`N` 是批大小，:math:`D` 是向量的维度，数据类型为 float32 或 float64。 + - **y** (Tensor) - :math:`[N, D]` 或 :math:`[D]`，与 :attr:`x` 的数据类型相同。 + - **output** (Tensor) - 数据类型与 :attr:`x`、 :attr:`y` 相同。 + - 如果 :attr:`keepdim` 为 True，则形状为 :math:`[N, 1]` 或 :math:`[1]`，依据输入中是否有数据形状为 :math:`[N, D]`。 + - 如果 :attr:`keepdim` 为 False，则形状为 :math:`[N]` 或 :math:`[]`，依据输入中是否有数据形状为 :math:`[N, D]`。 代码示例 :::::::: diff --git a/docs/api/paddle/nn/functional/pairwise_distance_cn.rst b/docs/api/paddle/nn/functional/pairwise_distance_cn.rst index 6ee4fbc9d0c..d9e6db3ade2 100644 --- a/docs/api/paddle/nn/functional/pairwise_distance_cn.rst +++ b/docs/api/paddle/nn/functional/pairwise_distance_cn.rst @@ -5,25 +5,28 @@ pairwise_distance .. py:function:: paddle.nn.functional.pairwise_distance(x, y, p=2., epsilon=1e-6, keepdim=False, name=None) -该 API 计算两组向量（输入 `x`、 `y`）之间 pairwise 的距离。该距离通过 p 范数计算： +计算两组向量（输入 ``x``、``y``）两两之间的距离。该距离通过 p 范数计算： - .. math:: +.. math:: - \Vert x \Vert _p = \left( \sum_{i=1}^n \vert x_i \vert ^ p \right ) ^ {1/p}. + \Vert x \Vert _p = \left( \sum_{i=1}^n \vert x_i \vert ^ p \right ) ^ {1/p}. 参数 :::::::: - - **x** (Tensor) - (N,D)或(D,) ，其中 D 是向量的维度，数据类型为 float32 或 float64。 - - **y** (Tensor) - (N,D)或(D,) ，其中 D 是向量的维度，数据类型为 float32 或 float64。 - - **p** (float，可选) - 指定 p 阶的范数。默认值为 2。 - - **epsilon** (float，可选) - 添加到分母的一个很小值，避免发生除零错误。默认值为 1e-6。 - - **keepdim** (bool，可选) - 是否保留输出张量减少的维度。输出结果相对于 ``|x-y|`` 的结果减少一维，除非 :attr:`keepdim` 为 True，默认值为 False。 + - **x** (Tensor) - 形状为 :math:`[N, D]` 或 :math:`[D]` 的张量，其中 :math:`N` 是批大小，:math:`D` 是向量的维度，数据类型为 float32 或 float64。 + - **y** (Tensor) - 形状为 :math:`[N, D]` 或 :math:`[D]` 的张量，其中 :math:`N` 是批大小，:math:`D` 是向量的维度，数据类型为 float32 或 float64。 + - **p** (float，可选) - 指定 p 阶的范数。默认值为 :math:`2.0`。 + - **epsilon** (float，可选) - 添加到分母的一个很小值，避免发生除零错误。默认值为 :math:`1e-6`。 + - **keepdim** (bool，可选) - 是否保留输出张量减少的维度。输出结果相对于 :math:`|x-y|` 的结果减少一维，除非 :attr:`keepdim` 为 True，默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 :::::::: - 输出**Tensor**。 如果 keepdim 为 True，则形状为(N,1) 。数据类型与 x、 y 相同。 + **Tensor**。数据类型与 :attr:`x`、 :attr:`y` 相同。 + - 如果 :attr:`keepdim` 为 True，则形状为 :math:`[N, 1]` 或 :math:`[1]`，依据输入中是否有数据形状为 :math:`[N, D]`。 + - 如果 :attr:`keepdim` 为 False，则形状为 :math:`[N]` 或 :math:`[]`，依据输入中是否有数据形状为 :math:`[N, D]`。 代码示例 ::::::::: + COPY-FROM: paddle.nn.functional.pairwise_distance From eaeff115765ad12418130e673247557d9482e016 Mon Sep 17 00:00:00 2001 From: SigureMo Date: Sun, 10 Jul 2022 02:11:10 +0800 Subject: [PATCH 4/4] =?UTF-8?q?translate=20`pairwise`=20to=20`=E4=B8=A4?= =?UTF-8?q?=E4=B8=A4=E4=B9=8B=E9=97=B4`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/paddle/nn/Overview_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/nn/Overview_cn.rst b/docs/api/paddle/nn/Overview_cn.rst index 73e97d960b5..51166439be5 100644 --- a/docs/api/paddle/nn/Overview_cn.rst +++ b/docs/api/paddle/nn/Overview_cn.rst @@ -304,7 +304,7 @@ Clip相关 " :ref:`paddle.nn.CosineSimilarity ` ", "余弦相似度计算" " :ref:`paddle.nn.dynamic_decode ` ", "循环解码" " :ref:`paddle.nn.Flatten ` ", "将一个连续维度的Tensor展平成一维Tensor" - " :ref:`paddle.nn.PairwiseDistance ` ", "计算两个向量之间pairwise的距离" + " :ref:`paddle.nn.PairwiseDistance ` ", "计算两组向量两两之间的距离" " :ref:`paddle.nn.Identity ` ", "建立等效层，作为输入的 Placeholder" " :ref:`paddle.nn.Unfold ` ", "实现的功能与卷积中用到的im2col函数一样，通常也被称作为im2col过程" " :ref:`paddle.nn.Fold ` ", "该Op用于将一个滑动局部块组合成一个大的张量,通常也被称为col2im过程" @@ -508,7 +508,7 @@ Embedding相关函数 " :ref:`paddle.nn.functional.fold ` ", "该Op用于将一个滑动局部块组合成一个大的张量,通常也被称为col2im。" " :ref:`paddle.nn.functional.gather_tree ` ", "整个束搜索结束后使用,获得每个时间步选择的的候选词 id 及其对应的在搜索树中的 parent 节点" " :ref:`paddle.nn.functional.glu ` ", "门控线性单元" - " :ref:`paddle.nn.functional.pairwise_distance ` ", "计算两组向量之间pairwise的距离。" + " :ref:`paddle.nn.functional.pairwise_distance ` ", "计算两组向量两两之间的距离" " :ref:`paddle.nn.functional.interpolate ` ", "用于调整一个batch中图片的大小" " :ref:`paddle.nn.functional.sequence_mask ` ", "根据输入 x 和 maxlen 输出一个掩码，数据类型为 dtype" " :ref:`paddle.nn.functional.temporal_shift ` ", "用于对输入X做时序通道T上的位移操作，为TSM中使用的操作"