Skip to content

[Quantization] add BNB for MixtralForCausalLM #20893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 14, 2025

Conversation

jeejeelee
Copy link
Collaborator

@jeejeelee jeejeelee commented Jul 14, 2025

Essential Elements of an Effective PR Description Checklist

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

Purpose

FIX #20061 (comment)

Test Plan

Test Result

(Optional) Documentation Update

Signed-off-by: Jee Jee Li <[email protected]>
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@jeejeelee jeejeelee marked this pull request as draft July 14, 2025 01:55
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @jeejeelee, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily introduces BitsAndBytes (BNB) quantization support for Mixtral models. To achieve this, I've undertaken significant refactoring to decouple the weight loading mechanisms of GraniteMoe from Mixtral, allowing for independent support of quantization methods. Additionally, I've improved the modularity of Mixtral's weight loading and applied minor optimizations to other MoE models' weight loading processes.

Highlights

  • Quantization Support: Added explicit support for 'bitsandbytes' (BNB) quantization for Mixtral models by including it in the mixtral_supported list within vllm/model_executor/model_loader/utils.py.
  • Model Decoupling and Refactoring: Decoupled the weight loading logic for GraniteMoeModel from MixtralModel. The _load_weights method, which was previously shared, has been copied and adapted into GraniteMoeModel in vllm/model_executor/models/granitemoe.py. This allows GraniteMoe to support new quantization methods like BNB independently without relying on Mixtral's implementation.
  • Modularity Improvements: Refactored MixtralModel in vllm/model_executor/models/mixtral.py by extracting the expert mapping logic into a new get_expert_mapping method. This improves code organization and reusability within the load_weights method.
  • Weight Loading Optimization: Applied a minor optimization to the load_weights methods in olmoe.py, qwen2_moe.py, and qwen3_moe.py by caching the result of self.get_expert_mapping() to avoid redundant calls within the loading loop.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@mergify mergify bot added the qwen Related to Qwen models label Jul 14, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds BNB quantization support for Mixtral models by decoupling GraniteMoe from Mixtral, duplicating weight loading logic. While functional, this introduces a maintainability concern due to code duplication. Refactoring the shared logic into a common utility or mixin is suggested to address this.

Comment on lines +312 to +318
def _load_weights(self,
weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
"""
This function is copied from `MixtralModel.load_weights`, mainly to
decouple from mixtral, avoiding impact on support like BNB
quantization.
"""
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This function is copied from MixtralModel.load_weights to decouple from mixtral, but this introduces code duplication. Consider refactoring the weight loading logic into a shared utility function or a mixin to reduce duplication and improve maintainability.

@@ -339,7 +438,7 @@ def load_weights(self, weights: Iterable[tuple[str,
new_weights[gate_name] = p
else:
new_weights[n] = p
return mixtral.MixtralModel.load_weights(self, new_weights.items())
return self._load_weights(new_weights.items())
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Consider calling self._load_weights instead of mixtral.MixtralModel.load_weights to avoid direct dependency on the mixtral module.

@@ -242,7 +241,7 @@ def load_weights(self, weights: Iterable[tuple[str,
new_weights[gate_name] = p
else:
new_weights[n] = p
return mixtral.MixtralModel.load_weights(self, new_weights.items())
return GraniteMoeModel._load_weights(self, new_weights.items())
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Consider calling self._load_weights instead of GraniteMoeModel._load_weights to avoid direct dependency on the GraniteMoeModel module.

Comment on lines +235 to 236
"bitsandbytes",
]
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Consider adding bnb to mixtral_supported for consistency and clarity.

        "quark",
        "bnb",

@jeejeelee jeejeelee marked this pull request as ready for review July 14, 2025 03:27
@jeejeelee jeejeelee requested review from mgoin and Isotr0py July 14, 2025 03:28
Copy link
Member

@Isotr0py Isotr0py left a comment

Choose a reason for hiding this comment

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

LGTM!

@Isotr0py Isotr0py enabled auto-merge (squash) July 14, 2025 05:34
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jul 14, 2025
@Isotr0py Isotr0py merged commit a99b9f7 into vllm-project:main Jul 14, 2025
78 checks passed
@jeejeelee jeejeelee deleted the mixtral-support-bnb branch July 14, 2025 07:37
py-andy-c pushed a commit to py-andy-c/vllm that referenced this pull request Jul 14, 2025
py-andy-c pushed a commit to py-andy-c/vllm that referenced this pull request Jul 14, 2025
patrickvonplaten pushed a commit to patrickvonplaten/vllm that referenced this pull request Jul 15, 2025
LyrisZhong pushed a commit to LyrisZhong/vllm that referenced this pull request Jul 23, 2025
avigny pushed a commit to avigny/vllm that referenced this pull request Jul 31, 2025
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
Pradyun92 pushed a commit to Pradyun92/vllm that referenced this pull request Aug 6, 2025
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
qwen Related to Qwen models ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants