get_communicator_metadata#

abstractmethod TensorTransportManager.get_communicator_metadata(src_actor: ray.actor.ActorHandle, dst_actor: ray.actor.ActorHandle, backend: str | None = None) → CommunicatorMetadata[source]#

Gets the CommunicatorMetadata for a send/recv. Ray calls this on the owner/driver process before orchestrating the transfer. You can typically implement this to return information both actors need to identify each other such as ranks in a collective group. Many forms of transports such as one-sided RDMA reads may be ok just returning empty CommunicatorMetadata here.

Parameters:

  • src_actor – The actor that runs this function.

  • dst_actor – The actor that runs this function.

  • backend – The backend to use for the collective operation.

Returns:

The communicator metadata.

Return type:

CommunicatorMetadata