评价此页
★ ★ ★ ★ ★
intermediate/memory_format_tutorial

注意

跳转到结尾 以下载完整的示例代码。

PyTorch 中的通道最后内存格式#

创建日期：2020 年 4 月 20 日 | 最后更新：2025 年 7 月 09 日 | 最后验证：2024 年 11 月 05 日

作者：Vitaly Fedyunin

您将学到什么

  • PyTorch 中通道最后内存格式是什么？

  • 如何使用它来提高某些算子的性能？

先决条件

  • PyTorch v1.5.0

  • 一个支持 CUDA 的 GPU

通道最后内存格式是 NCHW 张量在内存中排序的一种替代方式，保留维度顺序。通道最后的张量以这样一种方式排序，使得通道成为最密集的维度（也即按像素存储图像）。

例如，经典（连续）存储的 NCHW 张量（在本例中，是两个 4x4 图像，具有 3 个颜色通道）如下所示

classic_memory_format

通道最后内存格式以不同的方式排序数据

channels_last_memory_format

PyTorch 通过利用现有的步长结构来支持内存格式。例如，通道最后格式的 10x3x16x16 批次将具有等于 (768, 1, 48, 3) 的步长。

通道最后内存格式仅对 4D NCHW 张量实现。

内存格式 API#

以下是如何在连续和通道最后内存格式之间转换张量。

经典的 PyTorch 连续张量

import torch

N, C, H, W = 10, 3, 32, 32
x = torch.empty(N, C, H, W)
print(x.stride())  # Outputs: (3072, 1024, 32, 1)

(3072, 1024, 32, 1)

转换算子

x = x.to(memory_format=torch.channels_last)
print(x.shape)  # Outputs: (10, 3, 32, 32) as dimensions order preserved
print(x.stride())  # Outputs: (3072, 1, 96, 3)

torch.Size([10, 3, 32, 32])
(3072, 1, 96, 3)

返回连续格式

x = x.to(memory_format=torch.contiguous_format)
print(x.stride())  # Outputs: (3072, 1024, 32, 1)

(3072, 1024, 32, 1)

另一种选择

x = x.contiguous(memory_format=torch.channels_last)
print(x.stride())  # Outputs: (3072, 1, 96, 3)

(3072, 1, 96, 3)

格式检查

print(x.is_contiguous(memory_format=torch.channels_last))  # Outputs: True

True

这两个 API to 和 contiguous 之间存在细微的差异。我们建议在显式转换张量的内存格式时使用 to。

在一般情况下，这两个 API 的行为相同。但是，在特殊情况下，对于大小为 NCHW 的 4D 张量，当满足以下条件时：C==1 或 H==1 && W==1，只有 to 才会生成适当的步长来表示通道最后内存格式。

这是因为在上述两种情况中的任何一种情况下，张量的内存格式都是模棱两可的，即大小为 N1HW 的连续张量在内存存储中既是 contiguous 又是通道最后的。因此，它们已经被认为是给定内存格式的 is_contiguous，因此 contiguous 调用将成为一个无操作，并且不会更新步长。相反，to 将使用有意义的步长重新步长张量，其大小为 1 的维度，以便正确表示预期的内存格式

special_x = torch.empty(4, 1, 4, 4)
print(special_x.is_contiguous(memory_format=torch.channels_last))  # Outputs: True
print(special_x.is_contiguous(memory_format=torch.contiguous_format))  # Outputs: True

True
True

同样适用于显式置换 API permute。在可能发生歧义的特殊情况下，permute 不能保证产生能够正确携带预期内存格式的步长。我们建议使用带有显式内存格式的 to 以避免意外行为。

另外需要注意的是，在极端情况下，所有三个非批处理维度都等于 1（C==1 && H==1 && W==1），当前的实现无法将张量标记为通道最后内存格式。

创建为通道最后格式

x = torch.empty(N, C, H, W, memory_format=torch.channels_last)
print(x.stride())  # Outputs: (3072, 1, 96, 3)

(3072, 1, 96, 3)

clone 保留内存格式

y = x.clone()
print(y.stride())  # Outputs: (3072, 1, 96, 3)

(3072, 1, 96, 3)

to、cuda、float … 保留内存格式

if torch.cuda.is_available():
    y = x.cuda()
    print(y.stride())  # Outputs: (3072, 1, 96, 3)

