reference/generated/tensordict.TensorDictBase.recv

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

TensorDictBase.recv

TensorDictBase.recv(src: int | 'TensorDictPipe' | None = None, *, group: 'torch.distributed.ProcessGroup' | None = None, group_src: int | None = None, init_tag: int = 0, pseudo_rand: bool = False, consolidated: bool = False) → int

Receives the content of a tensordict and updates content with it.

Check the example in the send method for context.

Parameters:

src (int or TensorDictPipe, optional) – the global rank of the source worker, or a TensorDictPipe for UCXX-based transport. When a pipe is passed, the data is received in-place into this tensordict’s consolidated storage (if available and its layout matches the received data); otherwise the pipe returns a tensordict of its own, so use the returned value. Mutually exclusive with group_src; exactly one of the two must be provided.

Keyword Arguments:

• group (torch.distributed.ProcessGroup, optional) – if set, the specified process group will be used for communication. Otherwise, the default process group will be used. Defaults to None.

• group_src (int, optional) – the rank of the source worker relative to group. Requires group to be passed and is mutually exclusive with src. When set, the p2p calls are issued directly on the group’s backend, so group may be a standalone ProcessGroup built against a store (never registered through init_process_group() or new_group()). Defaults to None.

• init_tag (int) – the init_tag used by the source worker.

• pseudo_rand (bool) – if True, the sequence of tags will be pseudo- random, allowing to send multiple data from different nodes without overlap. Notice that the generation of these pseudo-random numbers is expensive (1e-5 sec/number), meaning that it could slow down the runtime of your algorithm. This value must match the one passed to send(). Defaults to False.

• consolidated (bool) – if True, receives a single consolidated storage tensor directly into self._consolidated["storage"]. The tensordict must already be consolidated (e.g. from a prior from_remote_init() call). All leaf tensor views update in-place automatically. Defaults to False.

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