量化 API 参考

torch.ao.quantization

此模块包含 Eager 模式量化 API。

顶层 API

quantize	使用训练后静态量化量化输入浮点模型。
quantize_dynamic	将浮点模型转换为动态模型（即
quantize_qat	执行量化感知训练并输出量化模型
prepare	准备模型副本以进行量化校准或量化感知训练。
prepare_qat	准备模型副本以进行量化校准或量化感知训练，并将其转换为量化版本。
convert	通过调用目标模块类上的 from_float 方法，根据 mapping 将输入模块中的子模块转换为不同的模块。

准备模型以进行量化

fuse_modules.fuse_modules	将模块列表融合为单个模块。
QuantStub	量化桩模块，在校准之前，这与观察者相同，它将在 convert 中被交换为 nnq.Quantize。
DeQuantStub	反量化桩模块，在校准之前，这与恒等相同，它将在 convert 中被交换为 nnq.DeQuantize。
QuantWrapper	一个包装类，用于包装输入模块，添加 QuantStub 和 DeQuantStub，并将对模块的调用用对量化和反量化模块的调用包围。
add_quant_dequant	如果叶子子模块具有有效的 qconfig，则将其包装在 QuantWrapper 中。请注意，此函数将就地修改模块的子项，并且它可以返回一个也包装输入模块的新模块。

实用函数

swap_module	如果模块具有量化对应项并且附加了 observer，则交换模块。
propagate_qconfig_	通过模块层次结构传播 qconfig 并在每个叶子模块上分配 qconfig 属性
default_eval_fn	定义默认评估函数。

torch.ao.quantization.quantize_fx

此模块包含 FX 图模式量化 API（原型）。

prepare_fx	准备模型以进行训练后量化
prepare_qat_fx	准备模型以进行量化感知训练
convert_fx	将校准或训练后的模型转换为量化模型
fuse_fx	融合模块，如 conv+bn、conv+bn+relu 等，模型必须处于 eval 模式。

torch.ao.quantization.qconfig_mapping

此模块包含用于配置 FX 图模式量化的 QConfigMapping。

QConfigMapping	从模型操作到 torch.ao.quantization.QConfig 的映射。
get_default_qconfig_mapping	返回训练后量化的默认 QConfigMapping。
get_default_qat_qconfig_mapping	返回量化感知训练的默认 QConfigMapping。

torch.ao.quantization.backend_config

此模块包含 BackendConfig，这是一个配置对象，用于定义后端如何支持量化。目前仅由 FX 图模式量化使用，但我们也可能扩展 Eager 模式量化以使其也能工作。

BackendConfig	配置，定义可在给定后端上量化的模式集，以及如何从这些模式生成参考量化模型。
BackendPatternConfig	配置对象，指定给定算子模式的量化行为。
DTypeConfig	配置对象，指定作为参考模型规范中量化操作参数传递的受支持数据类型，用于输入和输出激活、权重和偏置。
DTypeWithConstraints	用于指定给定 dtype 的附加约束的配置，例如量化值范围、比例值范围和固定量化参数，用于 DTypeConfig。
ObservationType	一个枚举，表示应如何观察算子/算子模式的不同方式

torch.ao.quantization.fx.custom_config

此模块包含一些 CustomConfig 类，这些类在 eager 模式和 FX 图模式量化中都使用

FuseCustomConfig	用于 fuse_fx() 的自定义配置。
PrepareCustomConfig	用于 prepare_fx() 和 prepare_qat_fx() 的自定义配置。
ConvertCustomConfig	用于 convert_fx() 的自定义配置。
StandaloneModuleConfigEntry

torch.ao.quantization.quantizer

torch.ao.quantization.pt2e (pytorch 2.0 导出实现中的量化)

torch.ao.quantization.pt2e.export_utils

model_is_exported

如果 torch.nn.Module 已导出，则返回 True，否则返回 False（例如

PT2 导出 (pt2e) 数值调试器

generate_numeric_debug_handle	为给定 ExportedProgram 的图模块中的所有节点（如 conv2d、squeeze、conv1d 等）附加 numeric_debug_handle_id，除了占位符。
CUSTOM_KEY	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
NUMERIC_DEBUG_HANDLE_KEY	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
prepare_for_propagation_comparison	将输出记录器添加到具有 numeric_debug_handle 的节点
extract_results_from_loggers	对于给定模型，提取每个调试句柄的张量统计信息和相关信息。
compare_results	给定从 debug_handle_id (int) 到张量列表的两个字典映射，返回从 debug_handle_id 到 NodeAccuracySummary 的映射，其中包含比较信息，如 SQNR、MSE 等。

