-
Notifications
You must be signed in to change notification settings - Fork 493
Expand file tree
/
Copy pathmodel_quant.py
More file actions
687 lines (538 loc) · 28.8 KB
/
Copy pathmodel_quant.py
File metadata and controls
687 lines (538 loc) · 28.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""User-facing quantization API."""
import fnmatch
import inspect
import os
import warnings
from collections.abc import Callable, Iterable
from typing import Any
import torch
import torch.nn as nn
import modelopt.torch.quantization as mtq
from modelopt.torch.opt import apply_mode
from modelopt.torch.opt.searcher import ForwardLoop
from modelopt.torch.opt.utils import forward_with_reshard
from modelopt.torch.quantization.config import QuantizeConfig
from modelopt.torch.quantization.conversion import (
set_quantizer_attributes_partial,
set_quantizer_by_cfg,
)
from modelopt.torch.utils import atomic_print
from .algorithms import AutoQuantizeGradientSearcher, AutoQuantizeKLDivSearcher, QuantRecipe
from .algorithms import get_auto_quantize_config as _get_auto_quantize_config
from .config import QuantizeAlgoCfgType
from .mode import QuantizeModeRegistry, get_modelike_from_algo_cfg
from .nn import QuantModule, TensorQuantizer
from .utils import is_quantized
__all__ = [
"auto_quantize",
"calibrate",
"compute_quantization_mse",
"disable_quantizer",
"enable_quantizer",
"fold_weight",
"get_auto_quantize_config",
"postprocess_amax",
"print_quant_summary",
"quantize",
]
# TODO: Descriptors for the supported algorithms
def calibrate(
model: nn.Module,
algorithm: QuantizeAlgoCfgType = "max",
forward_loop: ForwardLoop | None = None,
) -> nn.Module:
"""Adjusts weights and scaling factors based on selected algorithms.
In order to calibrate using custom user defined calibration algorithm, refer to
:ref:`custom calibration algorithm <custom_calibration_algorithm>`
Args:
model: A pytorch model with quantizer modules.
algorithm: A string or dictionary specifying the calibration algorithm to use. Supported
algorithms are ``"max"``, ``"smoothquant"``, ``"awq_lite"``, ``"awq_full"``, and
``"awq_clip"``. If a dictionary is passed, the key ``"method"`` should specify the
calibration algorithm to use. Other key-value pairs in this dictionary will be passed
as kwargs to the algorithm.
An example dictionary argument:
``{"method": "awq_clip", "max_co_batch_size": 4096}``.
If ``None``, no calibration is performed.
forward_loop: A callable which takes the model as argument and forwards calibration data
through the model. This is not required for weight-only quantization with the ``"max"``
algorithm.
Returns: The calibrated pytorch model.
"""
if forward_loop is not None:
# get the number of arguments of forward_loop
num_args = len(inspect.signature(forward_loop).parameters)
if num_args == 0:
warnings.warn(
(
"forward_loop should take model as argument, but got forward_loop without any"
" arguments. This usage will be deprecated in future versions."
),
DeprecationWarning,
)
original_forward_loop = forward_loop
def forward_loop(model):
return original_forward_loop() # type: ignore[call-arg]
# move the model to eval mode
is_training = model.training
model.eval()
with forward_with_reshard(model):
apply_mode(
model,
mode=get_modelike_from_algo_cfg(algorithm),
mode_kwargs={"forward_loop": forward_loop},
)
for name, module in model.named_modules():
if isinstance(module, TensorQuantizer):
for attr_name in ["_amax", "_pre_quant_scale"]:
module.validate_attr(attr_name=attr_name, warn_error=True, name=name)
# TODO: Re-enable when the CUDA error: unspecified launch failure is fixed.
# clear_cuda_cache()
model.train(is_training)
return model
def postprocess_amax(model: nn.Module, key: str, post_process_fn) -> nn.Module:
"""Experimental API to postprocess the amax values after calibration."""
assert isinstance(key, str), "key should be a string"
for name, module in model.named_modules():
if not isinstance(module, TensorQuantizer):
continue
if not hasattr(module, "_amax"):
continue
if not fnmatch.fnmatch(name, key):
continue
module.amax = post_process_fn(module.amax)
return model
def quantize(
model: nn.Module,
config: dict[str, Any | QuantizeConfig],
forward_loop: ForwardLoop | None = None,
) -> nn.Module:
"""Quantizes and calibrates the model in-place.
This method performs replacement of modules with their quantized counterparts and
performs calibration as specified by ``quant_cfg``.
``forward_loop`` is used to forward data through the model and gather statistics for calibration.
If the model is already quantized, the provided ``config`` is applied to the existing
quantizers and calibration is run.
Args:
model: A pytorch model
config: A dictionary or an instance of
:class:`QuantizeConfig <modelopt.torch.quantization.config.QuantizeConfig>` specifying the
values for keys ``"quant_cfg"`` and ``"algorithm"``.
It is basically a dictionary specifying the values for keys ``"quant_cfg"`` and ``"algorithm"``.
The ``"quant_cfg"`` key specifies the quantization configurations as an ordered list of
:class:`QuantizerCfgEntry <modelopt.torch.quantization.config.QuantizerCfgEntry>` dicts.
The ``"algorithm"`` key specifies the ``algorithm`` argument to
:meth:`calibrate <modelopt.torch.quantization.model_quant.calibrate>`.
Each entry in the ``"quant_cfg"`` list has a ``"quantizer_name"`` wildcard matched
against quantizer module names, an optional ``"cfg"`` dict of quantizer attributes,
and an optional ``"enable"`` toggle. Entries are applied in list order; later entries
override earlier ones. The quantizer modules have names ending with
``weight_quantizer`` and ``input_quantizer`` and they perform weight quantization and
input quantization (or activation quantization) respectively. The quantizer modules
are instances of
:class:`TensorQuantizer <modelopt.torch.quantization.nn.modules.tensor_quantizer.TensorQuantizer>`.
The quantizer attributes are defined by :class:`QuantizerAttributeConfig`. See
:class:`QuantizerAttributeConfig` for details on the quantizer attributes and their values.
An example ``config`` dictionary is given below:
.. code-block::python
config = {
"quant_cfg": [
# Disable all quantizers by default
{"quantizer_name": "*", "enable": False},
# "num_bits" specifies the number of bits for quantization
# "axis" specifies the axis for quantization
{"quantizer_name": "*weight_quantizer", "cfg": {"num_bits": 8, "axis": 0}},
{"quantizer_name": "*input_quantizer", "cfg": {"num_bits": 8, "axis": -1}},
],
"algorithm": "max",
}
See :ref:`Quantization Formats <quantization-formats>` to learn more about the supported
quantization formats. See :ref:`Quantization Configs <quantization-configs>` for more details on
``config`` dictionary.
forward_loop: A callable that forwards all calibration data through the model. This is used
to gather statistics for calibration. It should take model as the argument. It does not need
to return anything.
This argument is not required for weight-only quantization with the ``"max"``
algorithm.
Here are a few examples for correct ``forward_loop`` definitions:
Example 1:
.. code-block::
def forward_loop(model) -> None:
# iterate over the data loader and forward data through the model
for batch in data_loader:
model(batch)
Example 2:
.. code-block::
def forward_loop(model) -> float:
# evaluate the model on the task
return evaluate(model, task, ....)
Example 3:
.. code-block::
def forward_loop(model) -> None:
# run evaluation pipeline
evaluator.model = model
evaluator.evaluate()
.. note::
Calibration does not require forwarding the entire dataset through the model.
Please subsample the dataset or reduce the number of batches if needed.
Returns: A pytorch model which has been quantized and calibrated.
"""
if not is_quantized(model):
model = apply_mode(model, mode=[("quantize", dict(config))], registry=QuantizeModeRegistry)
else:
# Already quantized, so lets apply the quant_cfg from the config
quant_cfg = QuantizeConfig(**dict(config)).quant_cfg
set_quantizer_by_cfg(model, quant_cfg)
return calibrate(model, config.get("algorithm"), forward_loop=forward_loop)
# TODO: create a config interface for auto_quantize and expose setting
# quant_grouping_rules and score_module_rules as part of the config.
# This will allow users to customize the grouping and scoring rules for their models.
# This way wecan limit the granularity of quantization search. For example,
# - limit the quantization format search to decoder block level (instead of each linear layer level)
# - Same format for all self attention layers of a model etc.
_AUTO_QUANTIZE_SUPPORTED_ALGORITHMS = {
None,
"max",
"mse",
"local_hessian",
"smoothquant",
"awq_lite",
"awq_full",
"awq_clip",
}
def auto_quantize(
model: nn.Module,
constraints: dict[str, float | str] = {"effective_bits": 4.8},
quantization_formats: list[dict[str, Any] | str] = [
mtq.NVFP4_AWQ_LITE_CFG,
mtq.FP8_DEFAULT_CFG,
],
data_loader: Iterable | None = None,
forward_step: Callable[[nn.Module, Any], Any | torch.Tensor] | None = None,
loss_func: Callable[[Any, Any], torch.Tensor] | None = None,
forward_backward_step: Callable[[nn.Module, Any], Any] | None = None,
disabled_layers: list[str] | str | None = None,
num_calib_steps: int = 512,
num_score_steps: int = 128,
verbose: bool = False,
method: str = "gradient",
checkpoint: str | None = None,
):
r"""Perform optimal per-layer quantization by searching for the best quantization formats per-layer.
``auto_quantize`` uses sensitivity scores to rank the per-layer quantization formats and search
for the best quantization formats per-layer. The sensitivity score can be computed using gradient-based
methods (default) or KL divergence loss, controlled by the ``method`` parameter.
Internally this API runs two main phases:
#. Calibrate the quantized model exactly like :func:`quantize` would.
#. Estimate per-layer sensitivity scores to decide which format to keep.
The sensitivity scoring phase typically dominates the runtime of ``auto_quantize``, so decreasing the number of
samples used for scoring (see ``num_score_steps``) is the recommended way for improving overall auto_quantize time
with minimal accuracy impact.
Args:
model: A pytorch model with quantizer modules.
constraints: Constraints for the search. Currently we support only ``effective_bits``.
``effective_bits`` specifies the effective number of bits for the quantized model.
Here is an example for valid ``effective_bits`` argument:
.. code-block:: python
# For an effective quantization bits of 4.8
constraints = {"effective_bits": 4.8}
quantization_formats: A list of quantization format config dictionaries or string names to search for.
Each config dictionary should be valid as a ``config`` argument in
:meth:`quantize <modelopt.torch.quantization.model_quant.quantize>`.
The supported quantization format names are as listed by :attr:`modelopt.torch.quantization.config.choices`.
Internally we always add "do not quantize" as a choice. Therefore, it is possible that a layer is
not quantized by any of the quantization formats.
Custom quantization formats can also be defined and used as a quantization format. This is a experimental
feature and the results may not be optimal. Here is an example:
.. code-block:: python
INT8_CUSTOM_QUANT_CFG = {
"quant_cfg": [
{"quantizer_name": "*weight_quantizer", "cfg": {"num_bits": 8, "axis": 0}},
{
"quantizer_name": "*input_quantizer",
"cfg": {"num_bits": 8, "axis": None},
},
],
"algorithm": "smoothquant",
}
mtq.auto_quantize(
model,
constraints,
quantization_formats=["INT4_AWQ_CFG", INT8_CUSTOM_QUANT_CFG],
)
Internally we always add "do not quantize" as a choice. Therefore, it is possible that a layer is
not quantized by any of the quantization formats.
.. note::
The quantization formats will be applied on a per-layer match basis. The global model level name
based quantizer attribute setting will be ignored. For example, in ``FP8_DEFAULT_CFG`` quantizer
configuration the key ``"*lm_head*": {"enable": False}`` disables quantization for the ``lm_head``
layer. However in ``auto_quantize``, the quantization format for the ``lm_head`` layer will be searched.
This is because the key ``"*lm_head*"`` sets the quantizer attributes based on the global model level
name, not per-layer basis. The keys ``"*input_quantizer"``, ``"*weight_quantizer"`` etc. in
``FP8_DEFAULT_CFG`` match on a per-layer basis - hence the corresponding quantizers
will be set as specified.
Here is an example `quantization_formats` argument:
.. code-block:: python
# A valid `quantization_formats` argument
# This will search for the best per-layer quantization from FP8, W4A8_AWQ_BETA_CFG or No quantization
quantization_formats = [mtq.FP8_DEFAULT_CFG, mtq.W4A8_AWQ_BETA_CFG]
data_loader: An iterator that yields data that is to be used for calibrating quantized layers and estimating
``auto_quantize`` scores.
forward_step: A callable that takes the model and a batch of data from ``data_loader`` as input, forwards
the data through the model and returns the model output.
This is a required argument.
Here is an example for a valid ``forward_step``:
.. code-block:: python
# Takes the model and a batch of data as input and returns the model output
def forward_step(model, batch) -> torch.Tensor:
output = model(batch)
return output
loss_func: (Optional) A callable that takes the model output and the batch of data as input and computes the
loss. The model output is the output given by ``forward_step``. `.backward()` will be called on the loss.
Here is an example for a valid ``loss_func``:
.. code-block:: python
# Takes the model output and a batch of data as input and returns the loss
def loss_func(output, batch) -> torch.Tensor:
...
return loss
# loss should be a scalar tensor such that loss.backward() can be called
loss = loss_func(output, batch)
loss.backward()
If this argument is not provided, ``forward_backward_step`` should be provided.
forward_backward_step: (Optional) A callable that takes batch of data from ``data_loader``, forwards it
through the model, computes the loss and runs backward on the loss.
Here is an example for a valid ``forward_backward_step`` argument:
.. code-block:: python
# Takes the model and a batch of data as input and runs forward and backward pass
def forward_backward_step(model, batch) -> None:
output = model(batch)
loss = my_loss_func(output, batch)
run_custom_backward(loss)
If this argument is not provided, ``loss_func`` should be provided.
disabled_layers: (Optional) One or a list of wildcard strings to disable quantization for the layers. Example:
.. code-block:: python
disabled_layers = "*lm_head*"
disabled_layers = ["*lm_head*", "*mlp*"]
num_calib_steps: Number of batches to use for calibrating each candidate quantization format. Suggested value
is 512.
num_score_steps: Number of batches to use for estimating ``auto_quantize`` scores. Suggested value is 128.
A higher value could increase the time taken for performing ``auto_quantize``; reducing it speeds up the
sensitivity score estimation phase and typically affects accuracy less than lowering ``num_calib_steps``.
verbose: If True, prints the search progress/intermediate results.
method: Method to use for estimating sensitivity loss. Higher loss indicates greater sensitivity
to quantization. Options are ``"gradient"`` (default; uses gradient-based loss estimation,
linear programming search, and requires ``loss_func`` or ``forward_backward_step``) and
``"kl_div"`` (uses KL divergence between unquantized and quantized outputs, relies on
threshold-based binary search, and only requires ``forward_step`` returning logits).
checkpoint: (Optional) Path to checkpoint file for saving/restoring auto_quantize search state.
If the checkpoint file exists, the search state will be restored from it, skipping the
expensive score estimation step.
Returns: A tuple (model, state_dict) where ``model`` is the searched and quantized model and
``state_dict`` contains the history and detailed stats of the search procedure.
.. note::
``auto_quantize`` groups certain layers and restricts the quantization formats for them to be same. For example,
Q, K, V linear layers belonging to the same transformer layer will have the same quantization format.
This is to ensure compatibility with TensorRT-LLM which fuses these three linear layers into a single linear
layer.
Grouping rules are defined in :attr:`quant_grouping_rules
<.algorithms.AutoQuantizeSearcher.quant_grouping_rules>`.
Each rule can be either a regex pattern or a callable function.
- **Regex patterns**: The first captured group (e.g.,
``pattern.match(name).group(1)``) determines the group key.
Layers with the same group key share the same quantization format.
- **Functions**: Should take a module name and return a group key
(or ``None`` if the rule doesn't apply).
Example regex rule: ``r"^(.*?)\.(q_proj|k_proj|v_proj)$"`` groups the
`q_proj`, `k_proj`, `v_proj` layers belonging to the same transformer layer.
You can customize the rules as needed:
.. code-block:: python
from modelopt.torch.quantization.algorithms import AutoQuantizeSearcher
# Add a regex rule to group layers in the same `mlp` module
AutoQuantizeSearcher.quant_grouping_rules.append(r"^(.*?)\.mlp")
# Or add a function rule for custom logic
AutoQuantizeSearcher.quant_grouping_rules.append(
lambda name: name.rsplit(".", 1)[0] if "expert" in name else None
)
# Perform `auto_quantize`
model, state_dict = auto_quantize(model, ...)
.. note::
The ``auto_quantize`` API and algorithm is experimental and subject to change. ``auto_quantize`` searched models
might not be readily deployable to TensorRT-LLM yet.
"""
processed_quantization_formats = []
for i, quant_cfg in enumerate(quantization_formats):
if quant_cfg is None:
continue
name = QuantRecipe.get_auto_name_for_config(quant_cfg)
if name is None:
name = f"CUSTOM_{i}"
warnings.warn(
f"Received custom quantization formats for search, auto_quantize results may not be optimal. "
f"This config will be displayed as {name}"
)
processed_quantization_formats.append((quant_cfg, name))
assert len(processed_quantization_formats) > 0, "`quantization_formats` should not be empty"
for quant_cfg, name in processed_quantization_formats:
algo = QuantRecipe(quant_cfg, name=name).config.algorithm
algo_method = algo["method"] if isinstance(algo, dict) else algo
if algo_method not in _AUTO_QUANTIZE_SUPPORTED_ALGORITHMS:
raise ValueError(
f"Algorithm '{algo_method}' in '{name}' is not supported by auto_quantize yet. "
"Please run auto_quantize with 'max' or 'mse' calibration and use "
"get_auto_quantize_config() to obtain a config for mtq.quantize()."
)
# Select the appropriate searcher based on method
if method == "gradient":
searcher = AutoQuantizeGradientSearcher()
elif method == "kl_div":
searcher = AutoQuantizeKLDivSearcher()
else:
raise ValueError(f"Invalid method: {method}. Valid options are 'gradient' or 'kl_div'.")
model = apply_mode(
model,
mode="auto_quantize",
registry=QuantizeModeRegistry,
)
search_config = {
"quantization_formats": processed_quantization_formats,
"data_loader": data_loader,
"forward_step": forward_step,
"loss_func": loss_func,
"forward_backward_step": forward_backward_step,
"num_calib_steps": num_calib_steps,
"num_score_steps": num_score_steps,
"disabled_layers": disabled_layers,
"verbose": verbose,
"checkpoint": checkpoint,
}
# Disable all quantizers; AutoQuantize will enable the needed ones
set_quantizer_by_cfg(model, [{"quantizer_name": "*", "enable": False}])
searcher.search(model, constraints, config=search_config) # type: ignore[arg-type]
return model, searcher.state_dict()
def get_auto_quantize_config(search_state, constraints=None, verbose=False):
"""Build a flat quant config from auto_quantize search_state.
Re-solves for ``constraints`` if provided, otherwise uses the stored best recipe.
Args:
search_state: The state dict returned by :func:`auto_quantize`.
constraints: Optional dict, e.g. ``{"effective_bits": 5.5}``, to re-solve for a
different target without re-running calibration or scoring.
verbose: If True, prints the per-layer recipe assignments.
Returns:
A config dict suitable for :func:`quantize`.
Example:
.. code-block:: python
model, search_state = mtq.auto_quantize(model, ...)
# Re-solve for a different effective_bits target (cheap, no GPU needed)
config = mtq.get_auto_quantize_config(search_state, {"effective_bits": 5.5})
# Or use the original result
config = mtq.get_auto_quantize_config(search_state)
# Reuse on the same model (e.g. run a longer calibration pass)
model = mtq.quantize(model, config, forward_loop=calibrate_loop)
# Or apply the same/customized config on a fresh model instance
# fresh_model = load_model(...)
# fresh_model = mtq.quantize(fresh_model, config, forward_loop=calibrate_loop)
"""
return _get_auto_quantize_config(search_state, constraints, verbose=verbose)
def disable_quantizer(model: nn.Module, wildcard_or_filter_func: str | Callable):
"""Disable quantizer by wildcard or filter function."""
set_quantizer_attributes_partial(model, wildcard_or_filter_func, {"enable": False})
def enable_quantizer(model: nn.Module, wildcard_or_filter_func: str | Callable):
"""Enable quantizer by wildcard or filter function."""
set_quantizer_attributes_partial(model, wildcard_or_filter_func, {"enable": True})
@atomic_print
def print_quant_summary(model: nn.Module, output_dir: str | None = None):
"""Print summary of all quantizer modules in the model."""
lines = [
f"{name:80} {mod}"
for name, mod in model.named_modules()
if isinstance(mod, TensorQuantizer)
]
lines.append(f"{len(lines)} TensorQuantizers found in model")
if output_dir:
os.makedirs(output_dir, exist_ok=True)
path = os.path.join(output_dir, ".quant_summary.txt")
with open(path, "w", encoding="utf-8") as f:
f.write("\n".join(lines) + "\n")
print(f"\033[1mQuant summary saved to {path}\033[0m")
else:
print("\n".join(lines))
def fold_weight(model: nn.Module, keep_attrs: bool = False):
"""Fold weight quantizer for fast evaluation."""
for name, module in model.named_modules():
if isinstance(module, QuantModule):
module.fold_weight(keep_attrs)
@torch.no_grad()
def compute_quantization_mse(
model: nn.Module,
forward_loop: ForwardLoop,
wildcards: str | Callable | list[str | Callable] = "*",
) -> dict[str, float]:
"""Compute the mean-squared quantization error for selected quantizers.
Runs ``forward_loop`` through the model while recording, for every matching
:class:`TensorQuantizer`, the MSE between the original float tensor and
its fake-quantized (Q→DQ) counterpart. Values are averaged over all
calibration batches.
Args:
model: A quantized model (output of :func:`quantize`).
forward_loop: Callable that takes ``model`` and runs data through it.
wildcards: One or more fnmatch glob patterns (or callable filters)
matched against :class:`TensorQuantizer` module names in
``model.named_modules()``. Follows the same convention as
``quant_cfg`` wildcard keys. Defaults to ``"*"`` (all quantizers).
Returns:
A dict mapping each matched quantizer's fully-qualified name to its
mean MSE (float). Quantizers that are disabled or not in fake-quant
mode are skipped and absent from the output.
Example::
mse = mtq.compute_quantization_mse(
model,
forward_loop,
wildcards=["*k_bmm_quantizer", "*v_bmm_quantizer"],
)
for name, err in sorted(mse.items()):
print(f"{name}: {err:.4e}")
"""
if not isinstance(wildcards, list):
wildcards = [wildcards]
def _matches(name: str) -> bool:
return any(fnmatch.fnmatch(name, w) if isinstance(w, str) else w(name) for w in wildcards)
accumulators: dict[str, dict] = {} # name -> {"sum": float, "count": int}
hooks = []
for name, module in model.named_modules():
if not isinstance(module, TensorQuantizer):
continue
if not _matches(name):
continue
if not (module._if_quant and module._fake_quant) or module._disabled:
continue
accumulators[name] = {"sum": 0.0, "count": 0}
def _make_hook(acc):
def hook(mod, inp, out):
original = inp[0].detach().float()
quantized = out.detach().float()
acc["sum"] += torch.mean((original - quantized) ** 2).item()
acc["count"] += 1
return hook
hooks.append(module.register_forward_hook(_make_hook(accumulators[name])))
try:
forward_loop(model)
finally:
for h in hooks:
h.remove()
return {
name: acc["sum"] / acc["count"] for name, acc in accumulators.items() if acc["count"] > 0
}