broadcast

paddle.distributed.stream. broadcast ( tensor, src=0, group=None, sync_op=True, use_calc_stream=False )

将一个 tensor 发送到每个进程。

参见 paddle.distributed.broadcast。

注解

该 API 只支持动态图模式。

参数

  • tensor (Tensor) - 在目标进程上为待广播的 tensor，在其他进程上为用于接收广播结果的 tensor。支持的数据类型包括：float16、float32、float64、int32、int64、int8、uint8、bool、bfloat16。

  • src (int，可选) - 目标进程的 rank，该进程传入的 tensor 将被发送到其他进程上。

  • group (Group，可选) - 执行该操作的进程组实例（通过 new_group 创建）。默认为 None，即使用全局默认进程组。

  • sync_op (bool，可选) - 该操作是否为同步操作。默认为 True，即同步操作。

  • use_calc_stream (bool，可选) - 该操作是否在计算流上进行。默认为 False，即不在计算流上进行。该参数旨在提高同步操作的性能，请确保在充分了解其含义的情况下调整该参数的值。

返回

Task。通过 Task，可以查看异步操作的执行状态以及等待异步操作的结果。

代码示例

# required: distributed
import paddle
import paddle.distributed as dist

dist.init_parallel_env()
local_rank = dist.get_rank()
if local_rank == 0:
    data = paddle.to_tensor([[4, 5, 6], [4, 5, 6]])
else:
    data = paddle.to_tensor([[1, 2, 3], [1, 2, 3]])
task = dist.stream.broadcast(data, src=1, sync_op=False)
task.wait()
out = data.numpy()
# [[1, 2, 3], [1, 2, 3]] (2 GPUs)