37 lines
1.7 KiB
ReStructuredText
37 lines
1.7 KiB
ReStructuredText
mindspore.ops.Receive
|
||
=====================
|
||
|
||
.. py:class:: mindspore.ops.Receive(sr_tag, src_rank, shape, dtype, group=GlobalComm.WORLD_COMM_GROUP, group_back=GlobalComm.WORLD_COMM_GROUP)
|
||
|
||
接收来自 `src_rank` 线程的张量。
|
||
|
||
.. note::
|
||
Send 和 Receive 算子需组合使用，且需要有同一个 `sr_tag`。
|
||
|
||
参数：
|
||
- **sr_tag** (int) - 用于区分发送、接收消息的标签。该算子将接收具有相同 `sr_tag` 标签的Send算子发送的张量。
|
||
- **src_rank** (int) - 表示发送源的进程编号。只会接收来自源进程的张量。
|
||
- **shape** (list[int]) - 表示发送源的张量形状。
|
||
- **dtype** (Type) - 表示发送源的张量类型。所支持的类型有：int8、int16、int32、float16、float32。
|
||
- **group** (str，可选) - 表示通信域。默认值： ``GlobalComm.WORLD_COMM_GROUP`` 。
|
||
- **group_back** (str，可选) - 表示计算反向传播时的通信域。默认值： ``GlobalComm.WORLD_COMM_GROUP`` 。
|
||
|
||
输出：
|
||
- Tensor - Tensor的shape与Send算子所发送Tensor的shape相同。
|
||
|
||
异常：
|
||
- **TypeError** - `src_rank` 不是int或 `group` 不是str。
|
||
- **RuntimeError** - 如果目标设备无效，或者后端无效，或者分布式初始化失败。
|
||
- **ValueError** - 如果该线程的rank id 大于通信组的rank size。
|
||
|
||
样例：
|
||
|
||
.. note::
|
||
.. include:: mindspore.ops.comm_note.rst
|
||
|
||
该样例需要在2卡环境下运行。
|
||
|
||
教程样例：
|
||
- `分布式集合通信原语 - Receive
|
||
<https://www.mindspore.cn/docs/zh-CN/master/api_python/samples/ops/communicate_ops.html#receive>`_
|