【Hackathon 5th No.17】为 Paddle 新增 pdist API 中文文档 (#6391)

* add householder_product_cn doc * doc style * add pdist cn doc * Update Overview_cn.rst * Update Overview_cn.rst * Delete docs/api/paddle/linalg/householder_product_cn.rst
PaddlePaddle · Dec 18, 2023 · bc66ad7 · bc66ad7
1 parent 26f1888
commit bc66ad7
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst
@@ -338,6 +338,7 @@ tensor 线性代数相关
     " :ref:`paddle.triu <cn_api_paddle_triu>` ", "返回输入矩阵 input 的上三角部分，其余部分被设为 0"
     " :ref:`paddle.triu_indices <cn_api_paddle_triu_indices>` ", "返回输入矩阵在给定对角线右上三角部分元素坐标"
     " :ref:`paddle.cdist <cn_api_paddle_cdist>` ", "计算两组输入集合 x, y 中每对之间的 p 范数"
+    " :ref:`paddle.pdist <cn_api_paddle_pdist>` ", "计算输入形状为 N x M 的 Tensor 中 N 个向量两两组合(pairwise)的 p 范数"
 
 .. _tensor_manipulation:
 

diff --git a/docs/api/paddle/pdist_cn.rst b/docs/api/paddle/pdist_cn.rst
@@ -0,0 +1,25 @@
+.. _cn_api_paddle_pdist:
+
+pdist
+-------------------------------
+
+.. py:function:: paddle.pdist(x, p=2.0, name=None):
+
+计算输入形状为 N x M 的 Tensor 中 N 个向量两两组合(pairwise)的 p 范数。
+
+
+参数
+::::::::::::
+
+  - **x** (Tensor) - 输入的 Tensor，形状为 :math:`N \times M` 。
+  - **p** (float， 可选) - 计算每个向量对之间的 p 范数距离的值。默认值为 :math:`2.0`。
+  - **name** (str, 可选) - 具体用法请参见  :ref:`api_guide_Name` ，一般无需设置，默认值为 None。
+
+返回
+::::::::::::
+Tensor，数据类型与输入张量相同，输出的形状为 :math:`N \times (N-1) \div 2`。
+
+代码示例
+::::::::::::
+
+COPY-FROM: paddle.pdist