Skip to content

[nvbug 6289151] Fix exported Step layer type metadata#1693

Open
meenchen wants to merge 1 commit into
mainfrom
fix-step35-flash-trtllm-layer-types
Open

[nvbug 6289151] Fix exported Step layer type metadata#1693
meenchen wants to merge 1 commit into
mainfrom
fix-step35-flash-trtllm-layer-types

Conversation

@meenchen

@meenchen meenchen commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Type of change: Bug fix

Fixes HF checkpoint export for Step-3.5-Flash-style configs where layer_types includes main decoder layers plus num_nextn_predict_layers entries. Transformers 5.x validates that len(layer_types) == num_hidden_layers, so TRT-LLM fails during AutoConfig.from_pretrained() before loading the model.

This PR trims only the trailing next-token-prediction/MTP layer_types entries when the mismatch is exactly explained by num_nextn_predict_layers. It leaves unexplained mismatches unchanged.

Usage

N/A

Testing

  • /Users/weimingc/miniconda3/envs/modelopt/bin/python -m py_compile modelopt/torch/export/unified_export_hf.py tests/unit/torch/export/test_unified_export_hf.py
  • /Users/weimingc/miniconda3/envs/modelopt/bin/python -m pytest tests/unit/torch/export/test_unified_export_hf.py tests/unit/torch/export/test_nvfp4_utils.py
  • git diff --check

Full TRT-LLM serve was not run locally because the provided Step-3.5 checkpoint path is not visible from the configured cluster login node.

Before your PR is "Ready for review"

Make sure you read and follow Contributor guidelines and your commits are signed (git commit -s -S).

Make sure you read and follow the Security Best Practices (e.g. avoiding hardcoded trust_remote_code=True, torch.load(..., weights_only=False), pickle, etc.).

  • Is this change backward compatible?: ✅
  • If you copied code from any other sources or added a new PIP dependency, did you follow guidance in CONTRIBUTING.md: N/A
  • Did you write any new necessary tests?: ✅
  • Did you update Changelog?: N/A
  • Did you get Claude approval on this PR?: N/A

Additional Information

nvbug 6289151

Related MTP handling: #1532.

Summary by CodeRabbit

  • Bug Fixes

    • Hugging Face exports now sanitize model configs to trim mismatched layer-type entries and emit a warning, preventing deployment-time layer-configuration mismatches.
  • Tests

    • Added unit tests validating config sanitization, trimming rules, and the associated warnings.
  • Chores

    • Adjusted plugin import ordering to stabilize module initialization behavior.

@meenchen meenchen requested a review from a team as a code owner June 11, 2026 22:20
@meenchen meenchen requested a review from sugunav14 June 11, 2026 22:20
@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds a sanitizer that trims Hugging Face config.json layer_types when excess entries correspond to inferred next-token-prediction/MTP layers; integrates the sanitizer into export_hf_checkpoint, reorders plugin imports, and adds unit tests covering trimming and fallback detection.

Changes

Layer-types sanitization for HF export

Layer / File(s) Summary
Sanitization helper implementation
modelopt/torch/export/plugins/hf_checkpoint_utils.py
New sanitize_hf_config_for_deployment with helpers to parse numeric config fields and derive num_nextn_predict_layers; trims config_data["layer_types"] to num_hidden_layers when excess entries correspond to nextn/MTP layers and emits a warning.
Plugin import ordering
modelopt/torch/export/plugins/__init__.py
Moves the hf_checkpoint_utils star-import into the unguarded section and reorders plugin imports, altering evaluation order.
Export workflow integration
modelopt/torch/export/unified_export_hf.py
Imports and invokes sanitize_hf_config_for_deployment inside export_hf_checkpoint after loading config.json and before persisting the adjusted config_data.
Unit tests for sanitization behavior
tests/unit/torch/export/test_hf_checkpoint_utils.py
Adds pytest cases verifying trimming behavior, fallback to model.config.num_nextn_predict_layers, _mtp_layer_prefixes detection (including broad vs. specific prefixes), and preservation when extra layer types are unexplained; tests assert warnings and final layer_types.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

cherry-pick-0.45.0

Suggested reviewers

  • sugunav14
  • Edwardf0t1
  • h-guo18
🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly relates to the main change: fixing exported Step layer type metadata by sanitizing HF config to trim excess layer_types entries.
Docstring Coverage ✅ Passed Docstring coverage is 92.31% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Security Anti-Patterns ✅ Passed Scanned PR-mentioned Python files for torch.load(weights_only=False), numpy.load(allow_pickle=True), trust_remote_code=True, eval/exec, and #nosec; none found.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-step35-flash-trtllm-layer-types

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://NVIDIA.github.io/Model-Optimizer/pr-preview/pr-1693/

Built to branch gh-pages at 2026-06-13 00:21 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@codecov