torch（量化相关函数）

这描述了 torch 命名空间的量化相关函数。

quantize_per_tensor	使用给定的比例和零点将浮点张量转换为量化张量。
quantize_per_channel	使用给定的比例和零点将浮点张量转换为逐通道量化张量。
dequantize	通过反量化量化张量返回 fp32 张量

torch.Tensor（量化相关方法）

量化张量支持常规全精度张量的有限数据操作方法子集。

view	返回一个新张量，其数据与 self 张量相同，但 shape 不同。
as_strided	请参阅 torch.as_strided()
expand	返回 self 张量的新视图，其中单例维度扩展为更大的大小。
flatten	请参阅 torch.flatten()
select	请参阅 torch.select()
ne	请参阅 torch.ne()。
eq	请参阅 torch.eq()
ge	请参阅 torch.ge()。
le	请参阅 torch.le()。
gt	请参阅 torch.gt()。
lt	请参阅 torch.lt()。
copy_	将元素从 src 复制到 self 张量中，并返回 self。
clone	请参阅 torch.clone()
dequantize	给定一个量化张量，将其反量化并返回反量化的浮点张量。
equal	请参阅 torch.equal()
int_repr	给定一个量化张量，self.int_repr() 返回一个以 uint8_t 作为数据类型的 CPU 张量，该张量存储给定张量的底层 uint8_t 值。
max	请参阅 torch.max()
mean	请参阅 torch.mean()
min	请参阅 torch.min()
q_scale	给定由线性（仿射）量化量化的张量，返回底层量化器的比例。
q_zero_point	给定由线性（仿射）量化量化的张量，返回底层量化器的零点。
q_per_channel_scales	给定由线性（仿射）逐通道量化量化的张量，返回底层量化器的比例张量。
q_per_channel_zero_points	给定由线性（仿射）逐通道量化量化的张量，返回底层量化器的零点张量。
q_per_channel_axis	给定由线性（仿射）逐通道量化量化的张量，返回应用逐通道量化的维度的索引。
resize_	将 self 张量调整为指定大小。
sort	请参阅 torch.sort()
topk	请参阅 torch.topk()

torch.ao.quantization.observer

此模块包含观察者，用于收集校准 (PTQ) 或训练 (QAT) 期间观察到的值的统计信息。

ObserverBase	基础观察者模块。
MinMaxObserver	观察者模块，用于基于运行的最小值和最大值计算量化参数。
MovingAverageMinMaxObserver	观察者模块，用于基于最小值和最大值的移动平均值计算量化参数。
PerChannelMinMaxObserver	观察者模块，用于基于运行的逐通道最小值和最大值计算量化参数。
MovingAveragePerChannelMinMaxObserver	观察者模块，用于基于运行的逐通道最小值和最大值计算量化参数。
HistogramObserver	该模块记录张量值的运行直方图以及最小值/最大值。
PlaceholderObserver	不执行任何操作的观察者，只是将其配置传递给量化模块的 .from_float()。
RecordingObserver	该模块主要用于调试，并在运行时记录张量值。
NoopObserver	不执行任何操作的观察者，只是将其配置传递给量化模块的 .from_float()。
get_observer_state_dict	返回与观察者统计信息对应的状态字典。
load_observer_state_dict	给定输入模型和一个包含模型观察者统计信息的 state_dict，将统计信息加载回模型中。
default_observer	静态量化的默认观察者，通常用于调试。
default_placeholder_observer	默认占位符观察者，通常用于量化为 torch.float16。
default_debug_observer	默认仅调试观察者。
default_weight_observer	默认权重观察者。
default_histogram_observer	默认直方图观察者，通常用于 PTQ。
default_per_channel_weight_observer	默认逐通道权重观察者，通常用于支持逐通道权重量化的后端，例如 fbgemm。
default_dynamic_quant_observer	动态量化的默认观察者。
default_float_qparams_observer	具有浮点零点的默认观察者。

torch.ao.quantization.fake_quantize

此模块实现用于在 QAT 期间执行伪量化的模块。

