reference/generated/tensordict.utils.LinkedList

Run in Google Colab

Colab

Download Notebook

Notebook

View on GitHub

GitHub

LinkedList

class tensordict.utils.LinkedList(*args, td: TensorDictBase, **kwargs)

Bases: list

A list of the values of a non-tensor entry that writes item assignments back to the tensordict.

td[key] returns a LinkedList when the entry is a NonTensorStack. Setting an item (values[0] = "z") writes the value to the tensordict. append and extend change the list only, and unlink it from the tensordict.

Examples

>>> from tensordict import TensorDict
>>> td = TensorDict(batch_size=[3])
>>> td["names"] = ["a", "b", "c"]
>>> values = td["names"]
>>> values[0] = "z"
>>> td.get("names").tolist()
['z', 'b', 'c']

append(object: Any) → None

Append object to the end of the list.

clear() → None

Remove all items from list.

extend(object: Any) → None

Extend list by appending elements from the iterable.

insert(index: int, object: Any) → None

Insert object before index.

pop(index: int = -1) → Any

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove(value: Any) → None

Remove first occurrence of value.

Raises ValueError if the value is not present.