reference/generated/tensordict.unravel_key_to_tuple

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

unravel_key_to_tuple

tensordict.unravel_key_to_tuple(key: NestedKey) → tuple[str, ...]

Unravels a nested key into a flat tuple of str.

Unlike unravel_key(), a str key gives a one-element tuple, and an invalid key gives () instead of raising.

Parameters:

key (NestedKey) – the key to unravel.

Returns:

A flat tuple of str, or () if key is not a valid nested key.

Examples

>>> from tensordict import unravel_key_to_tuple
>>> unravel_key_to_tuple("a")
('a',)
>>> unravel_key_to_tuple(("a", ("b", ("c",))))
('a', 'b', 'c')
>>> unravel_key_to_tuple(("a", 1))
()
>>> unravel_key_to_tuple(1)
()