Skip to content

Commit 9114536

Browse files
committed
docs(distributed/collective): update return vals
1 parent a9b1d0a commit 9114536

23 files changed

+44
-44
lines changed

docs/api/paddle/distributed/all_gather_object_cn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ all_gather_object
99
组聚合,聚合进程组内指定的 picklable 对象,随后将聚合后的对象列表发送到每个进程。
1010
过程与 ``all_gather`` 类似,但可以传入自定义的 python 对象。
1111

12-
.. warning::
12+
.. note::
1313
该 API 只支持动态图模式。
1414

1515
参数

docs/api/paddle/distributed/all_reduce_cn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ all_reduce
2525

2626
返回
2727
:::::::::
28-
返回 Task 实例
28+
``Task``,显示执行状态,并可以用于调度异步操作
2929

3030
代码示例
3131
:::::::::

docs/api/paddle/distributed/alltoall_single_cn.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ alltoall_single
66

77
.. py:function:: paddle.distributed.alltoall_single(in_tensor, out_tensor, in_split_sizes=None, out_split_sizes=None, group=None, sync_op=True)
88
9-
.. warning::
10-
该 API 只支持动态图模式。
11-
129
将输入的 tensor 分发到每个进程,随后在每个进程上将分发结果聚合到 out_tensor 中。
1310

11+
.. note::
12+
该 API 只支持动态图模式。
13+
1414
参数
1515
:::::::::
1616
- **in_tensor** (Tensor): 输入的 tensor。支持的数据类型包括:float16、float32、float64、int32、int64、int8、uint8、bool、bfloat16。
@@ -22,7 +22,7 @@ alltoall_single
2222

2323
返回
2424
:::::::::
25-
若为同步操作,无返回值;若为异步操作,返回 Task 实例
25+
若为同步操作,无返回值;若为异步操作,返回``Task``,显示执行状态,并可以用于调度异步操作
2626

2727
代码示例
2828
:::::::::

docs/api/paddle/distributed/barrier_cn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ barrier
1414

1515
返回
1616
:::::::::
17-
17+
无返回值。
1818

1919
代码示例
2020
:::::::::

docs/api/paddle/distributed/broadcast_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ broadcast
2525

2626
返回
2727
:::::::::
28-
动态图模式下,若为同步操作,返回 None;若为异步操作,返回 Task 实例
28+
动态图模式下,若为同步操作,无返回值;若为异步操作,返回``Task``,显示执行状态,并可以用于调度异步操作
2929

30-
静态图模式下,返回 None
30+
静态图模式下,无返回值
3131

3232
代码示例
3333
:::::::::

docs/api/paddle/distributed/destroy_process_group_cn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ destroy_process_group
1414

1515
返回
1616
:::::::::
17-
17+
无返回值。
1818

1919
代码示例
2020
::::::::::::

docs/api/paddle/distributed/irecv_cn.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ irecv
66

77
.. py:function:: paddle.distributed.irecv(tensor, src=None, group=None)
88
9-
.. warning::
10-
该 API 只支持动态图模式。
11-
129
异步接收一个来自指定进程的 tensor。
1310

11+
.. note::
12+
该 API 只支持动态图模式。
13+
1414
参数
1515
:::::::::
1616
- **tensor** (Tensor) - 用于接收数据的 tensor。支持的数据类型包括:float16、float32、float64、int32、int64、int8、uint8、bool、bfloat16。
@@ -20,7 +20,7 @@ irecv
2020

2121
返回
2222
:::::::::
23-
返回 Task 实例
23+
``Task``,显示执行状态,并可以用于调度异步操作
2424

2525
代码示例
2626
:::::::::

docs/api/paddle/distributed/isend_cn.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ isend
66

77
.. py:function:: paddle.distributed.isend(tensor, dst, group=None)
88
9-
.. warning::
10-
该 API 只支持动态图模式。
11-
129
异步发送一个 tensor 到指定进程。
1310

11+
.. note::
12+
该 API 只支持动态图模式。
13+
1414
参数
1515
:::::::::
1616
- **tensor** (Tensor) - 待发送的 Tensor。支持的数据类型包括:float16、float32、float64、int32、int64、int8、uint8、bool、bfloat16。
@@ -20,7 +20,7 @@ isend
2020

2121
返回
2222
:::::::::
23-
返回 Task 实例
23+
``Task``,显示执行状态,并可以用于调度异步操作
2424

2525
代码示例
2626
:::::::::

docs/api/paddle/distributed/recv_cn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ recv
1717

1818
返回
1919
:::::::::
20-
动态图模式下,若为同步操作,无返回值;若为异步操作,返回 Task 实例
20+
动态图模式下,若为同步操作,无返回值;若为异步操作,返回``Task``,显示执行状态,并可以用于调度异步操作
2121

2222
静态图模式下,无返回值。
2323

docs/api/paddle/distributed/reduce_cn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ reduce
2626

2727
返回
2828
:::::::::
29-
动态图模式下,若为同步操作,无返回值;若为异步操作,返回 Task 实例
29+
动态图模式下,若为同步操作,无返回值;若为异步操作,返回``Task``,显示执行状态,并可以用于调度异步操作
3030

3131
静态图模式下,无返回值。
3232

