reference/generated/tensordict.TensorDictBase.from_remote_init

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

TensorDictBase.from_remote_init

classmethod TensorDictBase.from_remote_init(src: int, group: 'ProcessGroup' | None = None, device: device | None = None, use_broadcast: bool = False) → Self

Creates a new tensordict instance initialized from remotely sent metadata.

This class method receives consolidated metadata and a single storage buffer sent by init_remote(), then reconstructs the full tensordict.

Two transport modes are available (must match the sender’s choice):

• Point-to-point (default): uses recv_object_list + dist.recv. Only sender and receiver participate.

• Broadcast (use_broadcast=True): delegates to broadcast(). All ranks must participate.

Parameters:

• src (int) – The rank of the source process that sent the metadata.

• group ("ProcessGroup", optional) – The process group to use for communication. Defaults to None.

• device (device, optional) – The device to use for tensor operations. Defaults to None.

• use_broadcast (bool) – If True, use broadcast() instead of point-to-point recv. Must match the sender’s setting. Defaults to False.

Returns:

A new tensordict instance initialized with the received metadata and content.

Return type:

TensorDict

See also

The sending process should have called ~.init_remote to send the metadata and content.

Every tensordict class and every tensorclass has this method. For the other methods, see Methods by task.