torch.utils.cpp_extension

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 访问自定义操作，库应通过调度器注册操作。

示例

>>> 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)

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

便捷方法，用于创建具有最少（但通常足够）参数的 setuptools.Extension 来构建 CUDA/C++ 扩展。这包括 CUDA 头文件路径、库路径和运行时库。

所有参数都转发到 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 访问自定义操作，库应通过调度器注册操作。

示例

>>> 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 错误的开放问题：https://github.com/pytorch/pytorch/issues/69460 完整的解决方法代码示例：https://github.com/facebookresearch/pytorch3d/commit/cb170ac024a949f1f9614ffe6af1c38d972f7d48

可重定位设备代码链接

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

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

注意：Ninja 是构建具有 RDC 链接的 CUDA 扩展所必需的。

示例

>>> 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.BuildExtension(*args, **kwargs)

自定义 setuptools 构建扩展。

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

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

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

注意

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

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

即时 (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。您可以像使用 C++ 的 extra_cflags 一样，通过 extra_cuda_cflags 将其他标志传递给 nvcc。使用各种启发式方法来查找 CUDA 安装目录，这些方法通常效果良好。如果不起作用，则设置 CUDA_HOME 环境变量是最安全的选择。

参数

• name – 要构建的扩展的名称。这必须与 pybind11 模块的名称相同！

• sources (Union[str, List[str]]) – C++ 源文件的相对或绝对路径列表。

• extra_cflags – 要转发到构建的可选编译器标志列表。

• extra_cuda_cflags – 构建 CUDA 源文件时要转发到 nvcc 的可选编译器标志列表。

• extra_ldflags – 要转发到构建的可选链接器标志列表。

• extra_include_paths – 要转发到构建的可选包含目录列表。

• build_directory – 用作构建工作区的可选路径。

• verbose – 如果为 True，则启用加载步骤的详细日志记录。

• with_cuda (Optional[bool]) – 确定是否将 CUDA 头文件和库添加到构建中。如果设置为 None（默认），则此值会根据 sources 中是否存在 .cu 或 .cuh 自动确定。设置为 True` 以强制包含 CUDA 头文件和库。

• is_python_module – 如果为 True（默认），则将生成的共享库作为 Python 模块导入。如果为 False，则行为取决于 is_standalone。

• is_standalone – 如果为 False（默认），则将构建的扩展作为普通动态库加载到进程中。如果为 True，则构建独立的exe可执行文件。

返回

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

如果 is_python_module 为 False 且 is_standalone 为 False

不返回任何内容。（共享库作为副作用加载到进程中。）

如果 is_standalone 为 True。

返回 exe 可执行文件的路径。（在 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, functions=None, extra_cflags=None, extra_cuda_cflags=None, extra_ldflags=None, extra_include_paths=None, build_directory=None, verbose=False, with_cuda=None, is_python_module=True, with_pytorch_error_handling=True, keep_intermediates=True, use_pch=False)

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

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

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

源文件可以省略典型非内联 C++ 扩展的两个必需部分：必要的头文件包含以及（pybind11）绑定代码。更准确地说，传递给 cpp_sources 的字符串首先连接到一个 .cpp 文件中。然后，此文件的前面会加上 #include <torch/extension.h>。

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

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

有关下面省略的参数的描述，请参见 load()。

参数

• cpp_sources – 包含 C++ 源代码的字符串或字符串列表。

• cuda_sources – 包含 CUDA 源代码的字符串或字符串列表。

• functions – 要为其生成函数绑定的函数名称列表。如果给出字典，则它应将函数名称映射到文档字符串（否则文档字符串只是函数名称）。

• with_cuda – 确定是否将 CUDA 头文件和库添加到构建中。如果设置为 None（默认），则此值会根据是否提供了 cuda_sources 自动确定。设置为 True 以强制包含 CUDA 头文件和库。

• with_pytorch_error_handling – 确定 pytorch 错误和警告宏是否由 pytorch 而不是 pybind 处理。为此，每个函数 foo 都会通过中间函数 _safe_foo 调用。这种重定向可能会在 cpp 的模糊情况下引起问题。当此重定向引起问题时，应将此标志设置为 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')

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

参数

device_type (str) – 默认为 “cpu”。

返回

include 路径字符串的列表。

返回类型

List[str]

torch.utils.cpp_extension.get_compiler_abi_compatibility_and_version(compiler)

确定给定的编译器是否与 PyTorch ABI 兼容，并返回其版本。

参数

compiler (str) – 要检查的编译器可执行文件名 (例如 g++)。必须在 shell 进程中可执行。

返回

一个元组，包含一个布尔值，用于定义编译器是否（可能）与 PyTorch ABI 不兼容，后跟一个 TorchVersion 字符串，其中包含用点分隔的编译器版本。

返回类型

Tuple[bool, TorchVersion]

torch.utils.cpp_extension.verify_ninja_availability()

如果系统上没有 ninja 构建系统，则引发 RuntimeError，否则不执行任何操作。

torch.utils.cpp_extension.is_ninja_available()

如果系统上存在 ninja 构建系统，则返回 True，否则返回 False。