FakeQuantizeBase	基础伪量化模块。
FakeQuantize	在训练时模拟量化和反量化操作。
FixedQParamsFakeQuantize	在训练时模拟量化和反量化。
FusedMovingAvgObsFakeQuantize	定义一个融合模块来观察张量。
default_fake_quant	激活的默认 fake_quant。
default_weight_fake_quant	权重的默认 fake_quant。
default_per_channel_weight_fake_quant	逐通道权重的默认 fake_quant。
default_histogram_fake_quant	使用直方图的激活 fake_quant。
default_fused_act_fake_quant	default_fake_quant 的融合版本，具有改进的性能。
default_fused_wt_fake_quant	default_weight_fake_quant 的融合版本，具有改进的性能。
default_fused_per_channel_wt_fake_quant	default_per_channel_weight_fake_quant 的融合版本，具有改进的性能。
disable_fake_quant	禁用模块的伪量化。
enable_fake_quant	启用模块的伪量化。
disable_observer	禁用此模块的观察。
enable_observer	启用此模块的观察。

torch.ao.quantization.qconfig

此模块定义 QConfig 对象，这些对象用于配置各个操作的量化设置。

QConfig	通过分别为激活和权重提供设置（观察者类）来描述如何量化层或网络的一部分。
default_qconfig	默认 qconfig 配置。
default_debug_qconfig	用于调试的默认 qconfig 配置。
default_per_channel_qconfig	用于逐通道权重量化的默认 qconfig 配置。
default_dynamic_qconfig	默认动态 qconfig。
float16_dynamic_qconfig	权重量化为 torch.float16 的动态 qconfig。
float16_static_qconfig	激活和权重都量化为 torch.float16 的动态 qconfig。
per_channel_dynamic_qconfig	权重按通道量化的动态 qconfig。
float_qparams_weight_only_qconfig	权重使用浮点零点量化的动态 qconfig。
default_qat_qconfig	QAT 的默认 qconfig。
default_weight_only_qconfig	仅量化权重的默认 qconfig。
default_activation_only_qconfig	仅量化激活的默认 qconfig。
default_qat_qconfig_v2	default_qat_config 的融合版本，具有性能优势。

torch.ao.nn.intrinsic

此模块实现 conv + relu 等组合（融合）模块，然后可以对其进行量化。

ConvReLU1d	这是一个顺序容器，它调用 Conv1d 和 ReLU 模块。
ConvReLU2d	这是一个顺序容器，它调用 Conv2d 和 ReLU 模块。
ConvReLU3d	这是一个顺序容器，它调用 Conv3d 和 ReLU 模块。
LinearReLU	这是一个顺序容器，它调用 Linear 和 ReLU 模块。
ConvBn1d	这是一个顺序容器，它调用 Conv 1d 和 Batch Norm 1d 模块。
ConvBn2d	这是一个顺序容器，它调用 Conv 2d 和 Batch Norm 2d 模块。
ConvBn3d	这是一个顺序容器，它调用 Conv 3d 和 Batch Norm 3d 模块。
ConvBnReLU1d	这是一个顺序容器，它调用 Conv 1d、Batch Norm 1d 和 ReLU 模块。
ConvBnReLU2d	这是一个顺序容器，它调用 Conv 2d、Batch Norm 2d 和 ReLU 模块。
ConvBnReLU3d	这是一个顺序容器，它调用 Conv 3d、Batch Norm 3d 和 ReLU 模块。
BNReLU2d	这是一个顺序容器，它调用 BatchNorm 2d 和 ReLU 模块。
BNReLU3d	这是一个顺序容器，它调用 BatchNorm 3d 和 ReLU 模块。

torch.ao.nn.intrinsic.qat

此模块实现了量化感知训练所需的那些融合操作的版本。

LinearReLU	从 Linear 和 ReLU 模块融合的 LinearReLU 模块，附加了用于权重的 FakeQuantize 模块，用于量化感知训练。
ConvBn1d	ConvBn1d 模块是从 Conv1d 和 BatchNorm1d 融合的模块，附加了用于权重的 FakeQuantize 模块，用于量化感知训练。
ConvBnReLU1d	ConvBnReLU1d 模块是从 Conv1d、BatchNorm1d 和 ReLU 融合的模块，附加了用于权重的 FakeQuantize 模块，用于量化感知训练。
ConvBn2d	ConvBn2d 模块是从 Conv2d 和 BatchNorm2d 融合的模块，附加了用于权重的 FakeQuantize 模块，用于量化感知训练。
ConvBnReLU2d	ConvBnReLU2d 模块是从 Conv2d、BatchNorm2d 和 ReLU 融合的模块，附加了用于权重的 FakeQuantize 模块，用于量化感知训练。
ConvReLU2d	ConvReLU2d 模块是 Conv2d 和 ReLU 的融合模块，附加了用于权重量化感知训练的 FakeQuantize 模块。
ConvBn3d	ConvBn3d 模块是从 Conv3d 和 BatchNorm3d 融合的模块，附加了用于权重的 FakeQuantize 模块，用于量化感知训练。
ConvBnReLU3d	ConvBnReLU3d 模块是从 Conv3d、BatchNorm3d 和 ReLU 融合的模块，附加了用于权重的 FakeQuantize 模块，用于量化感知训练。
ConvReLU3d	ConvReLU3d 模块是 Conv3d 和 ReLU 的融合模块，附加了用于权重量化感知训练的 FakeQuantize 模块。
update_bn_stats
freeze_bn_stats

