reference/generated/tensordict.TensorDictBase.pin_memory_

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

TensorDictBase.pin_memory

TensorDictBase.pin_memory_(num_threads: int = 0) → Self

Calls pin_memory() on the stored tensors and returns the TensorDict modifies in-place.

Deprecated since version 0.15: Use pin_memory(inplace=True) instead. Pinning allocates new storage, so it does not fit the trailing-underscore convention. pin_memory_() pins on the main thread by default (num_threads=0); pass num_threads=0 to pin_memory() to keep that behavior.

Parameters:

num_threads (int, optional) – if provided, the number of threads to use to call pin_memory on the leaves. Defaults to 0.

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