量化 API 参考#
创建于: 2020年7月25日 | 最后更新于: 2025年6月18日
torch.ao.quantization#
该模块包含 Eager 模式下的量化 API。
顶级 API#
使用训练后静态量化对输入浮点模型进行量化。 |
|
将浮点模型转换为动态(即 |
|
进行量化感知训练并输出量化模型 |
|
准备模型副本以进行量化校准或量化感知训练。 |
|
准备模型副本以进行量化校准或量化感知训练,并将其转换为量化版本。 |
|
根据 mapping,通过调用目标模块类的 from_float 方法,将输入模块中的子模块转换为不同的模块。 |
准备模型以进行量化#
将模块列表融合成一个单一的模块。 |
|
量化存根模块,在校准之前,它与观察器相同,将在 convert 中被替换为 nnq.Quantize。 |
|
反量化存根模块,在校准之前,它与恒等函数相同,将在 convert 中被替换为 nnq.DeQuantize。 |
|
一个包装类,用于包装输入模块,添加 QuantStub 和 DeQuantStub,并将模块的调用围绕量化和反量化模块的调用。 |
|
如果叶子子模块具有有效的 qconfig,则将其包装在 QuantWrapper 中。请注意,此函数将就地修改模块的子模块,并且还可以返回一个包装输入模块的新模块。 |
实用函数#
如果模块具有量化对应项并且附加了 observer,则替换该模块。 |
|
通过模块层级结构传播 qconfig,并在每个叶子模块上分配 qconfig 属性。 |
|
定义默认的评估函数。 |
torch.ao.quantization.quantize_fx#
该模块包含 FX 图模式量化的 API(原型)。
准备模型以进行训练后量化。 |
|
准备模型以进行量化感知训练。 |
|
将已校准或训练过的模型转换为量化模型。 |
|
融合模块,如 conv+bn、conv+bn+relu 等。模型必须处于 eval 模式。 |
torch.ao.quantization.qconfig_mapping#
该模块包含 QConfigMapping,用于配置 FX 图模式量化。
模型操作到 |
|
返回用于训练后量化的默认 QConfigMapping。 |
|
返回用于量化感知训练的默认 QConfigMapping。 |
torch.ao.quantization.backend_config#
该模块包含 BackendConfig,一个配置对象,用于定义量化在后端中如何被支持。目前仅由 FX 图模式量化使用,但我们可能会扩展 Eager 模式量化以使其也能工作。
定义给定后端可以量化的模式集,以及如何从这些模式生成参考量化模型的配置。 |
|
指定给定运算符模式的量化行为的配置对象。 |
|
指定参考模型规范中用于量化操作的激活、权重和偏置的输入和输出数据的支持数据类型的配置对象。 |
|
用于指定给定 dtype 的附加约束的配置,例如量化值范围、比例值范围和固定量化参数,用于 |
|
一个枚举,表示运算符/运算符模式应如何被观察的各种方式。 |
torch.ao.quantization.fx.custom_config#
该模块包含一些 CustomConfig 类,它们同时用于 eager 模式和 FX 图模式量化。
用于 |
|
用于 |
|
用于 |
|
torch.ao.quantization.quantizer#
torch.ao.quantization.pt2e (PyTorch 2.0 导出实现中的量化)#
torch.ao.quantization.pt2e.export_utils#
如果 torch.nn.Module 已导出,则返回 True,否则返回 False(例如。 |
torch.ao.quantization.pt2e.lowering#
将 PT2E 量化的模型降低到 x86 后端。 |
PT2 导出 (pt2e) 数值调试器#
为给定 ExportedProgram 的图模块中的所有节点(如 conv2d、squeeze、conv1d 等)附加 numeric_debug_handle_id,占位符除外。 |
|
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str |
|
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str |
|
为具有 numeric_debug_handle 的节点添加输出记录器。 |
|
对于给定模型,提取每个调试句柄的张量统计信息及相关信息。 |
|
给定两个从 debug_handle_id(整数)到张量列表的映射,返回一个从 debug_handle_id 到 NodeAccuracySummary 的映射,其中包含 SQNR、MSE 等比较信息。 |
torch.ao.quantization.observer#
该模块包含观察器,用于在校准(PTQ)或训练(QAT)期间收集值的统计信息。
基础观察器模块。 |
|
基于运行的 min 和 max 值计算量化参数的观察器模块。 |
|
基于 min 和 max 值的移动平均值计算量化参数的观察器模块。 |
|
用于基于运行时的逐通道最小/最大值计算量化参数的观察者模块。 |
|
用于基于运行时的逐通道最小/最大值计算量化参数的观察者模块。 |
|
该模块记录张量值的运行直方图以及 min/max 值。 |
|
一个不执行任何操作的观察器,仅将其配置传递给量化模块的 |
|
该模块主要用于调试,并记录运行时张量值。 |
|
一个不执行任何操作的观察器,仅将其配置传递给量化模块的 |
|
返回对应于观察器统计信息的 state dict。 |
|
给定输入模型和包含模型观察器统计信息的 state_dict,将统计信息加载回模型。 |
|
静态量化的默认观察器,通常用于调试。 |
|
默认占位符观察器,通常用于量化到 torch.float16。 |
|
默认仅用于调试的观察器。 |
|
默认权重观察器。 |
|
默认直方图观察器,通常用于 PTQ。 |
|
默认逐通道权重观察器,通常用于支持逐通道权重量化的后端,例如 fbgemm。 |
|
动态量化的默认观察器。 |
|
浮点零点的默认观察器。 |
|
仿射量化的观察器模块(pytorch/ao)。 |
|
表示量化粒度的基类。 |
|
浮点数如何映射到整数 |
|
表示量化中的逐轴粒度。 |
|
表示量化中的逐块粒度。 |
|
表示量化中的逐通道组粒度。 |
|
表示量化中的逐行粒度。 |
|
表示量化中的逐张量粒度。 |
|
表示量化中的逐 token 粒度。 |
|
PyTorch 核心中尚不存在的数据类型的占位符。 |
|
枚举,指示零点是在整数域还是浮点域 |
|
根据输入形状和粒度类型获取块大小。 |
torch.ao.quantization.fake_quantize#
该模块实现了在 QAT 期间用于执行虚假量化的模块。
基础虚假量化模块。 |
|
在训练时模拟量化和反量化操作。 |
|
在训练时模拟量化和反量化。 |
|
定义一个用于观察张量的融合模块。 |
|
激活的默认虚假量化。 |
|
权重的默认虚假量化。 |
|
逐通道权重的默认虚假量化。 |
|
使用直方图的激活的虚假量化。 |
|
默认 default_fake_quant 的融合版本,性能更佳。 |
|
默认 default_weight_fake_quant 的融合版本,性能更佳。 |
|
默认 default_per_channel_weight_fake_quant 的融合版本,性能更佳。 |
|
禁用模块的虚假量化。 |
|
启用模块的虚假量化。 |
|
禁用此模块的观察。 |
|
启用此模块的观察。 |
torch.ao.quantization.qconfig#
该模块定义了 QConfig 对象,用于配置单个操作的量化设置。
通过为激活和权重分别提供设置(观察器类),描述了如何量化一个层或网络的一部分。 |
|
默认 qconfig 配置。 |
|
用于调试的默认 qconfig 配置。 |
|
用于逐通道权重量化的默认 qconfig 配置。 |
|
默认动态 qconfig。 |
|
权重量化为 torch.float16 的动态 qconfig。 |
|
激活和权重都量化为 torch.float16 的动态 qconfig。 |
|
权重逐通道量化的动态 qconfig。 |
|
具有浮点零点的动态 qconfig。 |
|
QAT 的默认 qconfig。 |
|
仅量化权重的默认 qconfig。 |
|
仅量化激活的默认 qconfig。 |
|
默认 default_qat_config 的融合版本,具有性能优势。 |
torch.ao.nn.intrinsic#
该模块实现了可量化的组合(融合)模块 conv + relu。
这是一个顺序容器,它调用 Conv1d 和 ReLU 模块。 |
|
这是一个顺序容器,它调用 Conv2d 和 ReLU 模块。 |
|
这是一个顺序容器,它调用 Conv3d 和 ReLU 模块。 |
|
这是一个顺序容器,它调用 Linear 和 ReLU 模块。 |
|
这是一个顺序容器,它调用 Conv 1d 和 Batch Norm 1d 模块。 |
|
这是一个顺序容器,它调用 Conv 2d 和 Batch Norm 2d 模块。 |
|
这是一个顺序容器,它调用 Conv 3d 和 Batch Norm 3d 模块。 |
|
这是一个顺序容器,它调用 Conv 1d、Batch Norm 1d 和 ReLU 模块。 |
|
这是一个顺序容器,它调用 Conv 2d、Batch Norm 2d 和 ReLU 模块。 |
|
这是一个顺序容器,它调用 Conv 3d、Batch Norm 3d 和 ReLU 模块。 |
|
这是一个顺序容器,它调用 BatchNorm 2d 和 ReLU 模块。 |
|
这是一个顺序容器,它调用 BatchNorm 3d 和 ReLU 模块。 |
torch.ao.nn.intrinsic.qat#
该模块实现了量化感知训练所需的那些融合操作的版本。
一个由 Linear 和 ReLU 模块融合的 LinearReLU 模块,附加了用于权重的 FakeQuantize 模块,用于量化感知训练。 |
|
ConvBn1d 模块是由 Conv1d 和 BatchNorm1d 融合的模块,附加了用于权重的 FakeQuantize 模块,用于量化感知训练。 |
|
ConvBnReLU1d 模块是由 Conv1d、BatchNorm1d 和 ReLU 融合的模块,附加了用于权重的 FakeQuantize 模块,用于量化感知训练。 |
|
ConvBn2d 模块是由 Conv2d 和 BatchNorm2d 融合的模块,附加了用于权重的 FakeQuantize 模块,用于量化感知训练。 |
|
ConvBnReLU2d 模块是由 Conv2d、BatchNorm2d 和 ReLU 融合的模块,附加了用于权重的 FakeQuantize 模块,用于量化感知训练。 |
|
ConvReLU2d 模块是 Conv2d 和 ReLU 的融合模块,附加了用于量化感知训练的权重的 FakeQuantize 模块。 |
|
ConvBn3d 模块是由 Conv3d 和 BatchNorm3d 融合的模块,附加了用于权重的 FakeQuantize 模块,用于量化感知训练。 |
|
ConvBnReLU3d 模块是由 Conv3d、BatchNorm3d 和 ReLU 融合的模块,附加了用于权重的 FakeQuantize 模块,用于量化感知训练。 |
|
ConvReLU3d 模块是 Conv3d 和 ReLU 的融合模块,附加了用于量化感知训练的权重的 FakeQuantize 模块。 |
|
torch.ao.nn.intrinsic.quantized#
该模块实现了融合操作(如 conv + relu)的量化版本。没有 BatchNorm 变体,因为它们通常在推理时折叠到卷积中。
BNReLU2d 模块是 BatchNorm2d 和 ReLU 的融合模块。 |
|
BNReLU3d 模块是 BatchNorm3d 和 ReLU 的融合模块。 |
|
ConvReLU1d 模块是 Conv1d 和 ReLU 的融合模块。 |
|
ConvReLU2d 模块是 Conv2d 和 ReLU 的融合模块。 |
|
ConvReLU3d 模块是 Conv3d 和 ReLU 的融合模块。 |
|
LinearReLU 模块由 Linear 和 ReLU 模块融合而成。 |
torch.ao.nn.intrinsic.quantized.dynamic#
该模块实现了融合操作(如 linear + relu)的量化动态实现。
由 Linear 和 ReLU 模块融合的 LinearReLU 模块,可用于动态量化。 |
torch.ao.nn.qat#
该模块实现了关键 nn 模块 **Conv2d()** 和 **Linear()** 的版本,它们在 FP32 下运行,但应用了舍入以模拟 INT8 量化的效果。
torch.ao.nn.qat.dynamic#
该模块实现了关键 nn 模块(如 **Linear()**)的版本,它们在 FP32 下运行,但应用了舍入以模拟 INT8 量化的效果,并在推理时进行动态量化。
附加了用于权重的 FakeQuantize 模块的线性模块,用于动态量化感知训练。 |
torch.ao.nn.quantized#
该模块实现了 nn 层(如 ~torch.nn.Conv2d 和 torch.nn.ReLU)的量化版本。
逐元素应用函数。 |
|
这是 |
|
这是 |
|
这是 |
|
这是 |
|
这是 |
|
这是 |
|
对由多个量化输入平面组成的量化输入信号应用一维卷积。 |
|
对由多个量化输入平面组成的量化输入信号应用二维卷积。 |
|
对由多个量化输入平面组成的量化输入信号应用三维卷积。 |
|
对由多个输入平面组成的输入图像应用 1D 转置卷积运算符。 |
|
对由多个输入平面组成的输入图像应用 2D 转置卷积运算符。 |
|
对由多个输入平面组成的输入图像应用 3D 转置卷积算子。 |
|
一个量化的 Embedding 模块,具有量化的打包权重作为输入。 |
|
一个量化的 EmbeddingBag 模块,具有量化的打包权重作为输入。 |
|
浮点操作的状态收集器类。 |
|
在 FX 图模式量化之前替换 FloatFunctional 模块的模块,因为 activation_post_process 将直接插入到顶级模块中。 |
|
量化操作的包装类。 |
|
一个量化的线性模块,具有量化张量作为输入和输出。 |
|
这是 |
|
这是 |
|
这是 |
|
这是 |
|
这是 |
torch.ao.nn.quantized.functional#
函数接口(量化)。
该模块实现了函数式层(如 ~torch.nn.functional.conv2d 和 torch.nn.functional.relu)的量化版本。注意: 支持量化输入。
区域上的二维平均池化操作,步长为 。 |
|
在 区域上的三维平均池化操作,步长为 。 |
|
对由多个量化输入平面组成的量化输入信号应用二维自适应平均池化。 |
|
对由多个量化输入平面组成的量化输入信号应用三维自适应平均池化。 |
|
对量化一维输入(由多个输入平面组成)应用一维卷积。 |
|
对量化二维输入(由多个输入平面组成)应用二维卷积。 |
|
对量化三维输入(由多个输入平面组成)应用三维卷积。 |
|
将输入下/上采样到给定的 |
|
对传入的量化数据应用线性变换:。 |
|
对量化输入信号(由多个量化输入平面组成)应用一维最大池化。 |
|
对量化输入信号(由多个量化输入平面组成)应用二维最大池化。 |
|
逐元素应用量化的 CELU 函数。 |
|
的量化版本。 |
|
这是 |
|
这是 |
|
逐元素应用阈值函数的量化版本。 |
|
这是 |
|
这是 |
|
float(input, min_, max_) -> Tensor |
|
将输入上采样到给定的 |
|
使用双线性上采样对输入进行上采样。 |
|
使用最近邻像素值对输入进行上采样。 |
torch.ao.nn.quantizable#
该模块实现了某些 nn 层(如 LSTM)的可量化版本。这些模块可以与自定义模块机制结合使用,通过向 prepare 和 convert 参数提供 custom_module_config 来实现。
可量化的长短期记忆(LSTM)。 |
|
torch.ao.nn.quantized.dynamic#
量化数据类型和量化方案#
请注意,运算符实现目前仅支持 **conv** 和 **linear** 运算符权重的逐通道量化。此外,输入数据以线性方式映射到量化数据,反之亦然,如下所示:
其中 :math:clamp 与 clamp() 相同,而比例 和零点 的计算方法如 MinMaxObserver 中所述,具体为:
其中 :math:[x_\text{min}, x_\text{max}] 表示输入数据的范围,而 :math:Q_\text{min} 和 :math:Q_\text{max} 分别是量化数据类型的最小值和最大值。
请注意,:math:s 和 :math:z 的选择意味着,只要零点在输入数据范围内或使用对称量化时,零点都不会产生量化误差。
可以通过 自定义 运算符 机制 <https://pytorch.ac.cn/tutorials/advanced/torch_script_custom_ops.html>_ 实现其他数据类型和量化方案。
torch.qscheme— 用于描述张量量化方案的类型。支持的类型:torch.per_tensor_affine— 逐张量,非对称。torch.per_channel_affine— 逐通道,非对称。torch.per_tensor_symmetric— 逐张量,对称。torch.per_channel_symmetric— 逐通道,对称。
torch.dtype— 用于描述数据的类型。支持的类型:torch.quint8— 8 位无符号整数。torch.qint8— 8 位有符号整数。torch.qint32— 32 位有符号整数。
QAT 模块。
该软件包正在被弃用。请使用 torch.ao.nn.qat.modules。
QAT 动态模块。
该软件包正在被弃用。请使用 torch.ao.nn.qat.dynamic。
该文件正在迁移到 torch/ao/quantization,并在迁移过程中保留以兼容。如果您正在添加新的条目/功能,请将其添加到 torch/ao/quantization/fx/ 下的相应文件中,同时在此处添加导入语句。
QAT 动态模块。
该软件包正在被弃用。请使用 torch.ao.nn.qat.dynamic。
量化模块。
- 注意:
torch.nn.quantized 命名空间正在被弃用。请使用 torch.ao.nn.quantized。
量化动态模块。
该文件正在迁移到 torch/ao/nn/quantized/dynamic,并在迁移过程中保留以兼容。如果您正在添加新的条目/功能,请将其添加到 torch/ao/nn/quantized/dynamic 下的相应文件中,同时在此处添加导入语句。