torch.ao.nn.intrinsic.quantized

此模块实现了融合操作（如 conv + relu）的量化实现。没有 BatchNorm 变体，因为它通常被折叠到卷积中以进行推理。

BNReLU2d	BNReLU2d 模块是 BatchNorm2d 和 ReLU 的融合模块
BNReLU3d	BNReLU3d 模块是 BatchNorm3d 和 ReLU 的融合模块
ConvReLU1d	ConvReLU1d 模块是 Conv1d 和 ReLU 的融合模块
ConvReLU2d	ConvReLU2d 模块是 Conv2d 和 ReLU 的融合模块
ConvReLU3d	ConvReLU3d 模块是 Conv3d 和 ReLU 的融合模块
LinearReLU	LinearReLU 模块是从 Linear 和 ReLU 模块融合的

torch.ao.nn.intrinsic.quantized.dynamic

此模块实现融合操作（如 linear + relu）的量化动态实现。

LinearReLU

从 Linear 和 ReLU 模块融合的 LinearReLU 模块，可用于动态量化。

torch.ao.nn.qat

此模块实现了关键 nn 模块 Conv2d() 和 Linear() 的版本，这些版本在 FP32 中运行，但应用了舍入以模拟 INT8 量化的效果。

Conv2d	附加了用于权重的 FakeQuantize 模块的 Conv2d 模块，用于量化感知训练。
Conv3d	附加了用于权重的 FakeQuantize 模块的 Conv3d 模块，用于量化感知训练。
Linear	附加了用于权重的 FakeQuantize 模块的线性模块，用于量化感知训练。

torch.ao.nn.qat.dynamic

此模块实现了关键 nn 模块（如 Linear()）的版本，这些版本在 FP32 中运行，但应用了舍入以模拟 INT8 量化的效果，并且将在推理期间动态量化。

Linear

附加了用于权重的 FakeQuantize 模块的线性模块，用于动态量化感知训练。

torch.ao.nn.quantized

此模块实现了 nn 层的量化版本，例如 ~`torch.nn.Conv2d` 和 torch.nn.ReLU。

ReLU6	应用元素级函数
Hardswish	这是 Hardswish 的量化版本。
ELU	这是 ELU 的量化等效项。
LeakyReLU	这是 LeakyReLU 的量化等效项。
Sigmoid	这是 Sigmoid 的量化等效项。
BatchNorm2d	这是 BatchNorm2d 的量化版本。
BatchNorm3d	这是 BatchNorm3d 的量化版本。
Conv1d	将 1D 卷积应用于由多个量化输入平面组成的量化输入信号。
Conv2d	将 2D 卷积应用于由多个量化输入平面组成的量化输入信号。
Conv3d	将 3D 卷积应用于由多个量化输入平面组成的量化输入信号。
ConvTranspose1d	对由多个输入平面组成的输入图像应用 1D 转置卷积运算符。
ConvTranspose2d	对由多个输入平面组成的输入图像应用 2D 转置卷积运算符。
ConvTranspose3d	对由多个输入平面组成的输入图像应用 3D 转置卷积运算符。
Embedding	一个量化的 Embedding 模块，使用量化打包权重作为输入。
EmbeddingBag	一个量化的 EmbeddingBag 模块，使用量化打包权重作为输入。
FloatFunctional	用于浮点运算的状态收集器类。
FXFloatFunctional	用于在 FX 图模式量化之前替换 FloatFunctional 模块的模块，因为 activation_post_process 将直接插入到顶层模块中
QFunctional	量化运算的包装器类。
Linear	一个量化的线性模块，使用量化张量作为输入和输出。
LayerNorm	这是 LayerNorm 的量化版本。
GroupNorm	这是 GroupNorm 的量化版本。
InstanceNorm1d	这是 InstanceNorm1d 的量化版本。
InstanceNorm2d	这是 InstanceNorm2d 的量化版本。
InstanceNorm3d	这是 InstanceNorm3d 的量化版本。

torch.ao.nn.quantized.functional

函数式接口（量化）。

