torch.nested¶

简介¶

警告

嵌套张量的 PyTorch API 处于原型阶段，将在不久的将来发生变化。

NestedTensor 允许用户将张量列表打包到一个高效的数据结构中。

输入张量的唯一约束是它们的维度必须匹配。

这使得更有效的元数据表示和对专用内核的访问成为可能。

NestedTensors 的一个应用是在各个领域表达顺序数据。虽然传统方法是对可变长度序列进行填充，但 NestedTensor 使得用户能够绕过填充。在嵌套张量上调用操作的 API 与常规 torch.Tensor 的 API 没有区别，这应该允许与现有模型无缝集成，主要区别在于输入的构造。

由于这是一个原型功能，支持的操作仍然有限。但是，我们欢迎问题、功能请求和贡献。有关贡献的更多信息，请参阅此自述文件。

构造¶

构建过程很简单，只需将一组张量传递给 torch.nested.nested_tensor 构造函数。

>>> a, b = torch.arange(3), torch.arange(5) + 3
>>> a
tensor([0, 1, 2])
>>> b
tensor([3, 4, 5, 6, 7])
>>> nt = torch.nested.nested_tensor([a, b])
>>> nt
nested_tensor([
  tensor([0, 1, 2]),
    tensor([3, 4, 5, 6, 7])
    ])

数据类型、设备和是否需要梯度可以通过常用的关键字参数进行选择。

>>> nt = torch.nested.nested_tensor([a, b], dtype=torch.float32, device="cuda", requires_grad=True)
>>> nt
nested_tensor([
  tensor([0., 1., 2.], device='cuda:0', requires_grad=True),
  tensor([3., 4., 5., 6., 7.], device='cuda:0', requires_grad=True)
], device='cuda:0', requires_grad=True)

类似于 torch.as_tensor，torch.nested.as_nested_tensor 可用于保留传递给构造函数的张量的自动梯度历史。有关更多信息，请参阅有关嵌套张量构造函数和转换函数的部分。

为了形成有效的嵌套张量，所有传递的张量在维度上需要匹配，但其他属性则不需要匹配。

>>> a = torch.randn(3, 50, 70) # image 1
>>> b = torch.randn(3, 128, 64) # image 2
>>> nt = torch.nested.nested_tensor([a, b], dtype=torch.float32)
>>> nt.dim()
4

如果其中一个维度不匹配，构造函数将抛出错误。

>>> a = torch.randn(50, 128) # text 1
>>> b = torch.randn(3, 128, 64) # image 2
>>> nt = torch.nested.nested_tensor([a, b], dtype=torch.float32)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: All Tensors given to nested_tensor must have the same dimension. Found dimension 3 for Tensor at index 1 and dimension 2 for Tensor at index 0.

请注意，传递的张量将被复制到一块连续的内存中。生成的嵌套张量将分配新的内存来存储它们，并且不会保留引用。

目前我们只支持一层嵌套，即一个简单的、扁平的张量列表。将来我们可以添加对多层嵌套的支持，例如一个完全由张量列表组成的列表。请注意，对于此扩展，重要的是在所有条目中保持一致的嵌套级别，以便生成的嵌套张量具有明确定义的维度。如果您需要此功能，请随时提交功能请求，以便我们能够跟踪它并进行相应的规划。

size¶

尽管嵌套张量不支持 .size()（或 .shape），但如果维度 i 是规则的，则它支持 .size(i)。