(3072, 1, 96, 3)

empty_like、*_like 算子保留内存格式

y = torch.empty_like(x)
print(y.stride())  # Outputs: (3072, 1, 96, 3)

(3072, 1, 96, 3)

逐点算子保留内存格式

z = x + y
print(z.stride())  # Outputs: (3072, 1, 96, 3)

(3072, 1, 96, 3)

Conv、Batchnorm 模块使用 cudnn 后端支持通道最后（仅适用于 cuDNN >= 7.6）。卷积模块与二进制逐点算子不同，通道最后是主要的内存格式。如果所有输入都采用连续内存格式，则算子将生成连续内存格式的输出。否则，输出将采用通道最后内存格式。

if torch.backends.cudnn.is_available() and torch.backends.cudnn.version() >= 7603:
    model = torch.nn.Conv2d(8, 4, 3).cuda().half()
    model = model.to(memory_format=torch.channels_last)  # Module parameters need to be channels last

    input = torch.randint(1, 10, (2, 8, 4, 4), dtype=torch.float32, requires_grad=True)
    input = input.to(device="cuda", memory_format=torch.channels_last, dtype=torch.float16)

    out = model(input)
    print(out.is_contiguous(memory_format=torch.channels_last))  # Outputs: True

True

当输入张量到达不支持通道最后的算子时，内核中应自动应用置换以恢复输入张量的连续性。这会引入开销并阻止通道最后内存格式的传播。尽管如此，它保证了正确的输出。

性能提升#

通道最后内存格式优化在 GPU 和 CPU 上均可用。在 GPU 上，在支持 Tensor Core 的 NVIDIA 硬件上运行于降低精度（torch.float16）时，可以观察到最显著的性能提升。我们能够通过通道最后与连续格式相比，实现超过 22% 的性能提升，同时利用 NVIDIA 提供的 ‘AMP（自动混合精度）’ 训练脚本 NVIDIA/apex。

python main_amp.py -a resnet50 --b 200 --workers 16 --opt-level O2  ./data

# opt_level = O2
# keep_batchnorm_fp32 = None <class 'NoneType'>
# loss_scale = None <class 'NoneType'>
# CUDNN VERSION: 7603
# => creating model 'resnet50'
# Selected optimization level O2:  FP16 training with FP32 batchnorm and FP32 master weights.
# Defaults for this optimization level are:
# enabled                : True
# opt_level              : O2
# cast_model_type        : torch.float16
# patch_torch_functions  : False
# keep_batchnorm_fp32    : True
# master_weights         : True
# loss_scale             : dynamic
# Processing user overrides (additional kwargs that are not None)...
# After processing overrides, optimization options are:
# enabled                : True
# opt_level              : O2
# cast_model_type        : torch.float16
# patch_torch_functions  : False
# keep_batchnorm_fp32    : True
# master_weights         : True
# loss_scale             : dynamic
# Epoch: [0][10/125] Time 0.866 (0.866) Speed 230.949 (230.949) Loss 0.6735125184 (0.6735) Prec@1 61.000 (61.000) Prec@5 100.000 (100.000)
# Epoch: [0][20/125] Time 0.259 (0.562) Speed 773.481 (355.693) Loss 0.6968704462 (0.6852) Prec@1 55.000 (58.000) Prec@5 100.000 (100.000)
# Epoch: [0][30/125] Time 0.258 (0.461) Speed 775.089 (433.965) Loss 0.7877287269 (0.7194) Prec@1 51.500 (55.833) Prec@5 100.000 (100.000)
# Epoch: [0][40/125] Time 0.259 (0.410) Speed 771.710 (487.281) Loss 0.8285319805 (0.7467) Prec@1 48.500 (54.000) Prec@5 100.000 (100.000)
# Epoch: [0][50/125] Time 0.260 (0.380) Speed 770.090 (525.908) Loss 0.7370464802 (0.7447) Prec@1 56.500 (54.500) Prec@5 100.000 (100.000)
# Epoch: [0][60/125] Time 0.258 (0.360) Speed 775.623 (555.728) Loss 0.7592862844 (0.7472) Prec@1 51.000 (53.917) Prec@5 100.000 (100.000)
# Epoch: [0][70/125] Time 0.258 (0.345) Speed 774.746 (579.115) Loss 1.9698858261 (0.9218) Prec@1 49.500 (53.286) Prec@5 100.000 (100.000)
# Epoch: [0][80/125] Time 0.260 (0.335) Speed 770.324 (597.659) Loss 2.2505953312 (1.0879) Prec@1 50.500 (52.938) Prec@5 100.000 (100.000)

