【PaddlePaddle Hackathon 3 No.12】为 Paddle 新增 pairwise_distance

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:

docs/api/paddle/nn/Overview_cn.rst

@@ -304,7 +304,7 @@ Clip相关
     " :ref:`paddle.nn.CosineSimilarity <cn_api_nn_CosineSimilarity>` ", "余弦相似度计算"
     " :ref:`paddle.nn.dynamic_decode <cn_api_paddle_nn_dynamic_decode>` ", "循环解码"
     " :ref:`paddle.nn.Flatten <cn_api_tensor_Flatten>` ", "将一个连续维度的Tensor展平成一维Tensor"
-    " :ref:`paddle.nn.PairwiseDistance <cn_api_nn_PairwiseDistance>` ", "计算两个向量之间pairwise的距离"
+    " :ref:`paddle.nn.PairwiseDistance <cn_api_nn_PairwiseDistance>` ", "计算两组向量两两之间的距离"
     " :ref:`paddle.nn.Identity <cn_api_paddle_nn_layer_common_Identity>` ", "建立等效层，作为输入的 Placeholder"
     " :ref:`paddle.nn.Unfold <cn_api_fluid_layers_unfold>` ", "实现的功能与卷积中用到的im2col函数一样，通常也被称作为im2col过程"
     " :ref:`paddle.nn.Fold <cn_api_nn_fold>` ", "该Op用于将一个滑动局部块组合成一个大的张量,通常也被称为col2im过程"
@@ -508,6 +508,7 @@ Embedding相关函数
     " :ref:`paddle.nn.functional.fold <cn_api_nn_functional_fold>` ", "该Op用于将一个滑动局部块组合成一个大的张量,通常也被称为col2im。"
     " :ref:`paddle.nn.functional.gather_tree <cn_api_fluid_layers_gather_tree>` ", "整个束搜索结束后使用,获得每个时间步选择的的候选词 id 及其对应的在搜索树中的 parent 节点"
     " :ref:`paddle.nn.functional.glu <cn_api_nn_cn_glu>` ", "门控线性单元"
+    " :ref:`paddle.nn.functional.pairwise_distance <cn_api_nn_functional_pairwise_distance>` ", "计算两组向量两两之间的距离"
     " :ref:`paddle.nn.functional.interpolate <cn_api_paddle_nn_functional_interpolate>` ", "用于调整一个batch中图片的大小"
     " :ref:`paddle.nn.functional.sequence_mask <cn_api_fluid_layers_sequence_mask>` ", "根据输入 x 和 maxlen 输出一个掩码，数据类型为 dtype"
     " :ref:`paddle.nn.functional.temporal_shift <cn_api_fluid_layers_temporal_shift>` ", "用于对输入X做时序通道T上的位移操作，为TSM中使用的操作"

docs/api/paddle/nn/PairwiseDistance_cn.rst

@@ -5,26 +5,28 @@ PairwiseDistance
 
 .. py:class:: paddle.nn.PairwiseDistance(p=2., epsilon=1e-6, keepdim=False, name=None)
 
-该OP计算两个向量（输入 ``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]`。
 
 代码示例
 ::::::::
 
-COPY-FROM: paddle.nn.PairwiseDistance
+COPY-FROM: paddle.nn.PairwiseDistance

docs/api/paddle/nn/functional/pairwise_distance_cn.rst

@@ -0,0 +1,32 @@
+.. _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)
+
+计算两组向量（输入 ``x``、``y``）两两之间的距离。该距离通过 p 范数计算：
+
+.. math::
+
+    \Vert x \Vert _p = \left( \sum_{i=1}^n \vert x_i \vert ^ p \right ) ^ {1/p}.
+
+参数
+::::::::
+    - **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**。数据类型与 :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