>>> a = torch.randn(50, 128) # text 1
>>> b = torch.randn(32, 128) # text 2
>>> nt = torch.nested.nested_tensor([a, b], dtype=torch.float32)
>>> nt.size(0)
2
>>> nt.size(1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: Given dimension 1 is irregular and does not have a size.
>>> nt.size(2)
128

如果所有维度都是规则的，则嵌套张量在语义上与常规 torch.Tensor 无异。

>>> a = torch.randn(20, 128) # text 1
>>> nt = torch.nested.nested_tensor([a, a], dtype=torch.float32)
>>> nt.size(0)
2
>>> nt.size(1)
20
>>> nt.size(2)
128
>>> torch.stack(nt.unbind()).size()
torch.Size([2, 20, 128])
>>> torch.stack([a, a]).size()
torch.Size([2, 20, 128])
>>> torch.equal(torch.stack(nt.unbind()), torch.stack([a, a]))
True

将来，我们可能会简化检测此条件并无缝转换的过程。

如果您需要此功能（或任何其他相关功能），请随时提交功能请求。

unbind¶

unbind 允许您检索组成部分的视图。

>>> import torch
>>> a = torch.randn(2, 3)
>>> b = torch.randn(3, 4)
>>> nt = torch.nested.nested_tensor([a, b], dtype=torch.float32)
>>> nt
nested_tensor([
  tensor([[ 1.2286, -1.2343, -1.4842],
          [-0.7827,  0.6745,  0.0658]]),
  tensor([[-1.1247, -0.4078, -1.0633,  0.8083],
          [-0.2871, -0.2980,  0.5559,  1.9885],
          [ 0.4074,  2.4855,  0.0733,  0.8285]])
])
>>> nt.unbind()
(tensor([[ 1.2286, -1.2343, -1.4842],
        [-0.7827,  0.6745,  0.0658]]), tensor([[-1.1247, -0.4078, -1.0633,  0.8083],
        [-0.2871, -0.2980,  0.5559,  1.9885],
        [ 0.4074,  2.4855,  0.0733,  0.8285]]))
>>> nt.unbind()[0] is not a
True
>>> nt.unbind()[0].mul_(3)
tensor([[ 3.6858, -3.7030, -4.4525],
        [-2.3481,  2.0236,  0.1975]])
>>> nt
nested_tensor([
  tensor([[ 3.6858, -3.7030, -4.4525],
          [-2.3481,  2.0236,  0.1975]]),
  tensor([[-1.1247, -0.4078, -1.0633,  0.8083],
          [-0.2871, -0.2980,  0.5559,  1.9885],
          [ 0.4074,  2.4855,  0.0733,  0.8285]])
])

请注意，nt.unbind()[0] 不是副本，而是底层内存的切片，它代表 NestedTensor 的第一个条目或组成部分。

嵌套张量构造函数和转换函数¶

以下函数与嵌套张量相关

torch.nested.nested_tensor(tensor_list, *, dtype=None, layout=None, device=None, requires_grad=False, pin_memory=False)[source]¶

从 tensor_list（一个张量列表）构造一个没有自动梯度历史的嵌套张量（也称为“叶子张量”，参见自动梯度机制）。

参数

tensor_list (List[array_like]) – 一个张量列表，或任何可以传递给 torch.tensor 的东西，
维度。 (其中列表的每个元素具有相同的) –

关键字参数

dtype (torch.dtype, 可选) – 返回的嵌套张量的所需类型。默认值：如果为 None，则与列表中最左侧张量相同的 torch.dtype。
layout (torch.layout, 可选) – 返回的嵌套张量的所需布局。仅支持步幅和锯齿布局。默认值：如果为 None，则为步幅布局。
device (torch.device, 可选) – 返回的嵌套张量的所需设备。默认值：如果为 None，则与列表中最左侧张量相同的 torch.device
requires_grad (bool, 可选) – 是否应记录对返回的嵌套张量的操作的自动梯度。默认值：False。
pin_memory (bool, 可选) – 如果设置，则返回的嵌套张量将在固定内存中分配。仅适用于 CPU 张量。默认值：False。

返回类型

张量

示例

>>> a = torch.arange(3, dtype=torch.float, requires_grad=True)
>>> b = torch.arange(5, dtype=torch.float, requires_grad=True)
>>> nt = torch.nested.nested_tensor([a, b], requires_grad=True)
>>> nt.is_leaf
True

torch.nested.as_nested_tensor(tensor_list, dtype=None, device=None, layout=None)[source]¶

从 tensor_list（一个张量列表）构造一个嵌套张量，保留自动梯度历史。

注意

由于当前嵌套张量的语义，列表中的张量始终会被此函数复制。

参数

tensor_list (List[Tensor]) – 一个具有相同 ndim 的张量列表

关键字参数

dtype (torch.dtype, 可选) – 返回的嵌套张量的所需类型。默认值：如果为 None，则与列表中最左侧张量相同的 torch.dtype。
device (torch.device, 可选) – 返回的嵌套张量的所需设备。默认值：如果为 None，则与列表中最左侧张量相同的 torch.device
layout (torch.layout, 可选) – 返回的嵌套张量的所需布局。仅支持步幅和锯齿布局。默认值：如果为 None，则为步幅布局。

返回类型

张量

示例

>>> a = torch.arange(3, dtype=torch.float, requires_grad=True)
>>> b = torch.arange(5, dtype=torch.float, requires_grad=True)
>>> nt = torch.nested.as_nested_tensor([a, b])
>>> nt.is_leaf
False
>>> fake_grad = torch.nested.nested_tensor([torch.ones_like(a), torch.zeros_like(b)])
>>> nt.backward(fake_grad)
>>> a.grad
tensor([1., 1., 1.])
>>> b.grad
tensor([0., 0., 0., 0., 0.])

torch.nested.to_padded_tensor(input, padding, output_size=None, out=None) → Tensor¶

通过填充 input 嵌套张量，返回一个新的（非嵌套）张量。前导条目将填充嵌套数据，而尾随条目将被填充。

警告

to_padded_tensor() 始终复制底层数据，因为嵌套张量和非嵌套张量的内存布局不同。

参数

padding (float) – 尾随条目的填充值。

关键字参数

output_size (Tuple[int]) – 输出张量的尺寸。如果给出，它必须足够大以包含所有嵌套数据；否则，将通过获取每个嵌套子张量沿每个维度的最大尺寸来推断。
out (Tensor, optional) – 输出张量。

示例

>>> nt = torch.nested.nested_tensor([torch.randn((2, 5)), torch.randn((3, 4))])
nested_tensor([
  tensor([[ 1.6862, -1.1282,  1.1031,  0.0464, -1.3276],
          [-1.9967, -1.0054,  1.8972,  0.9174, -1.4995]]),
  tensor([[-1.8546, -0.7194, -0.2918, -0.1846],
          [ 0.2773,  0.8793, -0.5183, -0.6447],
          [ 1.8009,  1.8468, -0.9832, -1.5272]])
])
>>> pt_infer = torch.nested.to_padded_tensor(nt, 0.0)
tensor([[[ 1.6862, -1.1282,  1.1031,  0.0464, -1.3276],
         [-1.9967, -1.0054,  1.8972,  0.9174, -1.4995],
         [ 0.0000,  0.0000,  0.0000,  0.0000,  0.0000]],
        [[-1.8546, -0.7194, -0.2918, -0.1846,  0.0000],
         [ 0.2773,  0.8793, -0.5183, -0.6447,  0.0000],
         [ 1.8009,  1.8468, -0.9832, -1.5272,  0.0000]]])
>>> pt_large = torch.nested.to_padded_tensor(nt, 1.0, (2, 4, 6))
tensor([[[ 1.6862, -1.1282,  1.1031,  0.0464, -1.3276,  1.0000],
         [-1.9967, -1.0054,  1.8972,  0.9174, -1.4995,  1.0000],
         [ 1.0000,  1.0000,  1.0000,  1.0000,  1.0000,  1.0000],
         [ 1.0000,  1.0000,  1.0000,  1.0000,  1.0000,  1.0000]],
        [[-1.8546, -0.7194, -0.2918, -0.1846,  1.0000,  1.0000],
         [ 0.2773,  0.8793, -0.5183, -0.6447,  1.0000,  1.0000],
         [ 1.8009,  1.8468, -0.9832, -1.5272,  1.0000,  1.0000],
         [ 1.0000,  1.0000,  1.0000,  1.0000,  1.0000,  1.0000]]])
>>> pt_small = torch.nested.to_padded_tensor(nt, 2.0, (2, 2, 2))
RuntimeError: Value in output_size is less than NestedTensor padded size. Truncation is not supported.

支持的操作¶

在本节中，我们总结了当前在 NestedTensor 上支持的操作以及它们可能存在的任何约束。

PyTorch 操作	约束
`torch.matmul()`	支持两个（>= 3 维）嵌套张量之间的矩阵乘法，其中最后两个维度是矩阵维度，前导（批次）维度具有相同的大小（即批次维度目前不支持广播）。
`torch.bmm()`	支持两个 3 维嵌套张量的批次矩阵乘法。
`torch.nn.Linear()`	支持 3 维嵌套输入和密集的 2 维权重矩阵。
`torch.nn.functional.softmax()`	支持除 dim=0 之外的所有维度的 softmax。
`torch.nn.Dropout()`	行为与普通张量相同。
`torch.Tensor.masked_fill()`	行为与普通张量相同。
`torch.relu()`	行为与普通张量相同。
`torch.gelu()`	行为与普通张量相同。
`torch.silu()`	行为与普通张量相同。
`torch.abs()`	行为与普通张量相同。
`torch.sgn()`	行为与普通张量相同。
`torch.logical_not()`	行为与普通张量相同。
`torch.neg()`	行为与普通张量相同。
`torch.sub()`	支持两个嵌套张量的逐元素减法。
`torch.add()`	支持两个嵌套张量的逐元素加法。支持将标量加到嵌套张量中。
`torch.mul()`	支持两个嵌套张量的逐元素乘法。支持将嵌套张量乘以标量。
`torch.select()`	支持沿所有维度选择。
`torch.clone()`	行为与普通张量相同。
`torch.detach()`	行为与普通张量相同。
`torch.unbind()`	仅支持沿 `dim=0` 解绑。
`torch.reshape()`	支持保留 `dim=0` 大小的重塑（即嵌套张量的数量不能改变）。与普通张量不同，这里的 `-1` 大小意味着继承现有大小。特别是，不规则维度的唯一有效大小是 `-1`。大小推断尚未实现，因此对于新维度，大小不能为 `-1`。
`torch.Tensor.reshape_as()`	与 `reshape` 类似的约束。
`torch.transpose()`	支持除 `dim=0` 之外的所有维度的转置。
`torch.Tensor.view()`	新形状的规则类似于 `reshape`。
`torch.empty_like()`	行为类似于普通张量；返回一个新的空嵌套张量（即具有未初始化的值），匹配输入的嵌套结构。
`torch.randn_like()`	行为类似于普通张量；返回一个新的嵌套张量，其值根据与输入嵌套结构匹配的标准正态分布随机初始化。
`torch.zeros_like()`	行为类似于普通张量；返回一个新的嵌套张量，其所有值为零，与输入的嵌套结构匹配。
`torch.nn.LayerNorm()`	`normalized_shape` 参数限制为不扩展到 NestedTensor 的不规则维度。

torch.nested¶

简介¶

构造¶

size¶

unbind¶

嵌套张量构造函数和转换函数¶

支持的操作¶

文档

教程

资源