mmengine.dist.get_rank¶
- mmengine.dist.get_rank(group=None)[source]¶
Return the rank of the given process group.
Rank is a unique identifier assigned to each process within a distributed process group. They are always consecutive integers ranging from 0 to
world_size.Note
Calling
get_rankin non-distributed environment will return 0.- Parameters
group (ProcessGroup, optional) – The process group to work on. If None, the default process group will be used. Defaults to None.
- Returns
Return the rank of the process group if in distributed environment, otherwise 0.
- Return type