recipes/xeon_run_cpu

在 Google Colab 中运行

Colab

下载 Notebook

Notebook

在 GitHub 上查看

GitHub

使用 run_cpu 脚本优化 Intel® Xeon® CPU 性能

创建日期：2024 年 6 月 25 日 | 最后更新：2025 年 7 月 1 日 | 最后验证：2024 年 11 月 5 日

在 Intel® Xeon® 可扩展处理器上执行 PyTorch 推理时，有多种配置选项会影响性能。为了获得最佳性能，提供了 torch.backends.xeon.run_cpu 脚本，该脚本可优化线程和内存管理配置。对于线程管理，该脚本配置线程亲和性和 Intel® OMP 库的预加载。对于内存管理，它配置 NUMA 绑定并预加载优化的内存分配库，例如 TCMalloc 和 JeMalloc。此外，该脚本为单实例和多实例场景中的计算资源分配提供了可调参数，帮助用户为特定工作负载尝试最优的资源利用协调。

您将学到什么

• 如何利用 numactl、taskset、Intel® OpenMP 运行时库以及 TCMalloc 和 JeMalloc 等优化内存分配器来提高性能。

• 如何配置 CPU 资源和内存管理，以最大化 PyTorch 在 Intel® Xeon® 处理器上的推理性能。

优化介绍

应用 NUMA 访问控制

单个插槽内为用户提供越来越多的 CPU 核心是有益的，因为这提供了更大的计算资源。然而，这也会导致内存访问竞争，从而可能由于繁忙的内存而导致程序停滞。为解决此问题，引入了非统一内存访问 (NUMA)。与所有内存均可被所有核心均等访问的统一内存访问 (UMA) 不同，NUMA 将内存组织成多个组。一定数量的内存直接连接到一个插槽的集成内存控制器，成为该插槽的本地内存。本地内存访问比远程内存访问快得多。

用户可以通过 Linux 上的 lscpu 命令获取 CPU 信息，以了解机器上有多少核心和插槽。此外，此命令还提供 NUMA 信息，例如 CPU 核心的分布。下面是在配备 Intel® Xeon® CPU Max 9480 的机器上执行 lscpu 的示例。

$ lscpu
...
CPU(s):                  224
  On-line CPU(s) list:   0-223
Vendor ID:               GenuineIntel
  Model name:            Intel (R) Xeon (R) CPU Max 9480
    CPU family:          6
    Model:               143
    Thread(s) per core:  2
    Core(s) per socket:  56
    Socket(s):           2
...
NUMA:
  NUMA node(s):          2
  NUMA node0 CPU(s):     0-55,112-167
  NUMA node1 CPU(s):     56-111,168-223
...

• 检测到两个插槽，每个插槽包含 56 个物理核心。启用超线程后，每个核心可以处理 2 个线程，每个插槽有 56 个逻辑核心。因此，该机器共有 224 个 CPU 核心投入使用。

• 通常，物理核心的索引在前，逻辑核心的索引在后。在此场景下，核心 0-55 是第一个 NUMA 节点上的物理核心，核心 56-111 是第二个 NUMA 节点上的物理核心。

• 逻辑核心的索引随后：核心 112-167 对应于第一个 NUMA 节点上的逻辑核心，核心 168-223 对应于第二个 NUMA 节点上的逻辑核心。

通常，运行具有计算密集型工作负载的 PyTorch 程序应避免使用逻辑核心以获得良好性能。

Linux 提供了一个名为 numactl 的工具，它允许用户控制进程或共享内存的 NUMA 策略。它以特定的 NUMA 调度或内存放置策略运行进程。如上所述，核心在同一插槽中共享高速缓存，因此最好避免跨插槽计算。从内存访问的角度来看，将内存访问绑定到本地比访问远程内存要快得多。numactl 命令应已在最近的 Linux 发行版中安装。如果缺少，您可以手动安装它，例如在 Ubuntu 上：

$ apt-get install numactl

在 CentOS 上，您可以运行以下命令：

$ yum install numactl

Linux 中的 taskset 命令是另一个强大的实用程序，它允许您设置或检索正在运行的进程的 CPU 亲和性。taskset 在大多数 Linux 发行版中都预装了，如果未安装，在 Ubuntu 上您可以使用以下命令安装：

