mindspore.communication.get_group_size

查看源文件
mindspore.communication.get_group_size(group=GlobalComm.WORLD_COMM_GROUP)[源代码]

获取指定通信组实例的rank_size。

说明

  • get_group_size 方法应该在 init 方法之后使用。

参数:
  • group (str) - 指定工作组实例(由 create_group 方法创建)的名称,支持数据类型为str,默认值为 GlobalComm.WORLD_COMM_GROUP

返回:

指定通信组实例的rank_size,数据类型为int。

异常:
  • TypeError - 在参数 group 不是字符串时抛出。

  • ValueError - 在后端不可用时抛出。

  • RuntimeError - 在 HCCLNCCLMCCL 服务不可用时抛出。

支持平台:

Ascend GPU CPU

样例:

说明

运行以下样例之前,需要配置好通信环境变量。

针对Ascend/GPU/CPU设备,推荐使用msrun启动方式,无第三方以及配置文件依赖。详见 msrun启动

>>> import mindspore as ms
>>> from mindspore.communication import init, get_group_size
>>> init()
>>> group_size = get_group_size()
>>> print("group_size is: ", group_size)
group_size is: 8