传递 --channels-last true 允许以通道最后格式运行模型，观察到 22% 的性能提升。

python main_amp.py -a resnet50 --b 200 --workers 16 --opt-level O2 --channels-last true ./data

# opt_level = O2
# keep_batchnorm_fp32 = None <class 'NoneType'>
# loss_scale = None <class 'NoneType'>
#
# CUDNN VERSION: 7603
#
# => creating model 'resnet50'
# Selected optimization level O2:  FP16 training with FP32 batchnorm and FP32 master weights.
#
# Defaults for this optimization level are:
# enabled                : True
# opt_level              : O2
# cast_model_type        : torch.float16
# patch_torch_functions  : False
# keep_batchnorm_fp32    : True
# master_weights         : True
# loss_scale             : dynamic
# Processing user overrides (additional kwargs that are not None)...
# After processing overrides, optimization options are:
# enabled                : True
# opt_level              : O2
# cast_model_type        : torch.float16
# patch_torch_functions  : False
# keep_batchnorm_fp32    : True
# master_weights         : True
# loss_scale             : dynamic
#
# Epoch: [0][10/125] Time 0.767 (0.767) Speed 260.785 (260.785) Loss 0.7579724789 (0.7580) Prec@1 53.500 (53.500) Prec@5 100.000 (100.000)
# Epoch: [0][20/125] Time 0.198 (0.482) Speed 1012.135 (414.716) Loss 0.7007197738 (0.7293) Prec@1 49.000 (51.250) Prec@5 100.000 (100.000)
# Epoch: [0][30/125] Time 0.198 (0.387) Speed 1010.977 (516.198) Loss 0.7113101482 (0.7233) Prec@1 55.500 (52.667) Prec@5 100.000 (100.000)
# Epoch: [0][40/125] Time 0.197 (0.340) Speed 1013.023 (588.333) Loss 0.8943189979 (0.7661) Prec@1 54.000 (53.000) Prec@5 100.000 (100.000)
# Epoch: [0][50/125] Time 0.198 (0.312) Speed 1010.541 (641.977) Loss 1.7113249302 (0.9551) Prec@1 51.000 (52.600) Prec@5 100.000 (100.000)
# Epoch: [0][60/125] Time 0.198 (0.293) Speed 1011.163 (683.574) Loss 5.8537774086 (1.7716) Prec@1 50.500 (52.250) Prec@5 100.000 (100.000)
# Epoch: [0][70/125] Time 0.198 (0.279) Speed 1011.453 (716.767) Loss 5.7595844269 (2.3413) Prec@1 46.500 (51.429) Prec@5 100.000 (100.000)
# Epoch: [0][80/125] Time 0.198 (0.269) Speed 1011.827 (743.883) Loss 2.8196096420 (2.4011) Prec@1 47.500 (50.938) Prec@5 100.000 (100.000)

以下模型完全支持通道最后，在 Volta 设备上显示 8%-35% 的性能提升：alexnet、mnasnet0_5、mnasnet0_75、mnasnet1_0、mnasnet1_3、mobilenet_v2、resnet101、resnet152、resnet18、resnet34、resnet50、resnext50_32x4d、shufflenet_v2_x0_5、shufflenet_v2_x1_0、shufflenet_v2_x1_5、shufflenet_v2_x2_0、squeezenet1_0、squeezenet1_1、vgg11、vgg11_bn、vgg13、vgg13_bn、vgg16、vgg16_bn、vgg19、vgg19_bn、wide_resnet101_2、wide_resnet50_2

以下模型完全支持通道最后，在 Intel(R) Xeon(R) Ice Lake（或更新版本）CPU 上显示 26%-76% 的性能提升：alexnet、densenet121、densenet161、densenet169、googlenet、inception_v3、mnasnet0_5、mnasnet1_0、resnet101、resnet152、resnet18、resnet34、resnet50、resnext101_32x8d、resnext50_32x4d、shufflenet_v2_x0_5、shufflenet_v2_x1_0、squeezenet1_0、squeezenet1_1、vgg11、vgg11_bn、vgg13、vgg13_bn、vgg16、vgg16_bn、vgg19、vgg19_bn、wide_resnet101_2、wide_resnet50_2

