mindspore.mint.distributed.get_rank

View Source On Gitee
mindspore.mint.distributed.get_rank(group=None)[source]

Get the rank ID for the current device in the specified collective communication group.

Note

This method should be used after init().

Parameters

group (str) – The communication group to work on. Normally, the group should be created by create_group, otherwise, using the default group. If None, GlobalComm.WORLD_COMM_GROUP will be used.

Returns

int, the rank ID of the calling process within the group. return -1, if not part of the group

Raises

TypeError – If group is not a string.

Supported Platforms:

Ascend

Examples

Note

Before running the following examples, you need to configure the communication environment variables.

For Ascend devices, it is recommended to use the msrun startup method without any third-party or configuration file dependencies. Please see the msrun start up for more details.

>>> from mindspore import set_context
>>> from mindspore.mint.distributed import init_process_group, get_rank
>>> set_context(device_target="Ascend")
>>> init_process_group()
>>> rank_id = get_rank()
>>> print(rank_id)
>>> # the result is the rank_id in world_group