This document is relevant for: Trn2, Trn3

nki.collectives.rank_id#

nki.collectives.rank_id(name: Optional[str] = None)[source]#

Get the rank ID of the current rank.

Note

This returns a VirtualRegister today. In a future release it will return an NkiScalar.

Parameters:

name – (optional) name for the instruction.

Returns:

The rank ID of the current rank within the collective group

This document is relevant for: Trn2, Trn3