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 中找到。

示例

>>> 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_flags=['-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 中找到。

示例

>>> 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_flags=['-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 生成可以为任何 CC >= 8.6 的 GPU 运行时编译的 PTX）。这提高了二进制文件的向前兼容性。但是，依赖于较旧的 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)。

注意：使用 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.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。您可以通过 extra_cuda_cflags 将额外的标志传递给 nvcc，就像使用 C++ 的 extra_cflags 一样。用于查找 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（默认），则此值将根据 .cu 或 .cuh 在 sources 中的存在自动确定。将其设置为 True` 以强制包含 CUDA 头文件和库。

• 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, 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'])

注意

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

torch.utils.cpp_extension.include_paths(cuda=False)

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

参数

cuda (bool) – 如果为 True，则包含 CUDA 特定的包含路径。

返回值

包含路径字符串列表。

返回类型

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。