$ apt-get install util-linux

在 CentOS 上，您可以运行以下命令：

$ yum install util-linux

使用 Intel® OpenMP 运行时库

OpenMP 是多线程的一种实现，多线程是一种并行化方法，其中主线程（连续执行的一系列指令）分叉指定数量的子线程，系统将任务分配给它们。然后线程并发运行，运行时环境将线程分配到不同的处理器。用户可以通过一些环境变量设置来控制 OpenMP 的行为以适应其工作负载，这些设置由 OMP 库读取和执行。默认情况下，PyTorch 使用 GNU OpenMP 库 (GNU libgomp) 进行并行计算。在 Intel® 平台上，Intel® OpenMP 运行时库 (libiomp) 提供 OpenMP API 规范支持。与 libgomp 相比，它通常能带来更多性能优势。

可以使用以下命令之一安装 Intel® OpenMP 运行时库：

$ pip install intel-openmp

或

$ conda install mkl

选择优化的内存分配器

从性能角度来看，内存分配器也扮演着重要角色。更高效的内存使用可以减少不必要的内存分配或销毁的开销，从而提高执行速度。根据实践经验，对于深度学习工作负载，TCMalloc 或 JeMalloc 通过尽可能重用内存比默认的 malloc 操作可以获得更好的性能。

您可以通过在 Ubuntu 上运行以下命令来安装 TCMalloc：

$ apt-get install google-perftools

在 CentOS 上，您可以运行以下命令进行安装：

$ yum install gperftools

在 conda 环境中，也可以通过运行以下命令进行安装：

$ conda install conda-forge::gperftools

在 Ubuntu 上，可以使用此命令安装 JeMalloc：

$ apt-get install libjemalloc2

在 CentOS 上，可以通过运行以下命令进行安装：

$ yum install jemalloc

在 conda 环境中，也可以通过运行以下命令进行安装：

$ conda install conda-forge::jemalloc

快速入门示例命令

1. 使用 1 个 CPU 核心（仅使用核心 #0）以 1 个线程运行单实例推理：

$ python -m torch.backends.xeon.run_cpu --ninstances 1 --ncores-per-instance 1 <program.py> [program_args]

2. 在单个 CPU 节点（NUMA 插槽）上运行单实例推理：

$ python -m torch.backends.xeon.run_cpu --node-id 0 <program.py> [program_args]

3. 运行多实例推理，每个实例使用 14 个核心，在 112 核 CPU 上运行 8 个实例：

$ python -m torch.backends.xeon.run_cpu --ninstances 8 --ncores-per-instance 14 <program.py> [program_args]

4. 以吞吐量模式运行推理，其中每个 CPU 节点上的所有核心配置为一个实例：

$ python -m torch.backends.xeon.run_cpu --throughput-mode <program.py> [program_args]

注意

此处的“实例”一词不指代云实例。该脚本作为单个进程执行，该进程调用由多个线程组成的多个“实例”。在此上下文中，“实例”是一种线程组。

使用 torch.backends.xeon.run_cpu

可以使用以下命令显示参数列表和用法指南：

$ python -m torch.backends.xeon.run_cpu –h
usage: run_cpu.py [-h] [--multi-instance] [-m] [--no-python] [--enable-tcmalloc] [--enable-jemalloc] [--use-default-allocator] [--disable-iomp] [--ncores-per-instance] [--ninstances] [--skip-cross-node-cores] [--rank] [--latency-mode] [--throughput-mode] [--node-id] [--use-logical-core] [--disable-numactl] [--disable-taskset] [--core-list] [--log-path] [--log-file-prefix] <program> [program_args]

上述命令具有以下位置参数：

knob	help
program	要启动的程序/脚本的完整路径。
program_args	要启动的程序/脚本的输入参数。

选项说明

通用选项设置（knobs）包括以下内容：

knob	type	默认值	help
-h, --help			显示帮助消息并退出。
-m, --module			将每个进程更改为将启动脚本解释为 Python 模块，其行为与“python -m”相同。
--no-python	布尔值	假	避免在程序前面加上“python”——直接执行即可。当脚本不是 Python 脚本时很有用。
--log-path	str	''	指定日志文件目录。默认路径为 ''，表示禁用文件日志记录。
--log-file-prefix	str	“run”	日志文件名中的前缀。

用于应用或禁用优化的 knobs 有：

knob	type	默认值	help
--enable-tcmalloc	布尔值	假	启用 TCMalloc 内存分配器。
--enable-jemalloc	布尔值	假	启用 JeMalloc 内存分配器。
--use-default-allocator	布尔值	假	使用默认内存分配器。既不使用 TCMalloc 也不使用 JeMalloc。
--disable-iomp	布尔值	假	默认情况下，如果安装了 Intel® OpenMP 库，则会使用它。设置此标志将禁用 Intel® OpenMP 的使用。

注意

内存分配器会影响性能。如果用户未指定所需的内存分配器，run_cpu 脚本将按 TCMalloc > JeMalloc > PyTorch 默认内存分配器的顺序搜索它们是否已安装，并取第一个匹配项。

用于控制实例数量和计算资源分配的 knobs 有：

knob	type	默认值	help
--ninstances	int	0	实例数量。
--ncores-per-instance	int	0	每个实例使用的核心数。
--node-id	int	-1	用于多实例的节点 ID，默认情况下将使用所有节点。
--core-list	str	''	指定核心列表，格式为 'core_id, core_id, ....' 或核心范围，格式为 'core_id-core_id'。默认情况下将使用所有核心。
--use-logical-core	布尔值	假	默认情况下仅使用物理核心。指定此标志可启用逻辑核心使用。
--skip-cross-node-cores	布尔值	假	防止工作负载在跨 NUMA 节点的上执行。
--rank	int	-1	为 rank 指定实例索引以分配 ncores_per_instance；否则 ncores_per_instance 将按顺序分配给实例。
--multi-instance	布尔值	假	一个快速设置，用于在多插槽 CPU 服务器上调用工作负载的多个实例。
--latency-mode	布尔值	假	一个快速设置，用于调用延迟模式下的基准测试，其中使用所有物理核心，每个实例使用 4 个核心。
--throughput-mode	布尔值	假	一个快速设置，用于调用吞吐量模式下的基准测试，其中使用所有物理核心，每个实例使用 1 个 NUMA 节点。
--disable-numactl	布尔值	假	默认情况下，numactl 命令用于控制 NUMA 访问。设置此标志将禁用它。
--disable-taskset	布尔值	假	禁用 taskset 命令的使用。

注意

该脚本将设置的环境变量包括：

环境变量	值
LD_PRELOAD	根据您设置的 knobs，<lib>/libiomp5.so、<lib>/libjemalloc.so、<lib>/libtcmalloc.so 可能会被追加到 LD_PRELOAD。
KMP_AFFINITY	如果预加载了 libiomp5.so，KMP_AFFINITY 可以设置为 "granularity=fine,compact,1,0"。
KMP_BLOCKTIME	如果预加载了 libiomp5.so，KMP_BLOCKTIME 将设置为“1”。
OMP_NUM_THREADS	值为 ncores_per_instance。
MALLOC_CONF	如果预加载了 libjemalloc.so，MALLOC_CONF 将设置为 "oversize_threshold:1,background_thread:true,metadata_thp:auto"。

请注意，脚本会尊重预先设置的环境变量。例如，如果您在运行脚本之前设置了上述环境变量，则脚本不会覆盖这些变量的值。

结论

在本教程中，我们探索了各种高级配置和工具，旨在优化 PyTorch 在 Intel® Xeon® 可扩展处理器上的推理性能。通过利用 torch.backends.xeon.run_cpu 脚本，我们演示了如何微调线程和内存管理以实现最佳性能。我们涵盖了 NUMA 访问控制、TCMalloc 和 JeMalloc 等优化内存分配器以及使用 Intel® OpenMP 进行高效多线程等基本概念。

此外，我们提供了实用的命令行示例，指导您完成单实例和多实例场景的设置，确保针对特定工作负载优化资源利用。通过理解和应用这些技术，用户可以显著提高其 PyTorch 应用程序在 Intel® Xeon® 平台上的效率和速度。

另请参阅

• PyTorch 性能调优指南

• PyTorch 多进程最佳实践