torch.backends

torch.backends 控制 PyTorch 支持的各种后端的行为。

这些后端包括

• torch.backends.cpu

• torch.backends.cuda

• torch.backends.cudnn

• torch.backends.cusparselt

• torch.backends.mha

• torch.backends.mps

• torch.backends.mkl

• torch.backends.mkldnn

• torch.backends.nnpack

• torch.backends.openmp

• torch.backends.opt_einsum

• torch.backends.xeon

torch.backends.cpu

torch.backends.cpu.get_cpu_capability()

返回 CPU 能力的字符串值。

可能的值： - “DEFAULT” - “VSX” - “Z VECTOR” - “NO AVX” - “AVX2” - “AVX512” - “SVE256”

返回值类型

str

torch.backends.cuda

torch.backends.cuda.is_built()

返回 PyTorch 是否构建时包含 CUDA 支持。

请注意，这并不一定意味着 CUDA 当前可用；只是说如果此 PyTorch 二进制文件在具有正常工作的 CUDA 驱动程序和设备的机器上运行，我们将能够使用它。

torch.backends.cuda.matmul.allow_tf32

一个 bool 值，控制是否可在 Ampere 或更新一代的 GPU 上进行矩阵乘法时使用 TensorFloat-32 张量核心。参见 Ampere（及更新一代）设备上的 TensorFloat-32 (TF32)。

torch.backends.cuda.matmul.allow_fp16_reduced_precision_reduction

一个 bool 值，控制是否允许对 fp16 GEMM 使用降低精度归约（例如，使用 fp16 累积类型）。

torch.backends.cuda.matmul.allow_bf16_reduced_precision_reduction

一个 bool 值，控制是否允许对 bf16 GEMM 使用降低精度归约。

torch.backends.cuda.cufft_plan_cache

cufft_plan_cache 包含每个 CUDA 设备的 cuFFT 计划缓存。通过 torch.backends.cuda.cufft_plan_cache[i] 查询特定设备 i 的缓存。

torch.backends.cuda.cufft_plan_cache.size

一个只读的 int 值，表示 cuFFT 计划缓存中当前的计划数量。

torch.backends.cuda.cufft_plan_cache.max_size

一个 int 值，控制 cuFFT 计划缓存的容量。

torch.backends.cuda.cufft_plan_cache.clear()

清除 cuFFT 计划缓存。

torch.backends.cuda.preferred_blas_library(backend=None)

覆盖 PyTorch 用于 BLAS 操作的库。可在 cuBLAS、cuBLASLt 和 CK [仅 ROCm] 之间选择。

警告

此标志是实验性的，可能会发生变化。

当 PyTorch 运行 CUDA BLAS 操作时，即使 cuBLAS 和 cuBLASLt 都可用，它默认使用 cuBLAS。对于为 ROCm 构建的 PyTorch，hipBLAS、hipBLASLt 和 CK 可能提供不同的性能。此标志（一个 str）允许覆盖使用哪个 BLAS 库。

• 如果设置为 “cublas”，则尽可能使用 cuBLAS。

• 如果设置为 “cublaslt”，则尽可能使用 cuBLASLt。

• 如果设置为 “ck”，则尽可能使用 CK。

• 如果设置为 “default”（默认值），则会使用启发式方法在其他选项之间进行选择。

• 当未提供输入时，此函数返回当前首选的库。

• 用户可以使用环境变量 TORCH_BLAS_PREFER_CUBLASLT=1 在全局范围内将首选库设置为 cuBLASLt。此标志仅设置首选库的初始值，并且首选库仍可在脚本中稍后通过此函数调用来覆盖。

注意：当首选某个库时，如果首选库未实现调用的操作，仍可能使用其他库。如果 PyTorch 的库选择对于您的应用输入不正确，此标志可能会获得更好的性能。

返回值类型

_BlasBackend

torch.backends.cuda.preferred_rocm_fa_library(backend=None)

[仅限 ROCm] 覆盖 PyTorch 在 ROCm 环境中用于 Flash Attention 的后端。可在 AOTriton 和 CK 之间选择。

警告

此标志是实验性的，可能会发生变化。

当启用并期望使用 Flash Attention 时，PyTorch 默认使用 AOTriton 作为后端。此标志（一个 str）允许用户覆盖此后端以使用 composable_kernel

• 如果设置为 “default”，则尽可能使用默认后端。目前是 AOTriton。

• 如果设置为 “aotriton”，则尽可能使用 AOTriton。

• 如果设置为 “ck”，则尽可能使用 CK。

• 当未提供输入时，此函数返回当前首选的库。

• 用户可以使用环境变量 TORCH_ROCM_FA_PREFER_CK=1 在全局范围内将首选库设置为 CK。

注意：当首选某个库时，如果首选库未实现调用的操作，仍可能使用其他库。如果 PyTorch 的库选择对于您的应用输入不正确，此标志可能会获得更好的性能。

返回值类型

_ROCmFABackend

torch.backends.cuda.preferred_linalg_library(backend=None)

覆盖 PyTorch 在 CUDA 线性代数操作中用于在 cuSOLVER 和 MAGMA 之间进行选择的启发式方法。

警告

此标志是实验性的，可能会发生变化。

当 PyTorch 运行 CUDA 线性代数操作时，它通常使用 cuSOLVER 或 MAGMA 库，如果两者都可用，则使用启发式方法决定使用哪个。此标志（一个 str）允许覆盖这些启发式方法。

• 如果设置为 “cusolver”，则尽可能使用 cuSOLVER。

• 如果设置为 “magma”，则尽可能使用 MAGMA。

• 如果设置为 “default”（默认值），则在 cuSOLVER 和 MAGMA 都可用时，将使用启发式方法在它们之间进行选择。

• 当未提供输入时，此函数返回当前首选的库。

• 用户可以使用环境变量 TORCH_LINALG_PREFER_CUSOLVER=1 在全局范围内将首选库设置为 cuSOLVER。此标志仅设置首选库的初始值，并且首选库仍可在脚本中稍后通过此函数调用来覆盖。

注意：当首选某个库时，如果首选库未实现调用的操作，仍可能使用其他库。如果 PyTorch 的启发式库选择对于您的应用输入不正确，此标志可能会获得更好的性能。

当前支持的线性代数算子

• torch.linalg.inv()

• torch.linalg.inv_ex()

• torch.linalg.cholesky()

• torch.linalg.cholesky_ex()

• torch.cholesky_solve()

• torch.cholesky_inverse()

• torch.linalg.lu_factor()

• torch.linalg.lu()

• torch.linalg.lu_solve()

• torch.linalg.qr()

• torch.linalg.eigh()

• torch.linalg.eighvals()

• torch.linalg.svd()

• torch.linalg.svdvals()

返回值类型

_LinalgBackend

class torch.backends.cuda.SDPAParams

torch.backends.cuda.flash_sdp_enabled()

警告

此标志处于 Beta 阶段，可能会发生变化。

返回是否启用了 Flash 缩放点积注意力。

torch.backends.cuda.enable_mem_efficient_sdp(enabled)

警告

此标志处于 Beta 阶段，可能会发生变化。

启用或禁用内存高效缩放点积注意力。

torch.backends.cuda.mem_efficient_sdp_enabled()

警告

此标志处于 Beta 阶段，可能会发生变化。

返回是否启用了内存高效缩放点积注意力。

torch.backends.cuda.enable_flash_sdp(enabled)

警告

此标志处于 Beta 阶段，可能会发生变化。

启用或禁用 Flash 缩放点积注意力。

torch.backends.cuda.math_sdp_enabled()

警告

此标志处于 Beta 阶段，可能会发生变化。

返回是否启用了数学缩放点积注意力。

torch.backends.cuda.enable_math_sdp(enabled)

警告

此标志处于 Beta 阶段，可能会发生变化。

启用或禁用数学缩放点积注意力。

torch.backends.cuda.fp16_bf16_reduction_math_sdp_allowed()

警告

此标志处于 Beta 阶段，可能会发生变化。

返回是否启用了数学缩放点积注意力中的 fp16/bf16 归约。

torch.backends.cuda.allow_fp16_bf16_reduction_math_sdp(enabled)

警告

此标志处于 Beta 阶段，可能会发生变化。

启用或禁用数学缩放点积注意力中的 fp16/bf16 归约。

torch.backends.cuda.cudnn_sdp_enabled()

警告

此标志处于 Beta 阶段，可能会发生变化。

返回是否启用了 cuDNN 缩放点积注意力。

torch.backends.cuda.enable_cudnn_sdp(enabled)

警告

此标志处于 Beta 阶段，可能会发生变化。

启用或禁用 cuDNN 缩放点积注意力。

torch.backends.cuda.is_flash_attention_available()

检查 PyTorch 是否构建时包含用于 scaled_dot_product_attention 的 FlashAttention。

返回

如果构建并可用 FlashAttention，则返回 True；否则返回 False。

返回值类型

bool

注意

此函数依赖于启用了 CUDA 的 PyTorch 构建。在非 CUDA 环境中将返回 False。