docs/api/paddle/distributed/reduce_scatter_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ reduce_scatter
88
99
规约一组 tensor,随后将规约结果分发到每个进程。
1010

11-
.. warning::
11+
.. note::
1212
该 API 只支持动态图模式。
1313

1414
参数
@@ -22,7 +22,7 @@ reduce_scatter
2222

2323
返回
2424
:::::::::
25-
若为同步操作,无返回值;若为异步操作,返回 Task 实例
25+
若为同步操作,无返回值;若为异步操作,返回``Task``,显示执行状态,并可以用于调度异步操作
2626

2727
代码示例
2828
:::::::::

docs/api/paddle/distributed/scatter_cn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ scatter
2626

2727
返回
2828
:::::::::
29-
动态图模式下,若为同步操作,无返回值;若为异步操作,返回 Task 实例
29+
动态图模式下,若为同步操作,无返回值;若为异步操作,返回``Task``,显示执行状态,并可以用于调度异步操作
3030

3131
静态图模式下,无返回值。
3232

docs/api/paddle/distributed/send_cn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ send
1717

1818
返回
1919
:::::::::
20-
动态图模式下,若为同步操作,无返回值;若为异步操作,返回 Task 实例
20+
动态图模式下,若为同步操作,无返回值;若为异步操作,返回``Task``,显示执行状态,并可以用于调度异步操作
2121

2222
静态图模式下,无返回值。
2323

docs/api/paddle/distributed/stream/all_gather_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ all_gather
1010

1111
参见 `paddle.distributed.all_gather`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -25,7 +25,7 @@ all_gather
2525

2626
返回
2727
:::::::::
28-
返回 Task 实例
28+
``Task``,显示执行状态,并可以用于调度异步操作
2929

3030
代码示例
3131
:::::::::

docs/api/paddle/distributed/stream/all_reduce_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ all_reduce
1010

1111
参见 `paddle.distributed.all_reduce`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -23,7 +23,7 @@ all_reduce
2323

2424
返回
2525
:::::::::
26-
返回 Task 实例
26+
``Task``,显示执行状态,并可以用于调度异步操作
2727

2828
代码示例
2929
:::::::::

docs/api/paddle/distributed/stream/alltoall_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ alltoall
1010

1111
参见 `paddle.distributed.alltoall`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -25,7 +25,7 @@ alltoall
2525

2626
返回
2727
:::::::::
28-
返回 Task 实例
28+
``Task``,显示执行状态,并可以用于调度异步操作
2929

3030
代码示例
3131
:::::::::

docs/api/paddle/distributed/stream/alltoall_single_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ alltoall_single
1010

1111
参见 `paddle.distributed.alltoall_single`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -25,7 +25,7 @@ alltoall_single
2525

2626
返回
2727
:::::::::
28-
返回 Task 实例
28+
``Task``,显示执行状态,并可以用于调度异步操作
2929

3030
代码示例
3131
:::::::::

docs/api/paddle/distributed/stream/broadcast_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ broadcast
1010

1111
参见 `paddle.distributed.broadcast`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -23,7 +23,7 @@ broadcast
2323

2424
返回
2525
:::::::::
26-
返回 Task 实例
26+
``Task``,显示执行状态,并可以用于调度异步操作
2727

2828
代码示例
2929
:::::::::

docs/api/paddle/distributed/stream/recv_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ recv
1010

1111
参见 `paddle.distributed.recv`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -23,7 +23,7 @@ recv
2323

2424
返回
2525
:::::::::
26-
返回 Task 实例
26+
``Task``,显示执行状态,并可以用于调度异步操作
2727

2828
代码示例
2929
:::::::::

docs/api/paddle/distributed/stream/reduce_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ reduce
1010

1111
参见 `paddle.distributed.reduce`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -24,7 +24,7 @@ reduce
2424

2525
返回
2626
:::::::::
27-
返回 Task 实例
27+
``Task``,显示执行状态,并可以用于调度异步操作
2828

2929
代码示例
3030
:::::::::

docs/api/paddle/distributed/stream/reduce_scatter_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ reduce_scatter
1010

1111
参见 `paddle.distributed.reduce`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -27,7 +27,7 @@ reduce_scatter
2727

2828
返回
2929
:::::::::
30-
返回 Task 实例
30+
``Task``,显示执行状态,并可以用于调度异步操作
3131

3232
代码示例
3333
:::::::::

docs/api/paddle/distributed/stream/scatter_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ scatter
1010

1111
参见 `paddle.distributed.scatter`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -27,7 +27,7 @@ scatter
2727

2828
返回
2929
:::::::::
30-
返回 Task 实例
30+
``Task``,显示执行状态,并可以用于调度异步操作
3131

3232
代码示例
3333
:::::::::

docs/api/paddle/distributed/stream/send_cn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ send
1010

1111
参见 `paddle.distributed.send`。
1212

13-
.. warning::
13+
.. note::
1414
该 API 只支持动态图模式。
1515

1616
参数
@@ -23,7 +23,7 @@ send
2323

2424
返回
2525
:::::::::
26-
返回 Task 实例
26+
``Task``,显示执行状态,并可以用于调度异步操作
2727

2828
代码示例
2929
:::::::::

0 commit comments

Comments
 (0)