add cn docs for all_gather_object, modified docs for all_gather and s…

…plit
PaddlePaddle · Jul 26, 2022 · 89ac8e9 · 89ac8e9
1 parent 15496d0
commit 89ac8e9
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 5 deletions.
diff --git a/docs/api/paddle/distributed/all_gather_cn.rst b/docs/api/paddle/distributed/all_gather_cn.rst
@@ -17,8 +17,8 @@ all_gather
 
 参数
 :::::::::
-    - tensor_list (list) - 操作的输出Tensor列表。列表中的每个元素均为Tensor，每个Tensor的数据类型为：float16、float32、float64、int32、int64。
-    - tensor (Tensor) - 操作的输入Tensor。Tensor的数据类型为：float16、float32、float64、int32、int64。
+    - tensor_list (list) - 操作的输出Tensor列表。列表中的每个元素均为Tensor，每个Tensor的数据类型为：float16、float32、float64、int32、int64、uint8，bool、int8、 complex64、 complex128。
+    - tensor (Tensor) - 操作的输入Tensor。Tensor的数据类型为：float16、float32、float64、int32、int64、uint8，bool、int8、 complex64、 complex128。
     - group (int，可选) - 工作的进程组编号，默认为0。
 
 返回
@@ -27,4 +27,4 @@ all_gather
 
 代码示例
 :::::::::
-COPY-FROM: paddle.distributed.all_gather
+COPY-FROM: paddle.distributed.all_gather
diff --git a/docs/api/paddle/distributed/all_gather_object.cn.rst b/docs/api/paddle/distributed/all_gather_object.cn.rst
@@ -0,0 +1,23 @@
+.. _cn_api_distributed_all_gather_object:
+
+all_gather_object
+-------------------------------
+
+
+.. py:function:: paddle.distributed.all_gather_object(object_list, object, group=0)
+
+进程组内所有进程指定的picklable对象进行聚合操作，并返回给所有进程聚合的结果。和all_gather类似，但可以传入自定义的python对象。
+
+参数
+:::::::::
+    - object_list (list) - 操作的输出Object列表。
+    - object (Any) - 操作的输入Object，需要保证输入自定义的Object是picklable的。
+    - group (int，可选) - 工作的进程组编号，默认为0。
+
+返回
+:::::::::
+无
+
+代码示例
+:::::::::
+COPY-FROM: paddle.distributed.all_gather_object
diff --git a/docs/api/paddle/split_cn.rst b/docs/api/paddle/split_cn.rst
@@ -11,7 +11,7 @@ split
 
 参数
 :::::::::
-       - **x** (Tensor) - 输入变量，数据类型为bool、float16、float32、float64、int32、int64的多维Tensor。
+       - **x** (Tensor) - 输入变量，数据类型为bool、float16、float32、float64、uint8, int8, int32、int64的多维Tensor。
        - **num_or_sections** (int|list|tuple) - 如果 ``num_or_sections`` 是一个整数，则表示 Tensor 平均划分为相同大小子 Tensor 的数量。如果 ``num_or_sections`` 是一个 list 或 tuple，那么它的长度代表子 Tensor 的数量，它的元素可以是整数或者形状为[1]的 Tensor，依次代表子 Tensor 需要分割成的维度的大小。list 或 tuple 的长度不能超过输入 Tensor 待分割的维度的大小。在 list 或 tuple 中，至多有一个元素值为-1，表示该值是由 ``x`` 的维度和其他 ``num_or_sections`` 中元素推断出来的。例如对一个维度为[4, 6, 6] Tensor 的第三维进行分割时，指定 ``num_or_sections=[2,-1,1]``，输出的三个 Tensor 维度分别为：[4, 6, 2]，[4, 6, 3]，[4, 6, 1]。
        - **axis** (int|Tensor，可选) - 整数或者形状为[1]的 Tensor，数据类型为 int32 或 int64。表示需要分割的维度。如果 ``axis < 0``，则划分的维度为 ``rank(x) + axis``。默认值为0。
        - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
@@ -24,4 +24,4 @@ split
 代码示例
 :::::::::
 
-COPY-FROM: paddle.split
+COPY-FROM: paddle.split