torch.ao.ns._numeric_suite_fx

创建于: 2025年6月13日 | 最后更新于: 2025年6月13日

警告

This module is an early prototype and is subject to change.

此模块包含用于比较模型之间权重和激活的工具。用法示例

import copy
import torch
import torch.ao.quantization.quantize_fx as quantize_fx
import torch.ao.ns._numeric_suite_fx as ns

m = torch.nn.Sequential(torch.nn.Conv2d(1, 1, 1)).eval()
mp = quantize_fx.prepare_fx(m, {"": torch.ao.quantization.default_qconfig})
# We convert a copy because we need the original prepared model
# to be available for comparisons, and `quantize_fx.convert_fx` is inplace.
mq = quantize_fx.convert_fx(copy.deepcopy(mp))

#
# Comparing weights
#

# extract weight pairs
weight_comparison = ns.extract_weights("a", mp, "b", mq)

# add SQNR for each comparison, inplace
ns.extend_logger_results_with_comparison(
    weight_comparison, "a", "b", torch.ao.ns.fx.utils.compute_sqnr, "sqnr"
)

# weight_comparison contains the weights from `mp` and `mq` stored
# in pairs, and can be used for further analysis.


#
# Comparing activations, with error propagation
#

# add loggers
mp_ns, mq_ns = ns.add_loggers(
    "a", copy.deepcopy(mp), "b", copy.deepcopy(mq), ns.OutputLogger
)

# send an example datum to capture intermediate activations
datum = torch.randn(1, 1, 1, 1)
mp_ns(datum)
mq_ns(datum)

# extract intermediate activations
act_comparison = ns.extract_logger_info(mp_ns, mq_ns, ns.OutputLogger, "b")

# add SQNR for each comparison, inplace
ns.extend_logger_results_with_comparison(
    act_comparison, "a", "b", torch.ao.ns.fx.utils.compute_sqnr, "sqnr"
)

# act_comparison contains the activations from `mp_ns` and `mq_ns` stored
# in pairs, and can be used for further analysis.

#
# Comparing activations, without error propagation
#

# create shadow model
mp_shadows_mq = ns.add_shadow_loggers(
    "a", copy.deepcopy(mp), "b", copy.deepcopy(mq), ns.OutputLogger
)

# send an example datum to capture intermediate activations
datum = torch.randn(1, 1, 1, 1)
mp_shadows_mq(datum)

# extract intermediate activations
shadow_act_comparison = ns.extract_shadow_logger_info(
    mp_shadows_mq, ns.OutputLogger, "b"
)

# add SQNR for each comparison, inplace
ns.extend_logger_results_with_comparison(
    shadow_act_comparison, "a", "b", torch.ao.ns.fx.utils.compute_sqnr, "sqnr"
)

# shadow_act_comparison contains the activations from `mp_ns` and `mq_ns` stored
# in pairs, and can be used for further analysis.

class torch.ao.ns._numeric_suite_fx.OutputLogger(ref_node_name, prev_node_name, model_name, ref_name, prev_node_target_type, ref_node_target_type, results_type, index_within_arg, index_of_arg, fqn, qconfig_str='')

捕获中间值的基类。

forward(x)

class torch.ao.ns._numeric_suite_fx.OutputComparisonLogger(*args, **kwargs)

与 OutputLogger 相同，但还需要原始激活，以便在校准时计算比较。

forward(x, x_ref)

class torch.ao.ns._numeric_suite_fx.NSTracer(skipped_module_names, skipped_module_classes)

与常规 FX 量化跟踪器一样，但将观察者和 fake_quantize 模块视为叶子模块。

is_leaf_module(m, module_qualified_name)

返回类型

布尔值

torch.ao.ns._numeric_suite_fx.extract_weights(model_name_a, model_a, model_name_b, model_b, base_name_to_sets_of_related_ops=None, unmatchable_types_map=None, op_to_type_to_weight_extraction_fn=None)

从模型 A 和模型 B 中提取权重，并返回比较结果。

参数

• model_name_a (str) – 用于结果中的模型 A 的字符串名称

• model_a (Module) – 模型 A

• model_name_b (str) – 用于结果中的模型 B 的字符串名称

• model_b (Module) – 模型 B

• base_name_to_sets_of_related_ops (Optional[dict[str, set[Union[Callable, str]]]]) – 可选的子图基本节点覆盖，可能发生更改

• unmatchable_types_map (Optional[dict[str, set[Union[Callable, str]]]]) – 可选的不可匹配类型覆盖，可能发生更改

• op_to_type_to_weight_extraction_fn (Optional[dict[str, dict[Callable, Callable]]]) – 从类型中提取权重的函数的可选覆盖，可能发生更改

返回

NSResultsType，包含权重比较

返回类型

dict[str, dict[str, dict[str, list[dict[str, Any]]]]]

torch.ao.ns._numeric_suite_fx.add_loggers(name_a, model_a, name_b, model_b, logger_cls, should_log_inputs=False, base_name_to_sets_of_related_ops=None, unmatchable_types_map=None)

为 model A 和 model B 添加 logger 仪器。

参数

• name_a (str) – model A 在结果中使用的字符串名称

• model_a (Module) – 模型 A

• name_b (str) – model B 在结果中使用的字符串名称

• model_b (Module) – 模型 B

• logger_cls (Callable) – 要使用的 Logger 的类

• base_name_to_sets_of_related_ops (Optional[dict[str, set[Union[Callable, str]]]]) – 可选的子图基本节点覆盖，可能发生更改

