评价此页

★ ★ ★ ★ ★

命名张量#

创建日期: 2019年10月08日 | 最后更新日期: 2025年06月14日

命名张量允许用户为张量维度指定显式名称。在大多数情况下，接受维度参数的操作都会接受维度名称，从而无需按位置跟踪维度。此外，命名张量使用名称自动检查 API 在运行时是否正确使用，提供额外的安全性。名称还可以用于重新排列维度，例如，支持“按名称广播”而不是“按位置广播”。

警告

The named tensor API is a prototype feature and subject to change.

创建命名张量#

工厂函数现在接受一个新的 names 参数，该参数将名称与每个维度关联起来。

    >>> torch.zeros(2, 3, names=('N', 'C'))
    tensor([[0., 0., 0.],
            [0., 0., 0.]], names=('N', 'C'))

命名维度，就像常规张量维度一样，是有序的。tensor.names[i] 是 tensor 的第 i 个维度的名称。

以下工厂函数支持命名张量

命名维度#

有关张量名称的限制，请参阅 names。

使用 names 访问张量的维度名称，使用 rename() 重命名命名维度。

    >>> imgs = torch.randn(1, 2, 2, 3 , names=('N', 'C', 'H', 'W'))
    >>> imgs.names
    ('N', 'C', 'H', 'W')

    >>> renamed_imgs = imgs.rename(H='height', W='width')
    >>> renamed_imgs.names
    ('N', 'C', 'height', 'width)

命名张量可以与未命名张量共存；命名张量是 torch.Tensor 的实例。未命名张量的维度名称为 None。命名张量不需要所有维度都命名。

    >>> imgs = torch.randn(1, 2, 2, 3 , names=(None, 'C', 'H', 'W'))
    >>> imgs.names
    (None, 'C', 'H', 'W')

名称传播语义#

命名张量使用名称在运行时自动检查 API 的调用是否正确。这个过程称为名称推断。更正式地说，名称推断包括以下两个步骤：

检查名称：操作符可能会在运行时执行自动检查，以确保某些维度名称必须匹配。
传播名称：名称推断将名称传播到输出张量。

所有支持命名张量的操作都会传播名称。

    >>> x = torch.randn(3, 3, names=('N', 'C'))
    >>> x.abs().names
    ('N', 'C')

匹配语义#

两个名称匹配，如果它们相等（字符串相等）或至少一个为 None。None 基本上是一个特殊的“通配符”名称。

unify(A, B) 确定 A 和 B 中的哪个名称将被传播到输出。如果名称匹配，它会返回两个名称中更具体的那个。如果名称不匹配，则会报错。

注意

实际上，在使用命名张量时，应避免使用未命名维度，因为它们的处理可能会很复杂。建议使用 refine_names() 将所有未命名维度提升为命名维度。

基本名称推断规则#

让我们看看在没有广播的情况下，将两个一维张量相加时，match 和 unify 如何用于名称推断。

    x = torch.randn(3, names=('X',))
    y = torch.randn(3)
    z = torch.randn(3, names=('Z',))

检查名称：检查两个张量的名称是否匹配。

对于以下示例：

    >>> # x + y  # match('X', None) is True
    >>> # x + z  # match('X', 'Z') is False
    >>> # x + x  # match('X', 'X') is True

    >>> x + z
    Error when attempting to broadcast dims ['X'] and dims ['Z']: dim 'X' and dim 'Z' are at the same position from the right but do not match.

传播名称：合并名称以选择要传播的名称。在 x + y 的情况下，unify('X', None) = 'X'，因为 'X' 比 None 更具体。

    >>> (x + y).names
    ('X',)
    >>> (x + x).names
    ('X',)

有关名称推断规则的完整列表，请参阅命名张量操作覆盖范围。以下是两个可能对您有用的常见操作：

二元算术运算：从输入合并名称
矩阵乘法运算：收缩维度

按名称显式对齐#

使用 align_as() 或 align_to() 按名称将张量维度与指定的顺序对齐。这对于执行“按名称广播”很有用（请参阅示例）。

    # This function is agnostic to the dimension ordering of `input`,
    # as long as it has a `C` dimension somewhere.
    def scale_channels(input, scale):
        scale = scale.refine_names('C')
        return input * scale.align_as(input)

    >>> num_channels = 3
    >>> scale = torch.randn(num_channels, names=('C',))
    >>> imgs = torch.rand(3, 3, 3, num_channels, names=('N', 'H', 'W', 'C'))
    >>> more_imgs = torch.rand(3, num_channels, 3, 3, names=('N', 'C', 'H', 'W'))
    >>> videos = torch.randn(3, num_channels, 3, 3, 3, names=('N', 'C', 'H', 'W', 'D')

    >>> scale_channels(imgs, scale)
    >>> scale_channels(more_imgs, scale)
    >>> scale_channels(videos, scale)

操作维度#

使用 align_to() 来排列大量维度，而无需像 permute() 所要求的那样提及所有维度。

    >>> tensor = torch.randn(2, 2, 2, 2, 2, 2)
    >>> named_tensor = tensor.refine_names('A', 'B', 'C', 'D', 'E', 'F')

    # Move the F (dim 5) and E dimension (dim 4) to the front while keeping
    # the rest in the same order
    >>> tensor.permute(5, 4, 0, 1, 2, 3)
    >>> named_tensor.align_to('F', 'E', ...)

使用 flatten() 和 unflatten() 分别来展平（flatten）和解展平（unflatten）维度。这些方法比 view() 和 reshape() 更冗长，但对于阅读代码的人来说，它们具有更多的语义意义。

    >>> imgs = torch.randn(32, 3, 128, 128)
    >>> named_imgs = imgs.refine_names('N', 'C', 'H', 'W')

    >>> flat_imgs = imgs.view(32, -1)
    >>> named_flat_imgs = named_imgs.flatten(['C', 'H', 'W'], 'features')
    >>> named_flat_imgs.names
    ('N', 'features')

    >>> unflattened_named_imgs = named_flat_imgs.unflatten('features', [('C', 3), ('H', 128), ('W', 128)])
    >>> unflattened_named_imgs.names
    ('N', 'C', 'H', 'W')

自动微分支持#

自动微分目前以有限的方式支持命名张量：自动微分会忽略所有张量上的名称。梯度计算仍然正确，但我们失去了名称提供的安全性。

    >>> x = torch.randn(3, names=('D',))
    >>> weight = torch.randn(3, names=('D',), requires_grad=True)
    >>> loss = (x - weight).abs()
    >>> grad_loss = torch.randn(3)
    >>> loss.backward(grad_loss)
    >>> weight.grad  # Unnamed for now. Will be named in the future
    tensor([-1.8107, -0.6357,  0.0783])

    >>> weight.grad.zero_()
    >>> grad_loss = grad_loss.refine_names('C')
    >>> loss = (x - weight).abs()
    # Ideally we'd check that the names of loss and grad_loss match but we don't yet.
    >>> loss.backward(grad_loss)
    >>> weight.grad
    tensor([-1.8107, -0.6357,  0.0783])

当前支持的操作和子系统#

操作符#

有关支持的 torch 和 tensor 操作的完整列表，请参阅命名张量操作覆盖范围。我们尚未支持链接中未涵盖的内容：

索引，高级索引。

对于 torch.nn.functional 操作符，我们支持以下内容：

子系统#

自动微分受支持，请参阅自动微分支持。由于梯度目前是未命名的，优化器可能可以工作，但未经测试。

神经网络模块目前不受支持。这可能导致在调用带有命名张量输入的模块时出现以下情况：

神经网络模块参数是未命名的，因此输出可能是部分命名的。
神经网络模块的前向传播包含不支持命名张量的代码，并会相应地报错。

我们也不支持以下子系统，尽管其中一些可能开箱即用：

分布
序列化（torch.load(), torch.save()）
多进程
JIT
分布式
ONNX

如果其中任何一项对您的用例有帮助，请搜索是否已提交相关 issue，如果没有，请提交一个 issue。

命名张量 API 参考#

在本节中，请查找命名张量特定 API 的文档。有关名称如何通过其他 PyTorch 操作传播的全面参考，请参阅命名张量操作覆盖范围。

class torch.Tensor

names#

存储此张量每个维度的名称。

names[idx] 对应于张量维度 idx 的名称。名称可以是字符串（如果维度已命名）或 None（如果维度未命名）。

维度名称可以包含字母或下划线。此外，维度名称必须是有效的 Python 变量名（即，不能以下划线开头）。

张量不能有两个同名的命名维度。

警告

命名张量 API 是实验性的，可能会发生更改。

rename(*names, **rename_map)[source]#

重命名 self 的维度名称。

主要有两种用法：

self.rename(**rename_map) 返回一个张量的视图，其中维度根据 rename_map 中的映射进行重命名。

self.rename(*names) 返回一个张量的视图，使用 names 按位置重命名所有维度。使用 self.rename(None) 可以删除张量上的名称。

不能同时指定位置参数 names 和关键字参数 rename_map。

示例

>>> imgs = torch.rand(2, 3, 5, 7, names=('N', 'C', 'H', 'W'))
>>> renamed_imgs = imgs.rename(N='batch', C='channels')
>>> renamed_imgs.names
('batch', 'channels', 'H', 'W')

>>> renamed_imgs = imgs.rename(None)
>>> renamed_imgs.names
(None, None, None, None)

>>> renamed_imgs = imgs.rename('batch', 'channel', 'height', 'width')
>>> renamed_imgs.names
('batch', 'channel', 'height', 'width')

警告

命名张量 API 是实验性的，可能会发生更改。

rename_(*names, **rename_map)[source]#: 原地版本的 rename()。

refine_names(*names)[source]#

根据 names 精炼 self 的维度名称。

精炼是重命名的特殊情况，它“提升”未命名的维度。一个 None 维度可以被精炼为任何名称；一个已命名维度只能被精炼为相同的名称。

由于命名张量可以与未命名张量共存，因此细化名称提供了一种很好的方式来编写既适用于命名张量又适用于未命名张量的命名张量感知代码。

names 最多可以包含一个省略号（...）。省略号被贪婪地展开；它被原地展开以填充 names，使其长度与 self.dim() 相同，使用 self.names 中相应索引的名称。

Python 2 不支持省略号，但可以使用字符串字面量（'...'）代替。

参数:: names (iterable of str) – 输出张量的期望名称。最多可以包含一个省略号。

示例

>>> imgs = torch.randn(32, 3, 128, 128)
>>> named_imgs = imgs.refine_names('N', 'C', 'H', 'W')
>>> named_imgs.names
('N', 'C', 'H', 'W')

>>> tensor = torch.randn(2, 3, 5, 7, 11)
>>> tensor = tensor.refine_names('A', ..., 'B', 'C')
>>> tensor.names
('A', None, None, 'B', 'C')

警告

命名张量 API 是实验性的，可能会发生更改。

align_as(other) → Tensor#

排列 self 张量的维度，使其与 other 张量中的维度顺序匹配，并为任何新名称添加大小为一的维度。

此操作对于显式按名称广播很有用（请参阅示例）。

要使用此方法，self 的所有维度都必须已命名。生成的张量是原始张量的视图。

self 的所有维度名称都必须存在于 other.names 中。other 可能包含不在 self.names 中的命名维度；输出张量为这些新名称中的每一个都将有一个大小为一的维度。

要将张量对齐到特定顺序，请使用 align_to()。

示例

# Example 1: Applying a mask
>>> mask = torch.randint(2, [127, 128], dtype=torch.bool).refine_names('W', 'H')
>>> imgs = torch.randn(32, 128, 127, 3, names=('N', 'H', 'W', 'C'))
>>> imgs.masked_fill_(mask.align_as(imgs), 0)


# Example 2: Applying a per-channel-scale
>>> def scale_channels(input, scale):
>>>    scale = scale.refine_names('C')
>>>    return input * scale.align_as(input)

>>> num_channels = 3
>>> scale = torch.randn(num_channels, names=('C',))
>>> imgs = torch.rand(32, 128, 128, num_channels, names=('N', 'H', 'W', 'C'))
>>> more_imgs = torch.rand(32, num_channels, 128, 128, names=('N', 'C', 'H', 'W'))
>>> videos = torch.randn(3, num_channels, 128, 128, 128, names=('N', 'C', 'H', 'W', 'D'))

# scale_channels is agnostic to the dimension order of the input
>>> scale_channels(imgs, scale)
>>> scale_channels(more_imgs, scale)
>>> scale_channels(videos, scale)

警告

命名张量 API 是实验性的，可能会发生更改。

align_to(*names)[source]#

排列 self 张量的维度，使其与 names 中指定的顺序匹配，并为任何新名称添加大小为一的维度。

要使用此方法，self 的所有维度都必须已命名。生成的张量是原始张量的视图。

self 的所有维度名称都必须存在于 names 中。names 可能包含不在 self.names 中的额外名称；输出张量为这些新名称中的每一个都将有一个大小为一的维度。

names 最多可以包含一个省略号（...）。省略号被展开以等于 names 中未提及的 self 的所有维度名称，按它们在 self 中出现的顺序。

Python 2 不支持省略号，但可以使用字符串字面量（'...'）代替。

参数:: names (iterable of str) – 输出张量的期望维度顺序。最多可以包含一个省略号，该省略号将被展开为 self 中所有未提及的维度名称。

示例

>>> tensor = torch.randn(2, 2, 2, 2, 2, 2)
>>> named_tensor = tensor.refine_names('A', 'B', 'C', 'D', 'E', 'F')

# Move the F and E dims to the front while keeping the rest in order
>>> named_tensor.align_to('F', 'E', ...)

警告

命名张量 API 是实验性的，可能会发生更改。

flatten(dims, out_dim) → Tensor

将 dims 展平为一个名为 out_dim 的单一维度。

dims 中的所有维度在 self 张量中必须是连续的，但不一定在内存中是连续的。

示例

>>> imgs = torch.randn(32, 3, 128, 128, names=('N', 'C', 'H', 'W'))
>>> flat_imgs = imgs.flatten(['C', 'H', 'W'], 'features')
>>> flat_imgs.names, flat_imgs.shape
(('N', 'features'), torch.Size([32, 49152]))

警告

命名张量 API 是实验性的，可能会发生更改。

命名张量#

创建命名张量#

命名维度#

名称传播语义#

匹配语义#

基本名称推断规则#

按名称显式对齐#

操作维度#

自动微分支持#

当前支持的操作和子系统#

操作符#

子系统#

命名张量 API 参考#

文档

教程

资源