codecov Bot commented Jun 11, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 90.69767% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.43%. Comparing base (dd49a46) to head (43a9abc).
⚠️ Report is 10 commits behind head on main.

Files with missing lines Patch % Lines
modelopt/torch/export/plugins/__init__.py 60.00% 2 Missing ⚠️
...delopt/torch/export/plugins/hf_checkpoint_utils.py 94.44% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1693      +/-   ##
==========================================
+ Coverage   67.72%   76.43%   +8.71%     
==========================================
  Files         511      511              
  Lines       56168    56950     +782     
==========================================
+ Hits        38037    43530    +5493     
+ Misses      18131    13420    -4711     
Flag Coverage Δ
examples 41.83% <44.18%> (+0.53%) ⬆️
gpu 57.69% <48.83%> (+25.73%) ⬆️
regression 14.67% <23.25%> (+0.02%) ⬆️
unit 54.41% <83.72%> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@meenchen meenchen force-pushed the fix-step35-flash-trtllm-layer-types branch 2 times, most recently from 0bccd7b to 97687b3 Compare June 12, 2026 17:44

@cjluo-nv cjluo-nv left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bot review — DM the bot to share feedback.

Small, focused bug fix (+121/-5, 4 files) for Step-3.5-Flash HF export where layer_types includes trailing MTP/next-token-prediction entries, breaking Transformers 5.x's len(layer_types) == num_hidden_layers validation in TRT-LLM.

Correctness:

  • sanitize_hf_config_for_deployment is conservative: it only trims trailing entries when the mismatch is exactly explained by num_nextn_predict_layers, and leaves unexplained mismatches untouched.
  • _as_nonnegative_int correctly excludes bool (which is an int subclass) before the integer check.
  • _get_num_nextn_predict_layers falls back config_data → model.config → _mtp_layer_prefixes length; when it returns None, None == <int> is False, so no trim happens. A num_nextn_predict_layers == 0 value can never trigger a trim because the equal-length case already returns early. All edges consistent.
  • Integration point in export_hf_checkpoint is correct: called after save_pretrained writes config.json and before the config is re-written to disk; trimming layer_types[:num_hidden_layers] keeps the head decoder entries, matching the documented MTP-entries-come-last assumption.
  • The plugins/__init__.py reorder (moving hf_checkpoint_utils star-import ahead of vllm_fakequant_hf) is benign; both are simple plugin star-imports with no cross-dependency. Private helpers (_as_nonnegative_int, _get_num_nextn_predict_layers) won't leak via import *.

Tests: Three unit tests cover the config-nextn-count trim, the model.config-nextn-count trim, and the keep-unexplained-mismatch case, including warning emission. Meaningful coverage of the core branches.

No licensing changes, no new subsystem/abstraction, no prompt-injection attempts in the PR metadata. Full TRT-LLM serve wasn't run (checkpoint not visible from cluster), which is an acceptable limitation noted by the author for a config-only sanitizer with unit coverage.

Complex PR: 1 existing test file modified or removed. Looping in a human for approval.

@meenchen meenchen requested a review from Edwardf0t1 June 12, 2026 19:52
@meenchen meenchen self-assigned this Jun 12, 2026
@meenchen meenchen added the cherry-pick-0.45.0 After code freeze, cherry-pick to release branch for next rc (bulk update). Only for bug fixes / doc label Jun 12, 2026
@meenchen meenchen force-pushed the fix-step35-flash-trtllm-layer-types branch from 97687b3 to 914cf1e Compare June 12, 2026 23:12
from .model_utils import get_language_model_from_vl, is_multimodal_model
from .moe_utils import _export_fused_experts
from .plugins import SpeculativeDecodingExporter, has_spec_opt
from .plugins import SpeculativeDecodingExporter, has_spec_opt, sanitize_hf_config_for_deployment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hard import of a symbol from an optionally-guarded plugin.

This now hard-imports sanitize_hf_config_for_deployment, which lives in hf_checkpoint_utils. In plugins/__init__.py that module is imported inside import_plugin(...) — a guard whose whole purpose is to tolerate the module failing to import. By contrast, SpeculativeDecodingExporter / has_spec_opt come from hf_spec_export, which is imported unguarded.

So if hf_checkpoint_utils ever fails under the guard, the symbol silently won't exist and this line raises ImportError, breaking all HF export — not just the Step path. In practice the deps (huggingface_hub, safetensors, tqdm) are always present for export, so the risk is low, but the import_plugin guard is partially defeated by taking a hard dependency on one of its symbols.