• unmatchable_types_map (Optional[dict[str, set[Union[Callable, str]]]]) – 可选的不可匹配类型覆盖，可能发生更改

返回

返回一个元组 (model_a_with_loggers, model_b_with_loggers)。就地修改两个模型。

返回类型

tuple[torch.nn.modules.module.Module, torch.nn.modules.module.Module]

torch.ao.ns._numeric_suite_fx.extract_logger_info(model_a, model_b, logger_cls, model_name_to_use_for_layer_names)

遍历 model_a 和 model_b 中的所有 logger，并提取记录的信息。

参数

• model_a (Module) – 模型 A

• model_b (Module) – 模型 B

• logger_cls (Callable) – 要使用的 Logger 的类

• model_name_to_use_for_layer_names (str) – 用于输出中层名称的模型字符串名称

返回

NSResultsType，包含记录的比较

返回类型

dict[str, dict[str, dict[str, list[dict[str, Any]]]]]

torch.ao.ns._numeric_suite_fx.add_shadow_loggers(name_a, model_a, name_b, model_b, logger_cls, should_log_inputs=False, base_name_to_sets_of_related_ops=None, node_type_to_io_type_map=None, unmatchable_types_map=None)

为 model A 和 model B 添加 shadow logger 仪器。

参数

• name_a (str) – model A 在结果中使用的字符串名称

• model_a (Module) – 模型 A

• name_b (str) – model B 在结果中使用的字符串名称

• model_b (Module) – 模型 B

• logger_cls (Callable) – 要使用的 Logger 的类

• should_log_inputs (bool) – 是否记录输入

• base_name_to_sets_of_related_ops (Optional[dict[str, set[Union[Callable, str]]]]) – 可选的子图基本节点覆盖，可能发生更改

• unmatchable_types_map (Optional[dict[str, set[Union[Callable, str]]]]) – 可选的不可匹配类型覆盖，可能发生更改

返回类型

模块

torch.ao.ns._numeric_suite_fx.extract_shadow_logger_info(model_a_shadows_b, logger_cls, model_name_to_use_for_layer_names)

遍历 shadow model 中的所有 logger，并提取记录的信息。

参数

• model_a_shadows_b (Module) – shadow model

• logger_cls (Callable) – 要使用的 Logger 的类

• model_name_to_use_for_layer_names (str) – 用于输出中层名称的模型字符串名称

返回

NSResultsType，包含记录的比较

返回类型

dict[str, dict[str, dict[str, list[dict[str, Any]]]]]

torch.ao.ns._numeric_suite_fx.extend_logger_results_with_comparison(results, model_name_1, model_name_2, comparison_fn, comparison_name)

使用 comparison_fn 将 model_name_2 的记录值与 model_name_1 的相应值进行比较。将结果记录在 model_name_2 的结果中的 comparison_name 下。就地修改 results。

参数

• results (dict[str, dict[str, dict[str, list[dict[str, Any]]]]]) – 来自 extract_logger_info 或 extract_shadow_logger_info 的结果数据结构。

• model_name_1 (str) – model 1 的字符串名称

• model_name_2 (str) – model 2 的字符串名称

• comparison_fn (Callable[[Tensor, Tensor], Tensor]) – 用于比较两个 Tensor 的函数

• comparison_name (str) – 用于输出中层名称的模型字符串名称

torch.ao.ns._numeric_suite_fx.prepare_n_shadows_model(model, example_inputs, qconfig_multi_mapping, backend_config, custom_prepare_fn=None, custom_prepare_kwargs=None, custom_tracer=None)

给定一个具有 M 个操作的图的模型，例如

args_kwargs_m -> op_m -> output_m

以及每个 op 的 N 个 qconfig 集合，创建一个新模型，其中 op_m 的每个子图被转换为

     |---------> op_m_n -> log_m_n
     |                     /
args_kwargs_m ---------> op_m -> log_m_0

其中 op_m_n 是包装在子模块中的 op_m，并使用 qconfig_n 进行转换，其内部图看起来像

args_m -------- op_m_prepared_with_qconfig_n -> out_m_n
            /
kwargs_m ---

这对于在单次模型通过中测试多个层的不同量化非常有用。

高级 TODO 列表，用于后续 PR： * 找到一种更好的方法来命名输出结构 * 返回结果数据结构而不是打印它 * 向 docblocks 添加示例

返回类型

GraphModule

torch.ao.ns._numeric_suite_fx.loggers_set_enabled(model, enabled)

设置 model 的 logger 的 enabled 设置

torch.ao.ns._numeric_suite_fx.loggers_set_save_activations(model, save_activations)

设置 model 的 logger 的 save_activations 设置

torch.ao.ns._numeric_suite_fx.convert_n_shadows_model(model, custom_convert_fn=None, custom_convert_kwargs=None)

给定一个来自 prepare_n_shadows_model 的模型，对每个 shadow 子模块运行 convert_fx。

返回类型

GraphModule

torch.ao.ns._numeric_suite_fx.extract_results_n_shadows_model(model)

从 model 中提取 logger 结果。

返回类型

dict[str, dict[str, dict[str, list[dict[str, Any]]]]]

torch.ao.ns._numeric_suite_fx.print_comparisons_n_shadows_model(results)

打印提取的 results 的摘要。

---

torch.ao.ns.fx.utils

警告

This module is an early prototype and is subject to change.

torch.ao.ns.fx.utils.compute_sqnr(x, y)

torch.ao.ns.fx.utils.compute_normalized_l2_error(x, y)

torch.ao.ns.fx.utils.compute_cosine_similarity(x, y)