torch.utils.cpp_extension#

创建日期：2018 年 3 月 7 日 | 最后更新日期：2025 年 2 月 16 日

torch.utils.cpp_extension.CppExtension(name, sources, *args, **kwargs)[源代码]#

为 C++ 创建 setuptools.Extension。

此便捷方法可创建 setuptools.Extension，其中包含构建 C++ 扩展所需的最低（但通常足够）参数。

所有参数都将转发到 setuptools.Extension 构造函数。完整的参数列表可在 https://setuptools.pypa.io/en/latest/userguide/ext_modules.html#extension-api-reference 找到

警告

PyTorch Python API（由 libtorch_python 提供）不能使用 py_limited_api=True 标志构建。当传递此标志时，用户有责任在其库中不使用 libtorch_python 中的 API（特别是 pytorch/python 绑定），并且只使用 libtorch 中的 API（aten 对象、运算符和调度器）。例如，为了从 python 访问自定义操作，库应该通过调度器注册操作。

与 CPython setuptools 不同，CPython setuptools 不会在 setup 中为“bdist_wheel”命令指定 py_limited_api 选项时将 -DPy_LIMITED_API 定义为编译标志，但 PyTorch 会！我们将指定 -DPy_LIMITED_API=min_supported_cpython，以最大程度地强制保持一致性、安全性和健全性，从而鼓励最佳实践。要针对不同版本，请将 min_supported_cpython 设置为所选 CPython 版本的十六进制代码。

示例

>>> from setuptools import setup
>>> from torch.utils.cpp_extension import BuildExtension, CppExtension
>>> setup(
...     name='extension',
...     ext_modules=[
...         CppExtension(
...             name='extension',
...             sources=['extension.cpp'],
...             extra_compile_args=['-g'],
...             extra_link_args=['-Wl,--no-as-needed', '-lm'])
...     ],
...     cmdclass={
...         'build_ext': BuildExtension
...     })

torch.utils.cpp_extension.CUDAExtension(name, sources, *args, **kwargs)[source]#

为 CUDA/C++ 创建一个 setuptools.Extension。

这是一个便利方法，它使用最少（但通常足够）的参数创建一个 setuptools.Extension 来构建 CUDA/C++ 扩展。这包括 CUDA 包含路径、库路径和运行时库。

所有参数都将转发到 setuptools.Extension 构造函数。完整的参数列表可在 https://setuptools.pypa.io/en/latest/userguide/ext_modules.html#extension-api-reference 找到

警告

示例

>>> from setuptools import setup
>>> from torch.utils.cpp_extension import BuildExtension, CUDAExtension
>>> setup(
...     name='cuda_extension',
...     ext_modules=[
...         CUDAExtension(
...                 name='cuda_extension',
...                 sources=['extension.cpp', 'extension_kernel.cu'],
...                 extra_compile_args={'cxx': ['-g'],
...                                     'nvcc': ['-O2']},
...                 extra_link_args=['-Wl,--no-as-needed', '-lcuda'])
...     ],
...     cmdclass={
...         'build_ext': BuildExtension
...     })

计算能力

默认情况下，该扩展将被编译为可在扩展构建过程中可见的所有显卡架构上运行，以及 PTX。如果后续安装了新显卡，则可能需要重新编译该扩展。如果可见显卡的计算能力 (CC) 比 nvcc 可以构建完全编译二进制文件的最新版本更新，PyTorch 将使 nvcc 退回到使用 nvcc 支持的最新版本的 PTX 构建内核（有关 PTX 的详细信息，请参阅下文）。

您可以使用 TORCH_CUDA_ARCH_LIST 明确指定您希望扩展支持的 CC 来覆盖默认行为

TORCH_CUDA_ARCH_LIST="6.1 8.6" python build_my_extension.py TORCH_CUDA_ARCH_LIST="5.2 6.0 6.1 7.0 7.5 8.0 8.6+PTX" python build_my_extension.py

