File size: 11,329 Bytes
b386992 |
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 |
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
#
# 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.
import os
import tarfile
from contextlib import nullcontext
from typing import Callable, Optional
import torch
import torch.distributed as dist
from megatron.core import parallel_state
from megatron.core.transformer.module import Float16Module
from omegaconf.omegaconf import DictConfig, open_dict
from nemo.collections.nlp.models.language_modeling.megatron_gpt_model import MegatronGPTModel
from nemo.collections.nlp.parts.utils_funcs import torch_dtype_from_precision
from nemo.utils import logging
from nemo.utils.distributed import temporary_directory
from nemo.utils.model_utils import save_artifacts, unwrap_model
try:
import modelopt.torch.quantization as mtq
from modelopt.torch.export import export_tensorrt_llm_checkpoint
QUANT_CFG_CHOICES = {
"int8": mtq.INT8_DEFAULT_CFG,
"int8_sq": mtq.INT8_SMOOTHQUANT_CFG,
"fp8": mtq.FP8_DEFAULT_CFG,
"int4_awq": mtq.INT4_AWQ_CFG,
"w4a8_awq": mtq.W4A8_AWQ_BETA_CFG,
"int4": mtq.INT4_BLOCKWISE_WEIGHT_ONLY_CFG,
"nvfp4": mtq.NVFP4_DEFAULT_CFG,
}
HAVE_MODELOPT = True
except (ImportError, ModuleNotFoundError) as e:
HAVE_MODELOPT = False
HAVE_MODELOPT_ERROR = e
SUPPORTED_DTYPE = [16, "16", "bf16"] # Default precision for non-quantized layers
class Quantizer:
"""Post-training quantization (PTQ) and TRT-LLM export of Nemo checkpoints.
PTQ converts selected model layers to low-precision format (e.g., INT4, FP8) for efficient serving.
The process consist of several steps:
1. Loading a Nemo model from disk using appropriate parallelism strategy
2. Calibrating the model to obtain appropriate algorithm-specific scaling factors
3. Producing output directory or .qnemo tarball with model config (json),
quantized weights (safetensors) and tokenizer config (yaml).
The output directory (or .qnemo file) produced is intended to be consumed by TensorRT-LLM toolbox
for efficient inference. This can be achieved using Nemo inference containers.
Currently supported and tested model family is Llama2. Model type needs to be specified in
the quantization command with decoder_type parameter on exporting (see below). Quantizing other
model families is experimental and might not be fully supported.
Available quantization methods are listed in `QUANT_CFG_CHOICES` dictionary above.
Please consult Model Optimizer documentation https://nvidia.github.io/TensorRT-Model-Optimizer/ for details.
You can also inspect different choices in examples/nlp/language_modeling/conf/megatron_gpt_ptq.yaml
for quantization algorithms and calibration data as well as recommended settings.
Quantization algorithm can also be conveniently set to 'null' to perform only weights export step
for TensorRT-LLM deployment. This is useful to getting baseline results for a full-precision model.
"""
def __init__(self, quantization_config: Optional[DictConfig], export_config: Optional[DictConfig]):
"""Initialize Quantizer with quantization and export configurations.
Expected keys in `quantization_config`:
- algorithm: str
- decoder_type: str
- awq_block_size: int (only for awq algorithms)
- sq_alpha: float (only for smooth quant algorithms)
- enable_kv_cache: bool (default: None i.e. auto-detect based on algorithm and decoder_type)
Expected keys in `export_config`:
- dtype: str/int
- decoder_type: str
- inference_tensor_parallel: int
- inference_pipeline_parallel: int
- save_path: str
"""
if not HAVE_MODELOPT:
raise RuntimeError("nvidia-modelopt is needed to use Quantizer") from HAVE_MODELOPT_ERROR
self.quantization_config = quantization_config
self.export_config = export_config
# Quantization sanity checks
assert (
quantization_config.algorithm is None or quantization_config.algorithm in QUANT_CFG_CHOICES
), f"Unsupported quantization algorithm: {quantization_config.algorithm}"
if quantization_config.algorithm is not None:
quant_cfg = QUANT_CFG_CHOICES[quantization_config.algorithm]
if "awq" in quantization_config.algorithm:
weight_quantizer = quant_cfg["quant_cfg"]["*weight_quantizer"]
if isinstance(weight_quantizer, list):
weight_quantizer = weight_quantizer[0]
weight_quantizer["block_sizes"][-1] = quantization_config.awq_block_size
# Always turn on FP8 kv cache to save memory footprint.
# For int8_sq, we use int8 kv cache.
# TODO: Investigate why enabling FP8 kv cache will cause accuracy regressions for Nemotron.
enable_quant_kv_cache = quantization_config.get("enable_kv_cache", None)
if enable_quant_kv_cache is None:
enable_quant_kv_cache = (
"int8" not in quantization_config.algorithm and quantization_config.decoder_type != "gpt"
)
logging.info(f'{"Enabled" if enable_quant_kv_cache else "Disabled"} KV cache quantization')
quant_cfg["quant_cfg"]["*output_quantizer"] = {
"num_bits": 8 if quantization_config.algorithm == "int8_sq" else (4, 3),
"axis": None,
"enable": enable_quant_kv_cache,
}
if quantization_config.algorithm == "int8_sq":
logging.info(f"Using int8_sq alpha = {quantization_config.sq_alpha}")
quant_cfg["algorithm"] = {"method": "smoothquant", "alpha": quantization_config.sq_alpha}
self.quant_cfg = quant_cfg
else:
self.quant_cfg = None
# Export sanity checks
if export_config is not None:
assert export_config.dtype in SUPPORTED_DTYPE, f"Unsupported export dtype: {export_config.dtype}"
@staticmethod
def _setup(model: MegatronGPTModel):
"""Setup model for quantization."""
try:
model.model.module.language_model.encoder.activations_checkpoint_method = None
except AttributeError:
pass
if not parallel_state.is_initialized():
def dummy():
return
if model.trainer.strategy.launcher is not None:
model.trainer.strategy.launcher.launch(dummy, trainer=model.trainer)
model.trainer.strategy.setup_environment()
@staticmethod
def modify_model_config(model_cfg: DictConfig) -> DictConfig:
"""Modify model config for quantization."""
with open_dict(model_cfg):
if model_cfg.get("sequence_parallel", False):
logging.warning("Disabling sequence parallelism for quantization...")
model_cfg.sequence_parallel = False
model_cfg.name = "modelopt"
model_cfg.apply_rope_fusion = False
return model_cfg
@staticmethod
def _sample_output(model: MegatronGPTModel):
"""Generate sample output for a model instance."""
logging.info("Generating sample output for the model...")
response = model.generate(
inputs=[
"Born in north-east France, Soyer trained as a",
"Born in California, Soyer trained as a",
],
length_params={
"max_length": 100,
"min_length": 100,
},
)
logging.info(f'Example NeMo output before export: {response["sentences"]}"')
def quantize(self, model: MegatronGPTModel, forward_loop: Callable[[MegatronGPTModel], None]):
"""Quantize the model and calibrate using given forward loop."""
assert self.quant_cfg is not None, "Quantization algorithm is not set"
logging.info(f"Quantizing model to {self.quantization_config.algorithm}...")
self._setup(model)
model = mtq.quantize(model, self.quant_cfg, forward_loop)
if self.quantization_config.decoder_type == "gpt":
# We found squared_relu may have an under-calibration problem.
# Clamp the scaling_factor with a min threshold to avoid under-calibration.
maxbound = 0
if self.quantization_config.algorithm == "fp8":
maxbound = 448
elif self.quantization_config.algorithm == "int8_sq":
maxbound = 127
model = mtq.postprocess_amax(
model, "*input_quantizer", lambda amax: torch.clamp(amax, min=0.01 * maxbound)
)
if dist.get_rank() == 0:
mtq.print_quant_summary(model)
return model
def export(self, model: MegatronGPTModel):
"""Export model to '.qnemo' format for TensorRT-LLM engine build."""
assert self.export_config is not None, "Export config is not set"
torch_dtype = torch_dtype_from_precision(self.export_config.dtype)
if self.export_config.get("sample_output", True):
self._sample_output(model)
if model.cfg.megatron_amp_O2:
model.model = unwrap_model(model.model, Float16Module)
# Setup model export handling: temporary directory for
# '.qnemo' tarball or directly write to export_config.save_path
compress = self.export_config.get("compress", False)
if compress:
export_handler = temporary_directory()
else:
export_handler = nullcontext(enter_result=self.export_config.save_path)
with export_handler as export_dir:
export_tensorrt_llm_checkpoint(
model=model,
decoder_type=self.export_config.decoder_type,
dtype=torch_dtype,
export_dir=export_dir,
inference_tensor_parallel=self.export_config.inference_tensor_parallel,
inference_pipeline_parallel=self.export_config.inference_pipeline_parallel,
use_nfs_workspace=model.trainer.num_nodes > 1,
)
dist.barrier() # Wait until all ranks complete export_model_config step
logging.info(
"Exporting quantized weights, model artifacts,"
f" and tokenizer config to {self.export_config.save_path}..."
)
if dist.get_rank() == 0:
save_artifacts(model, export_dir)
if compress:
os.makedirs(os.path.dirname(self.export_config.save_path), exist_ok=True)
with tarfile.open(self.export_config.save_path, "w") as tar:
tar.add(export_dir, arcname="./")
|