torch.backends.cuda.can_use_flash_attention(params, debug=False)

检查是否可以在 scaled_dot_product_attention 中利用 FlashAttention。

参数

• params (_SDPAParams) – 一个 SDPAParams 实例，包含查询、键、值张量，一个可选的注意力掩码，dropout 率，以及一个指示注意力是否是因果的标志。

• debug (bool) – 是否记录警告调试信息，说明 FlashAttention 未能运行的原因。默认为 False。

返回

如果可以使用给定参数运行 FlashAttention，则返回 True；否则返回 False。

返回值类型

bool

注意

此函数依赖于启用了 CUDA 的 PyTorch 构建。在非 CUDA 环境中将返回 False。

torch.backends.cuda.can_use_efficient_attention(params, debug=False)

检查是否可以在 scaled_dot_product_attention 中利用 efficient_attention。

参数

• params (_SDPAParams) – 一个 SDPAParams 实例，包含查询、键、值张量，一个可选的注意力掩码，dropout 率，以及一个指示注意力是否是因果的标志。

• debug (bool) – 是否记录警告信息，说明 efficient_attention 未能运行的原因。默认为 False。

返回

如果可以使用给定参数运行 efficient_attention，则返回 True；否则返回 False。

返回值类型

bool

注意

此函数依赖于启用了 CUDA 的 PyTorch 构建。在非 CUDA 环境中将返回 False。

torch.backends.cuda.can_use_cudnn_attention(params, debug=False)

检查是否可以在 scaled_dot_product_attention 中利用 cudnn_attention。

参数

• params (_SDPAParams) – 一个 SDPAParams 实例，包含查询、键、值张量，一个可选的注意力掩码，dropout 率，以及一个指示注意力是否是因果的标志。

• debug (bool) – 是否记录警告信息，说明 cuDNN attention 未能运行的原因。默认为 False。

返回

如果可以使用给定参数运行 cuDNN，则返回 True；否则返回 False。

返回值类型

bool

注意

此函数依赖于启用了 CUDA 的 PyTorch 构建。在非 CUDA 环境中将返回 False。

torch.backends.cuda.sdp_kernel(enable_flash=True, enable_math=True, enable_mem_efficient=True, enable_cudnn=True)

警告

此标志处于 Beta 阶段，可能会发生变化。

此上下文管理器可用于临时启用或禁用缩放点积注意力支持的这些后端中的任意一个或多个。退出上下文管理器后，标志的先前状态将被恢复。

torch.backends.cudnn

torch.backends.cudnn.version()

返回 cuDNN 的版本。

torch.backends.cudnn.is_available()

返回一个布尔值，指示 cuDNN 当前是否可用。

torch.backends.cudnn.enabled

一个 bool 值，控制是否启用 cuDNN。

torch.backends.cudnn.allow_tf32

一个 bool 值，控制是否可在 Ampere 或更新一代的 GPU 上进行 cuDNN 卷积时使用 TensorFloat-32 (TF32) 张量核心。参见 Ampere（及更新一代）设备上的 TensorFloat-32 (TF32)。

torch.backends.cudnn.deterministic

一个 bool 值，如果为 True，则使 cuDNN 仅使用确定性卷积算法。另请参见 torch.are_deterministic_algorithms_enabled() 和 torch.use_deterministic_algorithms()。

torch.backends.cudnn.benchmark

一个 bool 值，如果为 True，则使 cuDNN 对多种卷积算法进行基准测试并选择最快的一种。

torch.backends.cudnn.benchmark_limit

一个 int 值，指定当 torch.backends.cudnn.benchmark 为 True 时尝试的最大 cuDNN 卷积算法数量。将 benchmark_limit 设置为零将尝试所有可用算法。请注意，此设置仅影响通过 cuDNN v8 API 分派的卷积。

torch.backends.cusparselt

torch.backends.cusparselt.version()

返回 cuSPARSELt 的版本

返回值类型

Optional[int]

torch.backends.cusparselt.is_available()

返回一个布尔值，指示 cuSPARSELt 当前是否可用。

返回值类型

bool

torch.backends.mha

torch.backends.mha.get_fastpath_enabled()

返回 TransformerEncoder 和 MultiHeadAttention 的快速路径是否已启用，如果 jit 正在进行脚本化，则返回 True。

注意

即使 get_fastpath_enabled 返回 True，快速路径也可能不会运行，除非满足所有输入条件。

返回值类型

bool

torch.backends.mha.set_fastpath_enabled(value)

设置快速路径是否启用

torch.backends.mps

torch.backends.mps.is_available()

返回一个布尔值，指示 MPS 当前是否可用。

返回值类型

bool

torch.backends.mps.is_built()

返回 PyTorch 是否已构建并支持 MPS。

请注意，这并不一定意味着 MPS 可用；这仅表示如果此 PyTorch 二进制文件在具有正常工作的 MPS 驱动程序和设备的机器上运行，我们将能够使用它。

返回值类型

bool

torch.backends.mkl

torch.backends.mkl.is_available()

返回 PyTorch 是否已构建并支持 MKL。

class torch.backends.mkl.verbose(enable)

按需 oneMKL 详细输出功能。

为了更轻松地调试性能问题，oneMKL 可以在执行内核时转储包含执行信息（如持续时间）的详细消息。可以通过名为 MKL_VERBOSE 的环境变量调用详细输出功能。然而，这种方法会在所有步骤中转储消息。这些是大量的详细消息。此外，为了调查性能问题，通常只需获取单次迭代的详细消息即可。这种按需详细输出功能使得控制详细消息转储的范围成为可能。在以下示例中，将仅为第二次推理转储详细消息。

import torch
model(data)
with torch.backends.mkl.verbose(torch.backends.mkl.VERBOSE_ON):
    model(data)

参数

level – 详细输出级别 - VERBOSE_OFF: 禁用详细输出 - VERBOSE_ON: 启用详细输出

torch.backends.mkldnn

torch.backends.mkldnn.is_available()

返回 PyTorch 是否已构建并支持 MKL-DNN。

class torch.backends.mkldnn.verbose(level)

按需 oneDNN（原 MKL-DNN）详细输出功能。

为了更轻松地调试性能问题，oneDNN 可以在执行内核时转储包含内核大小、输入数据大小和执行持续时间等信息的详细消息。可以通过名为 DNNL_VERBOSE 的环境变量调用详细输出功能。然而，这种方法会在所有步骤中转储消息。这些是大量的详细消息。此外，为了调查性能问题，通常只需获取单次迭代的详细消息即可。这种按需详细输出功能使得控制详细消息转储的范围成为可能。在以下示例中，将仅为第二次推理转储详细消息。

import torch
model(data)
with torch.backends.mkldnn.verbose(torch.backends.mkldnn.VERBOSE_ON):
    model(data)

参数

level – 详细输出级别 - VERBOSE_OFF: 禁用详细输出 - VERBOSE_ON: 启用详细输出 - VERBOSE_ON_CREATION: 启用详细输出，包括 oneDNN 内核创建

torch.backends.nnpack

torch.backends.nnpack.is_available()

返回 PyTorch 是否已构建并支持 NNPACK。

torch.backends.nnpack.flags(enabled=False)

用于设置是否全局启用 nnpack 的上下文管理器

torch.backends.nnpack.set_flags(_enabled)

设置是否全局启用 nnpack

torch.backends.openmp

torch.backends.openmp.is_available()

返回 PyTorch 是否已构建并支持 OpenMP。

torch.backends.opt_einsum

torch.backends.opt_einsum.is_available()

返回一个布尔值，指示 opt_einsum 当前是否可用。

您必须安装 opt-einsum，以便 torch 自动优化 einsum。要使 opt-einsum 可用，您可以将其与 torch 一起安装：pip install torch[opt-einsum] 或单独安装：pip install opt-einsum。如果该包已安装，torch 将自动导入并相应地使用它。使用此函数检查 opt-einsum 是否已安装并由 torch 正确导入。

返回值类型

bool

torch.backends.opt_einsum.get_opt_einsum()

如果 opt_einsum 当前可用，则返回 opt_einsum 包，否则返回 None。

返回值类型

Any

torch.backends.opt_einsum.enabled

一个 bool 值，控制是否启用 opt_einsum（默认为 True）。如果启用，torch.einsum 将在可用时使用 opt_einsum (https://optimized-einsum.readthedocs.io/en/stable/path_finding.html) 计算最优的收缩路径以获得更快性能。

如果 opt_einsum 不可用，torch.einsum 将回退到默认的从左到右的收缩路径。

torch.backends.opt_einsum.strategy

一个 str 值，指定当 torch.backends.opt_einsum.enabled 为 True 时尝试哪种策略。默认情况下，torch.einsum 将尝试“auto”策略，但也支持“greedy”和“optimal”策略。请注意，“optimal”策略会尝试所有可能的路径，因此其复杂性与输入数量的阶乘相关。更多详细信息请参阅 opt_einsum 的文档 (https://optimized-einsum.readthedocs.io/en/stable/path_finding.html)。

torch.backends.xeon