Manipulating the shape of a TensorDict

作者: Tom Begley

在本教程中，您将学习如何操作 TensorDict 及其内容的形状。

当我们创建 TensorDict 时，我们会指定一个 batch_size，该 batch_size 必须与 TensorDict 中的所有条目的前导维度一致。由于我们保证所有条目共享这些共同的维度，因此 TensorDict 能够公开许多方法，我们可以用它们来操作 TensorDict 及其内容的形状。

import torch
from tensordict.tensordict import TensorDict

Indexing a TensorDict

由于保证批处理维度存在于所有条目上，我们可以按需对其进行索引，并且 TensorDict 的每个条目都将以相同的方式进行索引。

a = torch.rand(3, 4)
b = torch.rand(3, 4, 5)
tensordict = TensorDict({"a": a, "b": b}, batch_size=[3, 4])

indexed_tensordict = tensordict[:2, 1]
assert indexed_tensordict["a"].shape == torch.Size([2])
assert indexed_tensordict["b"].shape == torch.Size([2, 5])

Reshaping a TensorDict

TensorDict.reshape 的工作方式与 torch.Tensor.reshape() 类似。它应用于 TensorDict 沿批处理维度的所有内容——请注意下面示例中 b 的形状。它还会更新 batch_size 属性。

reshaped_tensordict = tensordict.reshape(-1)
assert reshaped_tensordict.batch_size == torch.Size([12])
assert reshaped_tensordict["a"].shape == torch.Size([12])
assert reshaped_tensordict["b"].shape == torch.Size([12, 5])

Splitting a TensorDict

TensorDict.split 类似于 torch.Tensor.split()。它将 TensorDict 分成块。每个块都是一个 TensorDict，其结构与原始 TensorDict 相同，但其条目是原始 TensorDict 中对应条目的视图。

chunks = tensordict.split([3, 1], dim=1)
assert chunks[0].batch_size == torch.Size([3, 3])
assert chunks[1].batch_size == torch.Size([3, 1])
torch.testing.assert_close(chunks[0]["a"], tensordict["a"][:, :-1])

注意

每当函数或方法接受 dim 参数时，负维度都将相对于函数或方法所调用的 TensorDict 的 batch_size 进行解释。特别是，如果存在具有不同批处理大小的嵌套 TensorDict 值，则负维度始终相对于根的批处理维度进行解释。

>>> tensordict = TensorDict(
...     {
...         "a": torch.rand(3, 4),
...         "nested": TensorDict({"b": torch.rand(3, 4, 5)}, [3, 4, 5])
...     },
...     [3, 4],
... )
>>> # dim = -2 will be interpreted as the first dimension throughout, as the root
>>> # TensorDict has 2 batch dimensions, even though the nested TensorDict has 3
>>> chunks = tensordict.split([2, 1], dim=-2)
>>> assert chunks[0].batch_size == torch.Size([2, 4])
>>> assert chunks[0]["nested"].batch_size == torch.Size([2, 4, 5])

从这个例子中可以看到，TensorDict.split 方法的作用与我们在调用之前将 dim=-2 替换为 dim=tensordict.batch_dims - 2 之前调用是完全一样的。

Unbind

TensorDict.unbind 类似于 torch.Tensor.unbind()，并且在概念上类似于 TensorDict.split。它会移除指定的维度，并沿着该维度返回所有切片组成的 tuple。

slices = tensordict.unbind(dim=1)
assert len(slices) == 4
assert all(s.batch_size == torch.Size([3]) for s in slices)
torch.testing.assert_close(slices[0]["a"], tensordict["a"][:, 0])

Stacking and concatenating

TensorDict 可以与 torch.cat 和 torch.stack 结合使用。

Stacking TensorDict

堆叠可以是惰性的或连续的。惰性堆叠只是一个 tensordicts 列表，表示为 tensordicts 的堆栈。它允许用户携带具有不同内容形状、设备或键集的 tensordicts 包。另一个优点是堆叠操作可能很昂贵，如果只需要一小部分键，惰性堆叠将比真正的堆叠快得多。它依赖于 LazyStackedTensorDict 类。在这种情况下，值将在访问时才按需堆叠。

