Skip to content

Conversation

@yewentao256
Copy link
Member

@yewentao256 yewentao256 commented Jun 30, 2025

Purpose

Fixes #20205

I think with these new import checks and the above torch version check, it would be nice to pull these into a separate import_utils.py file like Transformers to make it clear for new libraries to add there https://github.com/huggingface/transformers/blob/main/src/transformers/utils/import_utils.py#L386

Originally posted by @mgoin in #20187 (comment)

Thanks @mgoin Sounds a good idea, this is a pr including all of current import utils we have.

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 @yewentao256, 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 refactors the import utilities within the vLLM project. It moves functions related to importing and module handling from the general vllm.utils module to a dedicated vllm.import_utils module. This change aims to improve code organization, reduce potential circular dependencies, and make the codebase more maintainable.

Highlights

  • Refactor: Moves import-related utilities from vllm.utils to a new vllm.import_utils module.
  • Code Organization: Updates import statements across the codebase to reflect the new location of the utilities.
  • Dependency Management: Centralizes import utilities to improve code maintainability and reduce circular dependencies.
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.

@github-actions
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.

🚀

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 refactors import utilities into a new vllm/import_utils.py module, improving codebase modularity. The code movement is clean, and all import paths have been updated correctly. There is one suggestion regarding exception handling in the new module to enhance maintainability.

Copy link
Member

@mgoin mgoin left a comment

Choose a reason for hiding this comment

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

Hmm I think the UX of having a separate from vllm.import_utils is not so good. When I originally made the suggestion it was based off of Transformers' structure, which has utils/ as a directory rather than a single file like we have in vLLM. I would like to keep the usage of from vllm.utils, so if we want to implement this refactor then I think we have to make a utils/ folder to keep the imports the same

@yewentao256
Copy link
Member Author

Hmm I think the UX of having a separate from vllm.import_utils is not so good. When I originally made the suggestion it was based off of Transformers' structure, which has utils/ as a directory rather than a single file like we have in vLLM. I would like to keep the usage of from vllm.utils, so if we want to implement this refactor then I think we have to make a utils/ folder to keep the imports the same

So the folder would be:

vllm/utils/init.py  (which keep the usage of `from vllm.utils`, having a __all__ perhaps)
vllm/utils/utils.py
vllm/utils/import_utils.py

Would this structure be better?

@mgoin
Copy link
Member

mgoin commented Jun 30, 2025

Yes, I think this is what is needed to achieve the UX. Maybe all of the existing utils.py could just be put in __init__.py for ease of initial impl

Signed-off-by: yewentao256 <[email protected]>
@yewentao256 yewentao256 force-pushed the wye-refactor-import-utils branch from a694182 to c811835 Compare June 30, 2025 20:16
@mergify
Copy link

mergify bot commented Jun 30, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @yewentao256.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Jun 30, 2025
@mergify mergify bot removed the needs-rebase label Jun 30, 2025
@yewentao256
Copy link
Member Author

Yes, I think this is what is needed to achieve the UX. Maybe all of the existing utils.py could just be put in __init__.py for ease of initial impl

Done with the __init__.py version, I can have follow up prs for additional changes later. For this pr, let's make the changes less for easier review.

Copy link
Member

@mgoin mgoin left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@mgoin mgoin added ready ONLY add when PR is ready to merge/full CI is needed and removed performance Performance-related issues structured-output frontend speculative-decoding v1 multi-modality Related to multi-modality (#4194) tool-calling labels Jul 1, 2025
@mgoin mgoin removed this from Structured Output Jul 1, 2025
@vllm-bot vllm-bot merged commit e81fbef into vllm-project:main Jul 2, 2025
64 of 70 checks passed
Pradyun92 pushed a commit to Pradyun92/vllm that referenced this pull request Aug 6, 2025
jinzhen-lin pushed a commit to jinzhen-lin/vllm that referenced this pull request Aug 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready ONLY add when PR is ready to merge/full CI is needed

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Refactor for Import Util Functions

4 participants