+PTX 选项使扩展内核二进制文件包含指定 CC 的 PTX 指令。PTX 是一种中间表示，允许内核在运行时编译为任何 CC >= 指定 CC（例如，8.6+PTX 生成的 PTX 可以在运行时编译为任何 CC >= 8.6 的 GPU）。这提高了二进制文件的向前兼容性。然而，依赖旧 PTX 通过运行时编译以提供对较新 CC 的向前兼容性可能会适度降低在这些较新 CC 上的性能。如果您知道要定位的 GPU 的确切 CC，最好始终单独指定它们。例如，如果您希望扩展在 8.0 和 8.6 上运行，“8.0+PTX”在功能上可行，因为它包含可以运行时编译为 8.6 的 PTX，但“8.0 8.6”会更好。

请注意，虽然可以包含所有支持的架构，但包含的架构越多，构建过程就越慢，因为它将为每个架构构建单独的内核映像。

请注意，CUDA-11.5 nvcc 在解析 Windows 上的 torch/extension.h 时会遇到内部编译器错误。为了解决此问题，请将 Python 绑定逻辑移动到纯 C++ 文件中。

示例用法: #include <ATen/ATen.h> at::Tensor SigmoidAlphaBlendForwardCuda(….)
而不是: #include <torch/extension.h> torch::Tensor SigmoidAlphaBlendForwardCuda(…)

目前 nvcc 错误问题：pytorch/pytorch#69460 完整解决方法代码示例：facebookresearch/pytorch3d

可重定位设备代码链接

如果您想在编译单元（跨对象文件）之间引用设备符号，则对象文件需要使用可重定位设备代码（-rdc=true 或 -dc）进行构建。此规则的一个例外是“动态并行”（嵌套内核启动），它现在已不再常用。可重定位设备代码的优化程度较低，因此仅需在需要它的对象文件上使用。在设备代码编译步骤和dlink步骤中使用-dlto（设备链接时优化）有助于减少-rdc的潜在性能下降。请注意，它需要在两个步骤中都使用才能有用。

如果您有rdc对象，则需要在 CPU 符号链接步骤之前执行额外的-dlink（设备链接）步骤。还有一种情况是在没有-rdc的情况下使用-dlink：当扩展与包含 rdc 编译对象的静态库（如 [NVSHMEM 库](https://developer.nvidia.com/nvshmem)）链接时。

注意：使用 RDC 链接构建 CUDA 扩展需要 Ninja。

示例

>>> CUDAExtension(
...        name='cuda_extension',
...        sources=['extension.cpp', 'extension_kernel.cu'],
...        dlink=True,
...        dlink_libraries=["dlink_lib"],
...        extra_compile_args={'cxx': ['-g'],
...                            'nvcc': ['-O2', '-rdc=true']})

torch.utils.cpp_extension.SyclExtension(name, sources, *args, **kwargs)[source]#

为 SYCL/C++ 创建一个 setuptools.Extension。

这是一个便利方法，它使用最少（但通常足够）的参数创建一个 setuptools.Extension 来构建 SYCL/C++ 扩展。

所有参数都转发给 setuptools.Extension 构造函数。

警告

示例

>>> from torch.utils.cpp_extension import BuildExtension, SyclExtension
>>> setup(
...     name='xpu_extension',
...     ext_modules=[
...     SyclExtension(
...                 name='xpu_extension',
...                 sources=['extension.cpp', 'extension_kernel.cpp'],
...                 extra_compile_args={'cxx': ['-g', '-std=c++20', '-fPIC']})
...     ],
...     cmdclass={
...         'build_ext': BuildExtension
...     })

默认情况下，该扩展将被编译为可在扩展构建过程中可见的所有显卡架构上运行。如果后续安装了新显卡，则可能需要重新编译该扩展。您可以使用 TORCH_XPU_ARCH_LIST 明确指定您希望扩展支持的设备架构来覆盖默认行为。

TORCH_XPU_ARCH_LIST="pvc,xe-lpg" python build_my_extension.py

请注意，虽然可以包含所有支持的架构，但包含的架构越多，构建过程就越慢，因为它将为每个架构构建单独的内核映像。

注意：构建 SyclExtension 需要 Ninja。

torch.utils.cpp_extension.BuildExtension(*args, **kwargs)[source]#

自定义 setuptools 构建扩展。

此 setuptools.build_ext 子类负责传递所需的最低编译器标志（例如 -std=c++17）以及混合 C++/CUDA/SYCL 编译（并支持一般的 CUDA/SYCL 文件）。

使用 BuildExtension 时，允许为 extra_compile_args 提供一个字典（而不是通常的列表），该字典将语言/编译器（唯一预期值为 cxx、nvcc 或 sycl）映射到要提供给编译器的附加编译器标志列表。这使得在混合编译期间可以为 C++、CUDA 和 SYCL 编译器提供不同的标志。

use_ninja (bool)：如果 use_ninja 为 True (默认值)，则我们尝试使用 Ninja 后端进行构建。与标准 setuptools.build_ext 相比，Ninja 大大加快了编译速度。如果 Ninja 不可用，则回退到标准 distutils 后端。

注意

默认情况下，Ninja 后端使用 #CPUS + 2 个 worker 来构建扩展。这可能会在某些系统上占用过多资源。可以通过将 MAX_JOBS 环境变量设置为非负数来控制 worker 的数量。

torch.utils.cpp_extension.load(name, sources, extra_cflags=None, extra_cuda_cflags=None, extra_sycl_cflags=None, extra_ldflags=None, extra_include_paths=None, build_directory=None, verbose=False, with_cuda=None, with_sycl=None, is_python_module=True, is_standalone=False, keep_intermediates=True)[source]#

即时 (JIT) 加载 PyTorch C++ 扩展。

要加载扩展，将发出一个 Ninja 构建文件，该文件用于将给定源编译为动态库。此库随后作为模块加载到当前的 Python 进程中，并从该函数返回，准备使用。

默认情况下，发出构建文件并将生成的库编译到的目录是 <tmp>/torch_extensions/<name>，其中 <tmp> 是当前平台上的临时文件夹，<name> 是扩展的名称。此位置可以通过两种方式覆盖。首先，如果设置了 TORCH_EXTENSIONS_DIR 环境变量，它将替换 <tmp>/torch_extensions，并且所有扩展都将编译到此目录的子文件夹中。其次，如果提供了此函数的 build_directory 参数，它将覆盖整个路径，即库将直接编译到该文件夹中。

为了编译源文件，使用了默认的系统编译器 (c++)，可以通过设置 CXX 环境变量来覆盖。为了向编译过程传递附加参数，可以提供 extra_cflags 或 extra_ldflags。例如，要优化编译您的扩展，请传递 extra_cflags=['-O3']。您还可以使用 extra_cflags 传递其他包含目录。

提供混合编译的 CUDA 支持。只需将 CUDA 源文件（.cu 或 .cuh）与其他源文件一起传递即可。此类文件将被检测并使用 nvcc 而不是 C++ 编译器进行编译。这包括将 CUDA lib64 目录作为库目录传递，并链接 cudart。您可以通过 extra_cuda_cflags 向 nvcc 传递附加标志，就像为 C++ 使用 extra_cflags 一样。使用了各种启发式方法来查找 CUDA 安装目录，这些方法通常运行良好。如果不行，设置 CUDA_HOME 环境变量是最安全的选项。

提供混合编译的 SYCL 支持。只需将 SYCL 源文件（.sycl）与其他源文件一起传递即可。此类文件将被检测并使用 SYCL 编译器（例如 Intel DPC++ Compiler）而不是 C++ 编译器进行编译。您可以通过 extra_sycl_cflags 向 SYCL 编译器传递附加标志，就像为 C++ 使用 extra_cflags 一样。SYCL 编译器预计可以通过系统 PATH 环境变量找到。

参数

name – 要构建的扩展的名称。这必须与 pybind11 模块的名称相同！
sources (Union[str, list[str]]) – C++ 源文件的相对或绝对路径列表。
extra_cflags – 可选的编译器标志列表，用于转发到构建。
extra_cuda_cflags – 可选的编译器标志列表，用于在构建 CUDA 源文件时转发给 nvcc。
extra_sycl_cflags – 可选的编译器标志列表，用于在构建 SYCL 源文件时转发给 SYCL 编译器。
extra_ldflags – 可选的链接器标志列表，用于转发到构建。
extra_include_paths – 可选的包含目录列表，用于转发到构建。
build_directory – 用作构建工作区的可选路径。
verbose – 如果为 True，则打开加载步骤的详细日志记录。
with_cuda (Optional[bool]) – 确定是否将 CUDA 头文件和库添加到构建中。如果设置为 None（默认），此值将根据 sources 中是否存在 .cu 或 .cuh 自动确定。将其设置为 True 可强制包含 CUDA 头文件和库。
with_sycl (Optional[bool]) – 确定是否将 SYCL 头文件和库添加到构建中。如果设置为 None（默认），此值将根据 sources 中是否存在 .sycl 自动确定。将其设置为 True 可强制包含 SYCL 头文件和库。
is_python_module – 如果为 True（默认），则将生成的共享库作为 Python 模块导入。如果为 False，则行为取决于 is_standalone。
is_standalone – 如果为 False（默认），则将构建的扩展作为普通动态库加载到进程中。如果为 True，则构建一个独立的的可执行文件。

返回

将加载的 PyTorch 扩展作为 Python 模块返回。

如果 is_python_module 为 False 且 is_standalone 为 False: 不返回任何内容。（共享库作为副作用加载到进程中。）
如果 is_standalone 为 True。: 返回可执行文件的路径。（在 Windows 上，TORCH_LIB_PATH 作为副作用添加到 PATH 环境变量中。）

返回类型

如果 is_python_module 为 True

示例

>>> from torch.utils.cpp_extension import load
>>> module = load(
...     name='extension',
...     sources=['extension.cpp', 'extension_kernel.cu'],
...     extra_cflags=['-O2'],
...     verbose=True)

torch.utils.cpp_extension.load_inline(name, cpp_sources, cuda_sources=None, sycl_sources=None, functions=None, extra_cflags=None, extra_cuda_cflags=None, extra_sycl_cflags=None, extra_ldflags=None, extra_include_paths=None, build_directory=None, verbose=False, with_cuda=None, with_sycl=None, is_python_module=True, with_pytorch_error_handling=True, keep_intermediates=True, use_pch=False, no_implicit_headers=False)[source]#

从字符串源即时 (JIT) 加载 PyTorch C++ 扩展。

此函数的行为与 load() 完全相同，但其源是字符串而不是文件名。这些字符串存储到构建目录中的文件中，之后 load_inline() 的行为与 load() 相同。

有关此函数使用方式的良好示例，请参阅测试。

源文件可以省略典型非内联 C++ 扩展所需的两个部分：必要的头文件包含，以及 (pybind11) 绑定代码。更准确地说，传递给 cpp_sources 的字符串首先被连接成一个单独的 .cpp 文件。然后该文件以 #include <torch/extension.h> 开头

此外，如果提供了 functions 参数，将为每个指定的函数自动生成绑定。functions 可以是函数名称列表，也可以是函数名称到 docstring 的字典映射。如果给出列表，则每个函数的名称用作其 docstring。

cuda_sources 中的源被连接到一个单独的 .cu 文件中，并以 torch/types.h、cuda.h 和 cuda_runtime.h 包含作为前缀。.cpp 和 .cu 文件分别编译，但最终链接到单个库中。请注意，cuda_sources 中的函数本身不生成绑定。要绑定到 CUDA 内核，您必须创建一个调用它的 C++ 函数，并在其中一个 cpp_sources 中声明或定义此 C++ 函数（并将其名称包含在 functions 中）。

sycl_sources 中的源被连接到一个单独的 .sycl 文件中，并以 torch/types.h、sycl/sycl.hpp 包含作为前缀。.cpp 和 .sycl 文件分别编译，但最终链接到单个库中。请注意，sycl_sources 中的函数本身不生成绑定。要绑定到 SYCL 内核，您必须创建一个调用它的 C++ 函数，并在其中一个 cpp_sources 中声明或定义此 C++ 函数（并将其名称包含在 functions 中）。

有关以下省略的参数的说明，请参阅 load()。

参数

cpp_sources – 包含 C++ 源代码的字符串或字符串列表。
cuda_sources – 包含 CUDA 源代码的字符串或字符串列表。
sycl_sources – 包含 SYCL 源代码的字符串或字符串列表。
functions – 用于生成函数绑定的函数名称列表。如果给定字典，它应该将函数名称映射到 docstring（否则只使用函数名称）。
with_cuda – 确定是否将 CUDA 头文件和库添加到构建中。如果设置为 None（默认），此值将根据是否提供了 cuda_sources 自动确定。将其设置为 True 可强制包含 CUDA 头文件和库。
with_sycl – 确定是否将 SYCL 头文件和库添加到构建中。如果设置为 None（默认），此值将根据是否提供了 sycl_sources 自动确定。将其设置为 True 可强制包含 SYCL 头文件和库。
with_pytorch_error_handling – 确定 PyTorch 错误和警告宏是否由 PyTorch 而非 pybind 处理。为此，每个函数 foo 都通过中间的 _safe_foo 函数调用。这种重定向可能会在某些不常见的 C++ 情况中导致问题。当此重定向导致问题时，应将此标志设置为 False。
no_implicit_headers – 如果为 True，则跳过自动添加头文件，最显著的是 #include <torch/extension.h> 和 #include <torch/types.h> 行。当您已在源代码中包含必要的头文件时，使用此选项可以缩短冷启动时间。默认值：False。

示例

>>> from torch.utils.cpp_extension import load_inline
>>> source = """
at::Tensor sin_add(at::Tensor x, at::Tensor y) {
  return x.sin() + y.sin();
}
"""
>>> module = load_inline(name='inline_extension',
...                      cpp_sources=[source],
...                      functions=['sin_add'])

注意

由于 load_inline 将即时编译源代码，请确保您在运行时安装了正确的工具链。例如，加载 C++ 时，请确保 C++ 编译器可用。如果您正在加载 CUDA 扩展，您将需要额外安装相应的 CUDA 工具包（nvcc 和您的代码可能有的任何其他依赖项）。编译工具链在您安装 torch 时不包含，必须额外安装。

在编译过程中，默认情况下，Ninja 后端使用 #CPUS + 2 个 worker 来构建扩展。这可能会在某些系统上占用过多资源。可以通过将 MAX_JOBS 环境变量设置为非负数来控制 worker 的数量。

torch.utils.cpp_extension.include_paths(device_type='cpu')[source]#

获取构建 C++ 或 CUDA 或 SYCL 扩展所需的包含路径。

参数: device_type (str) – 默认为“cpu”。
返回: 包含路径字符串列表。
返回类型: list[str]

torch.utils.cpp_extension.get_compiler_abi_compatibility_and_version(compiler)[source]#

确定给定编译器与 PyTorch 的 ABI 兼容性及其版本。

参数: compiler (str) – 要检查的编译器可执行文件名称（例如 g++）。必须在 shell 进程中可执行。
返回: 一个元组，包含一个布尔值，用于定义编译器是否（可能）与 PyTorch ABI 不兼容，后跟一个 TorchVersion 字符串，其中包含以点分隔的编译器版本。
返回类型: tuple[bool, torch.torch_version.TorchVersion]

torch.utils.cpp_extension.verify_ninja_availability()[source]#: 如果系统上没有 ninja 构建系统，则抛出 RuntimeError，否则不执行任何操作。

torch.utils.cpp_extension.is_ninja_available()[source]#: 如果系统上 ninja 构建系统可用，则返回 True，否则返回 False。

torch.utils.cpp_extension#

文档

教程

资源