Skip to content
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

[Core][VLM] Test registration for OOT multimodal models #8717

Merged
merged 42 commits into from
Oct 4, 2024

Conversation

ywang96
Copy link
Member

@ywang96 ywang96 commented Sep 22, 2024

This PR formally the support for OOT multimodal model registration. This was enabled alongside automatic detection of multimodal models in #7168, but has yet to be properly tested and documented.

FIX #8667


PR Checklist (Click to Expand)

Thank you for your contribution to vLLM! Before submitting the pull request, please ensure the PR meets the following criteria. This helps vLLM maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

  • [Bugfix] for bug fixes.
  • [CI/Build] for build or continuous integration improvements.
  • [Doc] for documentation fixes and improvements.
  • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
  • [Frontend] For changes on the vLLM frontend (e.g., OpenAI API server, LLM class, etc.)
  • [Kernel] for changes affecting CUDA kernels or other compute kernels.
  • [Core] for changes in the core vLLM logic (e.g., LLMEngine, AsyncLLMEngine, Scheduler, etc.)
  • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix (e.g., [Hardware][AMD]).
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

  • We adhere to Google Python style guide and Google C++ style guide.
  • Pass all linter checks. Please use format.sh to format your code.
  • The code need to be well-documented to ensure future contributors can easily understand the code.
  • Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
  • Please add documentation to docs/source/ if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.

Adding or changing kernels

Each custom kernel needs a schema and one or more implementations to be registered with PyTorch.

  • Make sure custom ops are registered following PyTorch guidelines: Custom C++ and CUDA Operators and The Custom Operators Manual
  • Custom operations that return Tensors require meta-functions. Meta-functions should be implemented and registered in python so that dynamic dims can be handled automatically. See above documents for a description of meta-functions.
  • Use torch.libary.opcheck() to test the function registration and meta-function for any registered ops. See tests/kernels for examples.
  • When changing the C++ signature of an existing op, the schema must be updated to reflect the changes.
  • If a new custom type is needed, see the following document: Custom Class Support in PT2.

Notes for Large Changes

Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

What to Expect for the Reviews

The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

  • After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
  • After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
  • After the review, the reviewer will put an action-required label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.
  • Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

Thank You

Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!

Copy link

👋 Hi! Thank you for contributing to the vLLM project.
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 do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@youkaichao
Copy link
Member

can you add some tests?

@ywang96
Copy link
Member Author

ywang96 commented Sep 22, 2024

can you add some tests?

Yea, I made this PR so that the person who reported the issue can use it to test if it's working for him to unblock him

@ywang96 ywang96 marked this pull request as draft September 22, 2024 20:16
tests/conftest.py Outdated Show resolved Hide resolved
@ywang96
Copy link
Member Author

ywang96 commented Sep 23, 2024

There's some issue with the ordering of when is_multimodal_model needs to be called and when the model actually gets registered to vLLM...I'm still investigating.

@ywang96
Copy link
Member Author

ywang96 commented Sep 23, 2024

This PR should be working now. I have verified test_oot_registration.py passed locally in my environment.

vllm/config.py Outdated Show resolved Hide resolved
@ywang96 ywang96 marked this pull request as ready for review September 23, 2024 04:51
@ywang96
Copy link
Member Author

ywang96 commented Sep 25, 2024

@DarkLight1337 Turned out switching the order solved the issue...I'm honestly not sure why though :/

52b600b seems to show that CUDA initialization in any of the plugins will interfere with vLLM's memory allocation even when the plugin isn't being used. This isn't good...

Yep...

@DarkLight1337
Copy link
Member

@youkaichao any idea about this?

@youkaichao
Copy link
Member

sorry I missed the context here. can you summarize the current status? DM is also fine.

@ywang96
Copy link
Member Author

ywang96 commented Sep 25, 2024

sorry I missed the context here. can you summarize the current status? DM is also fine.

Yea I shared with you on slack - I think it actually has nothing to do with CUDA re-init

@DarkLight1337
Copy link
Member

Please don't merge this yet - we still need to investigate how installing the plugin is causing the test to fail.

@DarkLight1337 DarkLight1337 removed the ready ONLY add when PR is ready to merge/full CI is needed label Sep 25, 2024
@DarkLight1337
Copy link
Member

DarkLight1337 commented Oct 4, 2024

I've added an option to lazy import the registered models based on #9000, see if this fixes the problem.

@DarkLight1337 DarkLight1337 added the ready ONLY add when PR is ready to merge/full CI is needed label Oct 4, 2024
@DarkLight1337
Copy link
Member

Alright, tests pass now. @youkaichao feel free to merge if you are ok with the latest changes.

@DarkLight1337 DarkLight1337 changed the title [Core][VLM] Support registration for OOT multimodal models [Core][VLM] Test registration for OOT multimodal models Oct 4, 2024
@youkaichao youkaichao merged commit 26aa325 into main Oct 4, 2024
57 checks passed
@youkaichao youkaichao deleted the fix-oot-multi-modal branch October 4, 2024 17:38
liuyanyi pushed a commit to liuyanyi/vllm that referenced this pull request Oct 6, 2024
…#8717)

Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk>
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
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: support out tree multimodal models
4 participants