此模块实现了函数式层的量化版本，例如 ~`torch.nn.functional.conv2d` 和 torch.nn.functional.relu。注意：relu() 支持量化输入。

avg_pool2d	在 $kH \times kW$ 区域上应用 2D 平均池化操作，步长为 $sH \times sW$。
avg_pool3d	在 $kD \ times kH \times kW$ 区域上应用 3D 平均池化操作，步长为 $sD \times sH \times sW$。
adaptive_avg_pool2d	对由多个量化输入平面组成的量化输入信号应用 2D 自适应平均池化。
adaptive_avg_pool3d	对由多个量化输入平面组成的量化输入信号应用 3D 自适应平均池化。
conv1d	对由多个输入平面组成的量化 1D 输入应用 1D 卷积。
conv2d	对由多个输入平面组成的量化 2D 输入应用 2D 卷积。
conv3d	对由多个输入平面组成的量化 3D 输入应用 3D 卷积。
interpolate	将输入下采样/上采样到给定的 size 或给定的 scale_factor
linear	对传入的量化数据应用线性变换：$y = xA^T + b$。
max_pool1d	对由多个量化输入平面组成的量化输入信号应用 1D 最大池化。
max_pool2d	对由多个量化输入平面组成的量化输入信号应用 2D 最大池化。
celu	逐元素地应用量化 CELU 函数。
leaky_relu	的量化版本。
hardtanh	这是 hardtanh() 的量化版本。
hardswish	这是 hardswish() 的量化版本。
threshold	逐元素地应用阈值函数的量化版本
elu	这是 elu() 的量化版本。
hardsigmoid	这是 hardsigmoid() 的量化版本。
clamp	float(input, min_, max_) -> Tensor
upsample	将输入上采样到给定的 size 或给定的 scale_factor
upsample_bilinear	使用双线性插值上采样输入。
upsample_nearest	使用最近邻像素值上采样输入。

torch.ao.nn.quantizable

此模块实现了某些 nn 层的可量化版本。这些模块可以与自定义模块机制结合使用，方法是为 prepare 和 convert 都提供 custom_module_config 参数。

LSTM	一个可量化的长短期记忆 (LSTM) 网络。
MultiheadAttention

torch.ao.nn.quantized.dynamic

动态量化的 Linear、LSTM、LSTMCell、GRUCell 和 RNNCell。

Linear	一个动态量化的线性模块，使用浮点张量作为输入和输出。
LSTM	一个动态量化的 LSTM 模块，使用浮点张量作为输入和输出。
GRU	将多层门控循环单元 (GRU) RNN 应用于输入序列。
RNNCell	一个具有 tanh 或 ReLU 非线性的 Elman RNN 单元。
LSTMCell	一个长短期记忆 (LSTM) 单元。
GRUCell	一个门控循环单元 (GRU) 单元

量化数据类型和量化方案

请注意，运算符实现目前仅支持 **conv** 和 **linear** 运算符权重的逐通道量化。此外，输入数据线性映射到量化数据，反之亦然，如下所示

$$\begin{aligned} \text{Quantization:}&\\ &Q_\text{out} = \text{clamp}(x_\text{input}/s+z, Q_\text{min}, Q_\text{max})\\ \text{Dequantization:}&\\ &x_\text{out} = (Q_\text{input}-z)*s \end{aligned}$$

其中 $\text{clamp}(.)$ 与 clamp() 相同，而比例 $s$ 和零点 $z$ 的计算方式如 MinMaxObserver 中所述，具体而言

$$\begin{aligned} \text{if Symmetric:}&\\ &s = 2 \max(|x_\text{min}|, x_\text{max}) / \left( Q_\text{max} - Q_\text{min} \right) \\ &z = \begin{cases} 0 & \text{if dtype is qint8} \\ 128 & \text{otherwise} \end{cases}\\ \text{Otherwise:}&\\ &s = \left( x_\text{max} - x_\text{min} \right ) / \left( Q_\text{max} - Q_\text{min} \right ) \\ &z = Q_\text{min} - \text{round}(x_\text{min} / s) \end{aligned}$$

其中 $[x_\text{min}, x_\text{max}]$ 表示输入数据的范围，而 $Q_\text{min}$ 和 $Q_\text{max}$ 分别是量化数据类型的最小值和最大值。

请注意，$s$ 和 $z$ 的选择意味着，当零在输入数据范围内或使用对称量化时，零表示不会出现量化误差。

可以通过 自定义运算符机制 实现其他数据类型和量化方案。

• 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 下的相应文件中，同时在此处添加导入语句。