转换现有模型#

通道最后支持不受现有模型限制，只要输入（或某些权重）格式正确，任何模型都可以转换为通道最后并在图中传播格式。

# Need to be done once, after model initialization (or load)
model = model.to(memory_format=torch.channels_last)  # Replace with your model

# Need to be done for every input
input = input.to(memory_format=torch.channels_last)  # Replace with your input
output = model(input)

然而，并非所有算子都完全转换为支持通道最后（通常会返回连续的输出）。在上面发布的示例中，不支持通道最后的层会停止内存格式的传播。尽管如此，由于我们已经将模型转换为通道最后格式，这意味着每个卷积层，其 4 维权重采用通道最后内存格式，将恢复通道最后内存格式并受益于更快的内核。

但是，不支持通道最后的算子会引入置换开销。您可以选择性地调查并识别模型中不支持通道最后的算子，如果您想提高转换后模型的性能。

这意味着您需要将使用的算子列表与支持的算子列表进行验证 pytorch/pytorch，或者在即时执行模式中引入内存格式检查并运行您的模型。

运行以下代码后，如果算子的输出与输入的内存格式不匹配，算子将引发异常。

def contains_cl(args):
    for t in args:
        if isinstance(t, torch.Tensor):
            if t.is_contiguous(memory_format=torch.channels_last) and not t.is_contiguous():
                return True
        elif isinstance(t, list) or isinstance(t, tuple):
            if contains_cl(list(t)):
                return True
    return False


def print_inputs(args, indent=""):
    for t in args:
        if isinstance(t, torch.Tensor):
            print(indent, t.stride(), t.shape, t.device, t.dtype)
        elif isinstance(t, list) or isinstance(t, tuple):
            print(indent, type(t))
            print_inputs(list(t), indent=indent + "    ")
        else:
            print(indent, t)


def check_wrapper(fn):
    name = fn.__name__

    def check_cl(*args, **kwargs):
        was_cl = contains_cl(args)
        try:
            result = fn(*args, **kwargs)
        except Exception as e:
            print("`{}` inputs are:".format(name))
            print_inputs(args)
            print("-------------------")
            raise e
        failed = False
        if was_cl:
            if isinstance(result, torch.Tensor):
                if result.dim() == 4 and not result.is_contiguous(memory_format=torch.channels_last):
                    print(
                        "`{}` got channels_last input, but output is not channels_last:".format(name),
                        result.shape,
                        result.stride(),
                        result.device,
                        result.dtype,
                    )
                    failed = True
        if failed and True:
            print("`{}` inputs are:".format(name))
            print_inputs(args)
            raise Exception("Operator `{}` lost channels_last property".format(name))
        return result

    return check_cl


old_attrs = dict()


def attribute(m):
    old_attrs[m] = dict()
    for i in dir(m):
        e = getattr(m, i)
        exclude_functions = ["is_cuda", "has_names", "numel", "stride", "Tensor", "is_contiguous", "__class__"]
        if i not in exclude_functions and not i.startswith("_") and "__call__" in dir(e):
            try:
                old_attrs[m][i] = e
                setattr(m, i, check_wrapper(e))
            except Exception as e:
                print(i)
                print(e)


attribute(torch.Tensor)
attribute(torch.nn.functional)
attribute(torch)

如果您发现一个不支持通道最后张量的算子并且想贡献代码，请随时使用以下开发者指南 pytorch/pytorch。

以下代码用于恢复 torch 的属性。

for (m, attrs) in old_attrs.items():
    for (k, v) in attrs.items():
        setattr(m, k, v)

待办事项#

仍有很多事情要做，例如：

  • 解决 N1HW 和 NC11 张量的歧义；

  • 测试分布式训练支持；

  • 提高算子覆盖率。

如果您有反馈和/或改进建议，请通过创建 一个 issue 告知我们。

结论#

本教程介绍了“通道最后”内存格式，并演示了如何使用它来获得性能提升。有关使用通道最后加速视觉模型的实际示例，请参阅 此处 的文章。

脚本总运行时间： (0 分钟 0.292 秒)

在此页面上
PyTorch 库