from tensordict import LazyStackedTensorDict

cloned_tensordict = tensordict.clone()
stacked_tensordict = LazyStackedTensorDict.lazy_stack(
    [tensordict, cloned_tensordict], dim=0
)
print(stacked_tensordict)

# Previously, torch.stack was always returning a lazy stack. For consistency with
# the regular PyTorch API, this behaviour will soon be adapted to deliver only
# dense tensordicts. To control which behaviour you are relying on, you can use
# the :func:`~tensordict.utils.set_lazy_legacy` decorator/context manager:

from tensordict.utils import set_lazy_legacy

with set_lazy_legacy(True):  # old behaviour
    lazy_stack = torch.stack([tensordict, cloned_tensordict])
assert isinstance(lazy_stack, LazyStackedTensorDict)

with set_lazy_legacy(False):  # new behaviour
    dense_stack = torch.stack([tensordict, cloned_tensordict])
assert isinstance(dense_stack, TensorDict)

LazyStackedTensorDict(
    fields={
        a: Tensor(shape=torch.Size([2, 3, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        b: Tensor(shape=torch.Size([2, 3, 4, 5]), device=cpu, dtype=torch.float32, is_shared=False)},
    exclusive_fields={
    },
    batch_size=torch.Size([2, 3, 4]),
    device=None,
    is_shared=False,
    stack_dim=0)

如果我们沿着堆叠维度索引 LazyStackedTensorDict，我们将恢复原始的 TensorDict。

assert stacked_tensordict[0] is tensordict
assert stacked_tensordict[1] is cloned_tensordict

访问 LazyStackedTensorDict 中的键会导致这些值被堆叠。如果键对应于嵌套的 TensorDict，那么我们将恢复另一个 LazyStackedTensorDict。

assert stacked_tensordict["a"].shape == torch.Size([2, 3, 4])

注意

由于值是按需堆叠的，多次访问一个项意味着它会被堆叠多次，这是低效的。如果您需要多次访问堆叠的 TensorDict 中的一个值，您可能希望考虑将 LazyStackedTensorDict 转换为连续的 TensorDict，这可以通过 LazyStackedTensorDict.to_tensordict 或 LazyStackedTensorDict.contiguous 方法完成。

>>> assert isinstance(stacked_tensordict.contiguous(), TensorDict)
>>> assert isinstance(stacked_tensordict.contiguous(), TensorDict)

调用这些方法中的任何一个之后，我们将拥有一个包含堆叠值的常规 TensorDict，并且在访问值时不会执行额外的计算。

Concatenating TensorDict

连接不是按需进行的，而是调用 torch.cat() 于 TensorDict 实例列表，只需返回一个 TensorDict，其条目是列表中元素的连接条目。

concatenated_tensordict = torch.cat([tensordict, cloned_tensordict], dim=0)
assert isinstance(concatenated_tensordict, TensorDict)
assert concatenated_tensordict.batch_size == torch.Size([6, 4])
assert concatenated_tensordict["b"].shape == torch.Size([6, 4, 5])

Expanding TensorDict

我们可以使用 TensorDict.expand 来扩展 TensorDict 的所有条目。

exp_tensordict = tensordict.expand(2, *tensordict.batch_size)
assert exp_tensordict.batch_size == torch.Size([2, 3, 4])
torch.testing.assert_close(exp_tensordict["a"][0], exp_tensordict["a"][1])

Squeezing and Unsqueezing TensorDict

我们可以使用 squeeze() 和 unsqueeze() 方法来压缩或解压 TensorDict 的内容。

tensordict = TensorDict({"a": torch.rand(3, 1, 4)}, [3, 1, 4])
squeezed_tensordict = tensordict.squeeze()
assert squeezed_tensordict["a"].shape == torch.Size([3, 4])
print(squeezed_tensordict, end="\n\n")

unsqueezed_tensordict = tensordict.unsqueeze(-1)
assert unsqueezed_tensordict["a"].shape == torch.Size([3, 1, 4, 1])
print(unsqueezed_tensordict)

TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3, 4]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([3, 4]),
    device=None,
    is_shared=False)

TensorDict(
    fields={
        a: Tensor(shape=torch.Size([3, 1, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
    batch_size=torch.Size([3, 1, 4, 1]),
    device=None,
    is_shared=False)

注意

到目前为止，像 unsqueeze()、squeeze()、view()、permute()、transpose() 这样的操作，都返回这些操作的惰性版本（即，一个存储原始 tensordict 的容器，并且每次访问键时都会应用该操作）。这种行为将来会被弃用，并且已经可以通过 set_lazy_legacy() 函数来控制。

>>> with set_lazy_legacy(True):
...     lazy_unsqueeze = tensordict.unsqueeze(0)
>>> with set_lazy_legacy(False):
...     dense_unsqueeze = tensordict.unsqueeze(0)

请记住，一如既往，这些操作仅适用于批处理维度。条目的任何非批处理维度都不会受到影响。

tensordict = TensorDict({"a": torch.rand(3, 1, 1, 4)}, [3, 1])
squeezed_tensordict = tensordict.squeeze()
# only one of the singleton dimensions is dropped as the other
# is not a batch dimension
assert squeezed_tensordict["a"].shape == torch.Size([3, 1, 4])

Viewing a TensorDict

TensorDict 也支持 view。这会创建一个 _ViewedTensorDict，当访问其内容时，它会惰性地创建其内容的视图。

tensordict = TensorDict({"a": torch.arange(12)}, [12])
# no views are created at this step
viewed_tensordict = tensordict.view((2, 3, 2))

# the view of "a" is created on-demand when we access it
assert viewed_tensordict["a"].shape == torch.Size([2, 3, 2])

Permuting batch dimensions

TensorDict.permute 方法可以用于置换批处理维度，就像 torch.permute() 一样。非批处理维度保持不变。

此操作是惰性的，因此只有在尝试访问条目时才会置换批处理维度。一如既往，如果您可能需要多次访问特定条目，请考虑将其转换为 TensorDict。

tensordict = TensorDict({"a": torch.rand(3, 4), "b": torch.rand(3, 4, 5)}, [3, 4])
# swap the batch dimensions
permuted_tensordict = tensordict.permute([1, 0])

assert permuted_tensordict["a"].shape == torch.Size([4, 3])
assert permuted_tensordict["b"].shape == torch.Size([4, 3, 5])

Using tensordicts as decorators

对于许多可逆操作，tensordicts 可以用作装饰器。这些操作包括用于函数调用的 to_module()、unlock_() 和 lock_()，或形状操作，例如 view()、permute() transpose()、squeeze() 和 unsqueeze()。下面是一个使用 transpose 函数的简短示例。

tensordict = TensorDict({"a": torch.rand(3, 4), "b": torch.rand(3, 4, 5)}, [3, 4])

with tensordict.transpose(1, 0) as tdt:
    tdt.set("c", torch.ones(4, 3))  # we have permuted the dims

# the ``"c"`` entry is now in the tensordict we used as decorator:
#

assert (tensordict.get("c") == 1).all()

Gathering values in TensorDict

TensorDict.gather 方法可以用于沿着批处理维度进行索引，并将结果收集到一个维度中，就像 torch.gather() 一样。

index = torch.randint(4, (3, 4))
gathered_tensordict = tensordict.gather(dim=1, index=index)
print("index:\n", index, end="\n\n")
print("tensordict['a']:\n", tensordict["a"], end="\n\n")
print("gathered_tensordict['a']:\n", gathered_tensordict["a"], end="\n\n")

index:
 tensor([[3, 2, 3, 2],
        [0, 0, 2, 1],
        [2, 3, 3, 0]])

tensordict['a']:
 tensor([[0.8872, 0.9961, 0.1898, 0.6842],
        [0.8439, 0.8043, 0.0636, 0.3626],
        [0.3030, 0.8839, 0.7533, 0.9503]])

gathered_tensordict['a']:
 tensor([[0.6842, 0.1898, 0.6842, 0.1898],
        [0.8439, 0.8439, 0.0636, 0.8043],
        [0.7533, 0.9503, 0.9503, 0.3030]])