torch.ao.ns._numeric_suite_fx

警告

此模組為早期原型，可能會有所變動。

此模組包含用於比較模型之間的權重和激活的工具。範例用法

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.

類別 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)

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

與 OutputLogger 相同，但也需要原始激活以在校準時計算比較。

forward(x, x_ref)

類別 torch.ao.ns._numeric_suite_fx.NSTracer(skipped_module_names, skipped_module_classes)

就像一般的 FX 量化追蹤器一樣，但將觀察器和 fake_quantize 模組視為葉模組。

is_leaf_module(m, module_qualified_name)

回傳類型

bool

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)

使用記錄器檢測模型 A 和模型 B。

參數

• name_a (str) – 模型 A 的字串名稱，用於結果中

• model_a (Module) – 模型 A

• name_b (str) – 模型 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。就地修改兩個模型。

回傳類型

Tuple[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 中的所有記錄器，並提取記錄的訊息。

參數

• 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)

使用陰影記錄器檢測模型 A 和模型 B。

參數

• name_a (str) – 模型 A 的字串名稱，用於結果中

• model_a (Module) – 模型 A

• name_b (str) – 模型 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)

遍歷陰影模型中的所有記錄器，並提取記錄的訊息。

參數

• model_a_shadows_b (Module) – 陰影模型

• 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 中的對應值進行比較。在 comparison_name 下的 model_name_2 結果中記錄結果。就地修改 results。

參數

• results (Dict[str, Dict[str, Dict[str, List[Dict[str, Any]]]]]) – 來自 extract_logger_info 或 extract_shadow_logger_info 的結果資料結構。

• model_name_1 (str) – 模型 1 的字串名稱

• model_name_2 (str) – 模型 2 的字串名稱

• comparison_fn (Callable[[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

以及每個操作的 N 個 qconfig 集合，建立一個新的模型，其中每個 op_m 的子圖形轉換為

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

其中 op_m_n 是包裝在子模組中並使用 qconfig_n 轉換的 op_m，其內部圖形如下所示

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

這對於在單次通過模型時測試多個層的不同量化非常有用。

未來公關的高級待辦事項：* 找出更好的方法來命名輸出結構 * 返回結果資料結構而不是將其列印出來 * 在文件區塊中添加示例

回傳類型

圖形模組

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

設定 model 的記錄器的 enabled 設定

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

設定 model 的記錄器的 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 的模型，在每個影子子模組上執行 convert_fx。

回傳類型

圖形模組

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

從 model 中提取記錄器結果。

回傳類型

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

警告

此模組為早期原型，可能會有所變動。

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)