Extend PyTorch RTN weight quantization to MoE experts#2584
Extend PyTorch RTN weight quantization to MoE experts#2584titaiwangms with Copilot wants to merge 21 commits into
Conversation
…ent) This commit checkpoints the in-progress MoE quantization work before a larger refactor that deletes QuantLinear/QuantEmbedding in favour of storing every quantized weight (2D linear, 2D embedding, 3D MoE experts) as a QuantTensor nn.Parameter on the original host module. Included so far: - New olive/common/quant/patterns.py for re: prefix matching in modules_to_not_convert / overrides. - New olive/common/quant/tensor.py with QuantTensor wrapper subclass (_make_wrapper_subclass + __torch_function__ + __torch_dispatch__), supporting 2D and 3D layouts. - LayerWrapper.get_experts() / get_router() accessors. - 3D quantize helpers in olive/common/quant/utils.py. - moe field on OliveHfQuantizationConfig. - _process_model_before_weight_loading skips ModuleList(Expert) subtrees when moe=False, fixing a latent silent-quantization bug for Mixtral / PhiMoE / Qwen2/3-MoE. - Fused-3D MoE support in prepare_model / finalize via QuantTensor parameters; current save layout uses _qweight buffer suffixes — to be replaced in the upcoming refactor with the canonical <param>.qweight/.scales/.qzeros layout. - ModelBuilder raises NotImplementedError for Olive-quantized MoE checkpoints (Mobius is the intended consumer). - Test additions: test/common/quant/test_patterns.py, test/common/quant/test_tensor.py, TestOliveHfQuantizerMoE / TestRegexOverrides in test_hf_utils.py, test/passes/pytorch/test_quant_utils.py for flatten helper, test_olive_quantized_model_raises_for_moe in test_model_builder.py. - 294 tests pass; lintrunner clean (--skip PYLINT). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Switch Olive's native quantization representation to a single design: every quantized weight is an nn.Parameter(QuantTensor) on the original host nn.Linear / nn.Embedding / fused-3D experts module, with sibling <pname>_qweight / _scales / _qzeros buffers aliasing the QuantTensor's inner tensors. Save: a state-dict hook drops the QuantTensor parameter entry; the buffers already carry the data (plain Tensors, safetensors-friendly). Load: HF's loader fills the buffers natively via dotted paths; a post-load helper re-binds the QuantTensor inner refs to the freshly loaded buffer storage. QuantLinear / QuantEmbedding (olive/common/quant/nn.py) are kept only as ONNX-exportable wrappers used by make_export_compatible_quant; they are no longer the runtime representation. * New olive/common/quant/state_dict.py with install_quant_tensor_param and refresh_quant_tensor_refs helpers. * OliveHfQuantizer rewritten for the new layout (placeholder install before weight load + ref refresh after). * finalize() in passes/pytorch/quant_utils.py installs QuantTensor params via install_quant_tensor_param (replaces the old flatten_quant_tensor_params helper). * prepare_model skips modules whose weight is already a QuantTensor, so composing multiple Rtn passes on top of a partially quantized model works. * make_export_compatible_quant detects nn.Linear / nn.Embedding whose weight is a QuantTensor and swaps them with QuantLinear / QuantEmbedding wrappers before any model dtype casting, preserving the existing com.microsoft::MatMulNBits / com.microsoft::GatherBlockQuantized symbolic export path. * OliveQuantizedModel (model_builder.py) normalizes the new <dotted>.weight_qweight key layout back to the legacy <dotted>.qweight layout for the existing genai loader, and raises NotImplementedError for moe=True checkpoints. * Tests updated to assert against QuantTensor weight instead of isinstance(module, QuantLinear); legacy tie_quant_modules tests removed; new install_quant_tensor_param test suite added. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…er to N-D * Remove olive/common/quant/nn.py (QuantModule, QuantLinear, QuantEmbedding) entirely. The only purpose of those modules was ONNX export, which is now handled by reusing the existing QuantLinearNbit from olive/common/hf/quant.py and a new parallel QuantEmbeddingNbit (com.microsoft::GatherBlockQuantized symbolic) in the same file. * Add QuantLinearNbit.from_quant_tensor / QuantEmbeddingNbit.from_quant_tensor factories so make_export_compatible_quant can swap any nn.Linear / nn.Embedding whose weight is a QuantTensor into the export wrappers. * Generalize WeightQuantizer (get_num_groups, get_qparam_shape, find_qparams, quantize, dequantize, _reshape_tensor) and pack_to_uint8 / unpack_from_uint8 to operate on any N-D tensor; quantization is always along the last dim, leading dims are preserved. * Drop quantize_along_leading_dim / pack_to_uint8_along_last / unpack_from_uint8_along_last and the explicit 3D leading-dim loops in QuantTensor.from_float and _dequantize. * Delete test/common/quant/test_nn.py; add N-D tests for the generalized quantizer + pack helpers. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Instead of pre-walking the safetensors dict to rewrite ``<dotted>.weight_qweight`` -> ``<dotted>.qweight``, derive the destination attribute name inside ``set_tensor`` once we already know ``submodule`` is a ``QuantizedTensorModule``. Strip any of the known Olive buffer suffixes (``QWEIGHT_SUFFIX``, ``SCALES_SUFFIX``, ``QZEROS_SUFFIX`` from ``olive.common.quant.state_dict``) from the last path component to produce the bare ``qweight`` / ``scales`` / ``qzeros`` attribute that the genai ``QuantizedTensorModule`` expects. Also drops internal dev-iteration version labels from comments and docstrings in olive/common/quant and olive/passes/onnx. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Both QuantTensor's 2D layout and QuantLinearNbit's MatMulNBits
buffer layout pack the quantization axis as uint8 with the same
in-byte order (low nibble = elem[2j], high nibble = elem[2j+1] for
4-bit, etc.). They differ only in qweight rank: QuantTensor uses
(out, in / pack_factor), QuantLinearNbit uses
(out, n_blocks, blob_size) where n_blocks * blob_size ==
in / pack_factor. So the conversion is a pure reshape; the previous
unpack -> .t() -> from_tensors round-trip is unnecessary.
scales and qzeros buffer shapes also match exactly between the two
layouts, so they are copied as-is. For symmetric weights
(QuantTensor.qzeros is None) we fill the QuantLinearNbit.qzeros
buffer with the packed midq pattern that the contrib op expects.
Verified numerically: F.linear via QuantTensor and the
dequantize-from-buffers path through QuantLinearNbit produce
bit-identical outputs across {4,8} bits, {symmetric, asymmetric},
{groupwise, per-channel}.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The ORT contrib MatMulNBits / GatherBlockQuantized ops treat a missing zero-points input as midq for unsigned quantization, matching Olive's symmetric-quantization convention. Drop the synthetic packed-midq buffer that was previously emitted for symmetric weights and instead omit the input entirely: * QuantLinearNbit gains a has_qzeros flag (default True for back-compat); pack/from_tensors/from_quant_tensor pass through None as needed. * QuantLinearTorchFunction (TorchScript + dynamo) skips the qzeros input when None, inserting an empty placeholder only when g_idx must be positionally aligned. * QuantEmbeddingTorchFunction.symbolic gains the missing dynamo arg exposed by the new symmetric-embedding export path. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
g_idx alongside a missing qzeros is not a real combination in Olive (GPTQ always produces qzeros), so skip the empty-tensor placeholder and just omit qzeros from the input list entirely. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Replace duplicated model walks in hf_utils._process_model_before_weight_loading and quant_utils.prepare_model with a shared iter_quant_targets helper that returns a list of (module, dotted_name, param_name, shape, dtype, device, kind) entries. Selection rules (lm_head/embeds/moe category flags, skip patterns, extra_skip_modules, already-quantized) live in one place. - QuantLinearNbit/QuantEmbeddingNbit: raise instead of synthesising a placeholder when g_idx is supplied alongside symmetric quantization. - tie_quant_word_embeddings: require both input and output embeddings to already be QuantTensor-backed with matching shape/dtype before tying. - Fix CodeQL mismatched-assignment false positives in QuantTensor dispatch (index args directly), fix ruff D205/D401/PLW0108/A002 warnings. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Neither attribute is read anywhere — the post-walk loop that produced the literal skip-name list was a leftover from before the refactor. The configured patterns already live on quantization_config. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Stop tagging modules with quant_info / quant_info_3d and stop branching on 2D vs 3D in the quantization passes. The quantizer already operates along the last dim regardless of rank, so a single iteration over parameters that carry a quant_info attribute is enough. - QuantTarget slims to (module, module_name, pname, full_name) with a .param property; the caller reads shape/dtype/device from the parameter directly. No more 'kind' field. - prepare_model writes target.param.quant_info in one pass — both 2D linear/embedding weights and fused experts parameters use the same code path. The quant_info_3d dict-stash on experts modules is gone. - finalize iterates every parameter that has quant_info, calls QuantTensor.from_float (already rank-generic), and installs in place. - GPTQ and AutoClip read module.weight.quant_info; module discovery uses hasattr(module.weight, 'quant_info') instead of a module-level attribute. - HF placeholder install pulls shape/dtype/device off target.param and the placeholder builder is now rank-generic. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The dataclass had four fields and a one-line .param property, used by two callers. A plain tuple is shorter, matches how the layerwise quantization loop already iterates over (module, pname, param, info) tuples, and removes the unused module_name field and dead for_each_target helper. QuantTarget remains as a type alias for the public signature. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Filter fused-MoE params to 2D/3D ranks in iter_quant_targets so a 1D bias-like parameter fails at selection time instead of much later in finalize. * refresh_quant_tensor_refs: also check isinstance(param.data, QuantTensor) for forward-compat with future torch versions that may not return the underlying subclass from nn.Parameter(). * OliveHfQuantizationConfig: replace bare '# pylint: disable' with the specific super-init-not-called rule; use output.get(k) in to_dict. * finalize: log a warning when moe=True that the resulting checkpoint isn't directly ONNX-exportable via the Olive conversion pass — it must be consumed by an MoE-aware model builder. * Add regression test that _module_weight_has_quant_info ignores nn.LayerNorm / nn.Conv2d / unmarked nn.Linear (defends GPTQ/AutoClip discovery against future drift). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- __torch_dispatch__ clone/contiguous now forwards extra args/kwargs. - iter_quant_targets skips ALL nn.Embedding when embeds=False (positional / token-type embeddings like GPT-2 wpe are no longer silently quantized). - WeightQuantizer assertion message: 2/4/8-bit (was 4/8-bit). - tie_quant_word_embeddings: mark dst aliased buffers non-persistent so safetensors save emits one copy of qweight/scales/qzeros. - finalize: group selected params by host module so each module's to(device)/to(cpu) cycle runs once for MoE experts modules carrying multiple 3D weight params. - state_dict: add ensure_state_dict_hooks(model) defensive walk that installs the save hook on every host module that owns a QuantTensor parameter (idempotent). - Add test_forward_parity.py: bit-exact eager parity for full models (embedding + linears) and fused 3D MoE forwards, plus end-to-end ONNX export -> onnxruntime numerical parity for Olive-quantized nn.Linear via make_export_compatible_quant. - Enable pylint by adding file-level protected-access disables on the files that intentionally touch nn.Module._parameters. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
…main Resolve conflicts in quant_utils.py by combining the param-level iter_quant_targets walk with main's QKV-aware override renormalization and QuantTensor-based already-quantized detection. Adapt kquant.py and its tests to the storage-only (param-level quant_info) API.
…x validator + tests
There was a problem hiding this comment.
Pull request overview
This PR extends Olive’s native PyTorch RTN-style weight quantization to support Mixture-of-Experts (MoE) expert weights by moving from module-swapping (QuantLinear/QuantEmbedding) to a parameter-level, storage-only representation (QuantTensor) that can also handle fused 3D expert parameters. It also centralizes quantization target selection and pattern matching, updates ONNX export/model-builder integration boundaries, and adds extensive regression and parity tests.
Changes:
- Introduces
QuantTensor+ state-dict helpers to quantize weights (including fused 3D MoE expert tensors) without swapping parent modules, and removesolive.common.quant.nn. - Adds centralized quantization target selection (
iter_quant_targets) and pattern matching helpers (re:regex support with safety validation; insertion-order override precedence). - Updates PyTorch passes (RTN/GPTQ/KQuant/AutoClip), ONNX ModelBuilder behavior, documentation, and adds broad test coverage (selection, tensor behavior, regex safety, parity, and model-builder rejection for MoE).
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test/passes/pytorch/test_rtn.py | Updates RTN tests to assert quantization via QuantTensor-backed weights instead of QuantLinear/QuantEmbedding. |
| test/passes/pytorch/test_quant_utils.py | Adjusts quant-utils tests for parameter-level quant_info and adds new state-dict helper coverage. |
| test/passes/pytorch/test_kquant.py | Updates KQuant tests to use QuantTensor checks and bit assertions. |
| test/passes/pytorch/test_gptq.py | Updates GPTQ tests to validate QuantTensor-backed weights and composition behavior. |
| test/passes/onnx/test_model_builder.py | Adds coverage ensuring ModelBuilder rejects Olive-quantized MoE checkpoints. |
| test/common/quant/test_utils.py | Extends quant utils tests to validate N-D quantization and pack/unpack helpers. |
| test/common/quant/test_tensor.py | New tests for QuantTensor 2D/3D behavior, indexing, movement guards, and ONNX-export guards. |
| test/common/quant/test_selection.py | New tests for iter_quant_targets selection rules including MoE gating, fail-closed behavior, and already-quantized skipping. |
| test/common/quant/test_patterns.py | New tests for override/skip matching semantics and regex safety validation. |
| test/common/quant/test_nn.py | Removes tests for deprecated QuantLinear/QuantEmbedding module wrappers. |
| test/common/quant/test_hf_utils.py | Updates HF quantizer tests for QuantTensor-based layout, adds MoE and regex-override coverage. |
| test/common/quant/test_forward_parity.py | New numerical parity tests (eager vs dense reference) plus ONNX export parity for the export-compatible wrappers. |
| olive/passes/pytorch/rtn.py | Enables MoE support in RTN pass config via allow_moe=True. |
| olive/passes/pytorch/quant_utils.py | Refactors quantization to parameter-level selection, adds MoE config/options, and installs QuantTensor params during finalize. |
| olive/passes/pytorch/kquant.py | Adjusts KQuant to use weight-level quant_info and shared _module_weight_has_quant_info. |
| olive/passes/pytorch/gptq.py | Migrates GPTQ calibration/processing to store metadata on module.weight.quant_info. |
| olive/passes/pytorch/autoclip.py | Migrates AutoClip input caching and processing to use module.weight.quant_info. |
| olive/passes/onnx/model_builder.py | Rejects Olive-quantized MoE checkpoints; adds suffix mapping so Olive’s *_qweight/*_scales/*_qzeros buffers load into expected ModelBuilder attributes. |
| olive/common/quant/utils.py | Generalizes quantization and packing utilities to N-D tensors (quantize/pack along last dim). |
| olive/common/quant/tensor.py | New QuantTensor tensor-subclass implementing storage-only quantization with dispatch, 3D MoE indexing behavior, and ONNX/movement guards. |
| olive/common/quant/state_dict.py | New state-dict utilities for installing QuantTensor parameters + buffer aliases and refreshing references after load. |
| olive/common/quant/selection.py | New shared quantization target selection logic with MoE-aware rules and fail-closed behavior. |
| olive/common/quant/patterns.py | New pattern matching helpers for overrides/skip patterns with re: support and regex safety validation. |
| olive/common/quant/nn.py | Removes deprecated QuantLinear/QuantEmbedding module implementations. |
| olive/common/quant/hf_utils.py | Updates HF quantization config and quantizer implementation to use QuantTensor placeholders + state-dict refresh; adds regex overrides. |
| olive/common/hf/wrapper.py | Adds MoE experts/router conventions and accessors on LayerWrapper. |
| olive/common/hf/quant.py | Adds export-compatible wrappers creation from QuantTensor and improves symmetric handling (optional qzeros) for contrib ops. |
| docs/source/features/quantization.md | Documents PyTorch Native RTN, MoE flag behavior, regex semantics/safety, precedence rules, and migration away from QuantLinear/QuantEmbedding. |
| overrides: Per-module overrides for quantization parameters. | ||
| Keys use **literal equality** matching by default; entries | ||
| prefixed with ``re:`` use ``re.fullmatch``. Among matching | ||
| keys, the longest pattern wins (ties broken lexically). |
| cleaned_override = {k: v for k, v in override.__dict__.items() if v is not None and v != output.get(k)} | ||
| if cleaned_override: | ||
| overrides[module_name] = cleaned_override | ||
| output["overrides"] = sort_layers_by_name(overrides) or None |
| if isinstance(module, (nn.Linear, nn.Embedding)): | ||
| if isinstance(module, nn.Embedding) and not quantize_embeds: | ||
| continue | ||
| if _is_skipped(module, name): | ||
| continue |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 28 out of 28 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (3)
olive/common/quant/hf_utils.py:80
- The
overridesdocstring says "longest pattern wins", butget_qlinear_init_argsusesmatch_override(...)which is insertion-order / first-match-wins. This is misleading and contradicts the behavior documented elsewhere in this PR (and tested intest_patterns.py).
overrides: Per-module overrides for quantization parameters.
Keys use **literal equality** matching by default; entries
prefixed with ``re:`` use ``re.fullmatch``. Among matching
keys, the longest pattern wins (ties broken lexically).
olive/common/quant/selection.py:103
- The docstring states
quantize_embeds=Falseonly skips the input embedding module, but the implementation currently skips allnn.Embeddingmodules whenquantize_embedsis false. The docstring should match the actual selection semantics (and the pass config description: "input embeddings").
* ``quantize_lm_head=False`` skips the output embedding module.
* ``quantize_embeds=False`` skips the input embedding module.
* ``quantize_moe=False`` skips every ``nn.Module`` under any
olive/common/quant/selection.py:176
- When
quantize_embeds=True, the current logic will quantize everynn.Embeddingin the model (positional/token-type/etc.), not just the input embeddings. This contradicts the config/CLI description ("quantize the input embeddings") and can unintentionally change model behavior. Consider restricting embedding quantization tomodel.get_input_embeddings()when available.
if isinstance(module, (nn.Linear, nn.Embedding)):
if isinstance(module, nn.Embedding) and not quantize_embeds:
continue
if _is_skipped(module, name):
continue
Review team synthesis (5 parallel reviewers: readability / code / critical / deep / integration)This PR was reviewed against the acceptance criteria in #2583. Several claims were independently verified/reproduced against the actual diff before being reported here. Overall: not yet mergeable — two Critical findings have concrete repros, plus several Major gaps in the OOM guard, legacy-checkpoint compatibility, and required tracked-issue/test coverage. 🔴 Critical1. Override precedence flips across Reproduced independently: This means quantizing and saving a checkpoint, then reloading it, can silently resolve overlapping overrides differently — producing a shape/metadata mismatch or silently wrong dequantization on reload. Existing AC #4 regression tests only exercise the in-memory path, never a 2. Real ReDoS bypass in the "safe" regex validator A user-supplied 🟠 Major3. Eager-mode OOM guard does not hold for unregistered ops 4. Legitimate MoE routing index patterns are rejected 5. Old 6. Fail-closed MoE detection has a partial-discovery gap 7. 8. Required Mobius tracked issue not filed 9. Non-MoE key-migration path in 🟡 Minor
✅ What's solid
Recommendation: address the two Critical items (override-serialization precedence, ReDoS bypass) and the eager-mode OOM guard / legacy-checkpoint-load gaps before merge; file the Mobius issue and add the two missing regression tests (model_builder non-MoE migration, true two-pass Gptq→Rtn composition) to close out the remaining acceptance criteria. |
Describe your changes
Olive's native PyTorch quantization only handled
nn.Linear/nn.Embedding, so MoE expert weights (the bulk of a MoE model's parameters) either stayed at full precision (fused-3D params were silently skipped) or were quantized whenever the pass ran with no opt-in. This resumes and completes thejambayk/moe-quantbranch: storage-only MoE quantization via aQuantTensortensor-subclass and a param-level quantization walk, merged onto currentmain.Merge & invariants
jambayk/moe-quantontomain, reconciling the param-level walk with main's QKV-aware override renormalization and replacing the oldisinstance(module, QuantLinear/QuantEmbedding)already-quantized check with aQuantTensor-based_collect_already_quantized_names.Selection (
common/quant/selection.py)moecategory flag (parallel tolm_head/embeds); whenmoe=False, every module under an experts subtree is skipped.dim() == 3, fixing gpt-oss 2D*_biasparams being silently quantized.QuantTensor(common/quant/tensor.py)matmul/bmm).transpose/reshape/view/permute/…) raise a clear error instead of producing a malformed subclass.Override matching (
common/quant/patterns.py)re:regex keys validated against catastrophic backtracking (length cap + nested-unbounded-quantifier rejection).model_builder.pyOliveQuantizedModelrejectsmoe=Truecheckpoints with a clear error; non-MoE checkpoints migrate<pname>_qweight/_scales/_qzeroskeys so existing Linear/Embedding checkpoints keep loading.Compatibility
olive.common.quant.nn.QuantLinear/QuantEmbeddingremoved as a documented breaking change (state dicts still load; onlytorch.save(model)pickles are affected — re-run RTN).Docs & tests
quantization.md(moe flag,re:syntax, precedence, migration note).Gptq→Rtn(moe=True, embeds=True)composition, and a real (config-only) Mixtral round-trip.[ { "type": "Gptq" }, { "type": "Rtn", "moe": true, "embeds": true } ]Checklist before requesting a review
lintrunner -aRelease note: The PyTorch
Rtnpass gains amoeflag to quantize MoE expert weights (fused-3D andModuleListexperts), plusre:-prefixed regex support inoverrides/modules_to_not_convert.QuantLinear/QuantEmbeddingmodules are removed (breaking change — see migration note).(Optional) Issue link
Follow-up (out of scope): a tracked issue must be filed against the Mobius repo for
preprocess_olive_weightssilently mis-reshaping 3D expert weights as 2D.