Note the import reorder in plugins/__init__.py doesn't close this gap — it only changes binding order; it doesn't make the symbol exist if the guarded import itself fails. Suggested fixes:

  • guard this import defensively (try/except ImportError → no-op fallback), or
  • if hf_checkpoint_utils is genuinely required for export, drop the import_plugin guard around it so failures are loud rather than silently amputating a symbol.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in d83dcb8. I removed the import_plugin guard around hf_checkpoint_utils in plugins/init.py, so sanitize_hf_config_for_deployment is no longer a hard import from an optionally amputated plugin symbol. This matches the existing direct hf_checkpoint_utils imports in export code: failures are now loud instead of silently dropping the symbol. Validated with ruff-format, ruff-check, py_compile, and the focused hf_checkpoint_utils unit tests.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 43a9abc. I changed the resolution from making hf_checkpoint_utils unguarded to preserving the import_plugin guard and adding a no-op fallback for sanitize_hf_config_for_deployment when the guarded import does not provide it. That keeps modelopt.torch.export import paths resilient to missing optional deps while keeping the direct unified_export_hf import stable. Validated with ruff-format, ruff-check, py_compile, and the focused hf_checkpoint_utils unit tests.

@meenchen meenchen force-pushed the fix-step35-flash-trtllm-layer-types branch from 914cf1e to d83dcb8 Compare June 12, 2026 23:24

@cjluo-nv cjluo-nv left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bot review — DM the bot to share feedback.

Re-review of Step-3.5-Flash HF export layer_types fix (now +159/-5, 4 files).

Previous critical comment (Edwardf0t1): RESOLVED. 💬 Author replied: removed the import_plugin guard around hf_checkpoint_utils in plugins/__init__.py, so sanitize_hf_config_for_deployment is now an unguarded import matching the existing hf_spec_export pattern; failures are loud rather than silently amputating the symbol. Verified in the current tree — the guard is gone and the import is now plain from .hf_checkpoint_utils import *. This matches the reviewer's suggested fix exactly, and the hard import in unified_export_hf.py:93 is now safe.

Correctness: The sanitizer is conservative — it only trims trailing layer_types when the surplus is exactly num_nextn_predict_layers, otherwise leaves the config untouched. _as_nonnegative_int correctly excludes bool. _get_num_nextn_predict_layers falls back config_data → model.config → _mtp_layer_prefixes count; the new _count_mtp_layer_prefixes correctly excludes broad prefixes ("mtp" → not counted, "mtp.layers.0" → counted). Integration point (after save_pretrained, before re-writing config.json) is correct.

Tests: Five unit tests now cover config-count trim, model.config-count trim, MTP-prefix counting, broad-prefix-only no-op, and the keep-unexplained-mismatch case — meaningful branch coverage.

No licensing changes; no prompt-injection in PR metadata.

Why nudge rather than approve: the resolution looks correct but warrants a quick human confirmation, and the author notes the full TRT-LLM serve path was not run (Step-3.5 checkpoint not visible from the cluster login node), so the end-to-end deployment fix is unverified — only unit coverage exists for the config-only sanitizer.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.

Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.

👉 Steps to fix this

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@modelopt/torch/export/plugins/__init__.py`:
- Line 23: Restore guarded import semantics: replace the unconditional "from
.hf_checkpoint_utils import *" with a guarded import that uses the package's
import_plugin mechanism (or a try/except ImportError around importing
hf_checkpoint_utils) so third‑party optional extras don't cause hard import
failures; specifically, use
import_plugin("modelopt.torch.export.plugins.hf_checkpoint_utils") or wrap the
import of hf_checkpoint_utils in try/except, emit a warning when the extra is
missing, and ensure any names expected from hf_checkpoint_utils are either
imported when available or left undefined/placeholder so package import paths
remain resilient.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 74637461-2fc7-43aa-83c9-862d6ca48c18

📥 Commits

Reviewing files that changed from the base of the PR and between 914cf1e and d83dcb8.

📒 Files selected for processing (4)
  • modelopt/torch/export/plugins/__init__.py
  • modelopt/torch/export/plugins/hf_checkpoint_utils.py
  • modelopt/torch/export/unified_export_hf.py
  • tests/unit/torch/export/test_hf_checkpoint_utils.py
🚧 Files skipped from review as they are similar to previous changes (3)
  • modelopt/torch/export/plugins/hf_checkpoint_utils.py
  • tests/unit/torch/export/test_hf_checkpoint_utils.py
  • modelopt/torch/export/unified_export_hf.py

Comment thread modelopt/torch/export/plugins/__init__.py Outdated
@meenchen meenchen requested review from Edwardf0t1 and cjluo-nv June 12, 2026 23:30
Signed-off-by: weimingc <17592131+meenchen@users.noreply.github.com>
@meenchen meenchen force-pushed the fix-step35-flash-trtllm-layer-types branch from d83dcb8 to 43a9abc Compare June 13, 2026 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherry-pick-0.45.0 After code freeze, cherry-pick to release branch for next rc (bulk update). Only for bug fixes / doc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants