reference/generated/tensordict.TensorDictBase.non_tensor_items

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

TensorDictBase.non_tensor_items

TensorDictBase.non_tensor_items(include_nested: bool = False)

Returns a tuple of the (key, value) pairs of the non-tensor data of the tensordict.

The values are NonTensorData (or NonTensorStack) instances. See Non-tensor data and unbatched entries.

Parameters:

include_nested (bool, optional) – if True, the non-tensor data of the nested tensordicts is also returned, under nested keys. Defaults to False.

Examples

>>> import torch
>>> from tensordict import TensorDict
>>> td = TensorDict(a=torch.zeros(2), s="text", nested=TensorDict(t="more"))
>>> [key for key, _ in td.non_tensor_items(include_nested=True)]
['s', ('nested', 't')]
>>> td.non_tensor_items()[0][1].data
'text'

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