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

[Model] Add UltravoxModel and UltravoxConfig #7615

Merged
merged 7 commits into from
Aug 21, 2024

Conversation

petersalas
Copy link
Contributor

This adds support for the Ultravox speech model and changes tests/entrypoints/openai/test_audio.py to use Ultravox instead of a mocked audio model.

BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE


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.

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 consists a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of default ones by unblocking the steps in your fast-check build on Buildkite UI.

Once the PR is approved and ready to go, please make sure to run full CI as it is required to merge (or just use auto-merge).

To run full CI, you can do one of these:

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

🚀

@ywang96
Copy link
Member

ywang96 commented Aug 17, 2024

@petersalas Very exciting!

Is this PR ready for review? Also FYI I'm doing some refactoring in #7530 so please update your PR after that gets merged. Thanks!

@ywang96 ywang96 self-assigned this Aug 17, 2024
@petersalas petersalas force-pushed the psalas/ultravox-model branch from 3054191 to 8d450c9 Compare August 19, 2024 16:57
@petersalas
Copy link
Contributor Author

@ywang96 Thanks for the heads up! I updated the PR with the latest changes -- this is ready for review.

Copy link
Member

@ywang96 ywang96 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR and I left first round of review!

I didn't see a correctness test added to this PR, and typically we don't require a correctness test if the model contribution is directly from the model vendor, but I assume you have already tested the implementation.

Finally, could you add example usage under examples directory for both offline and online inference? (feel free to modify openai_vision_api_client.py)

Thank you!

vllm/model_executor/models/ultravox.py Outdated Show resolved Hide resolved
vllm/model_executor/models/ultravox.py Outdated Show resolved Hide resolved
vllm/model_executor/models/ultravox.py Outdated Show resolved Hide resolved
vllm/model_executor/models/ultravox.py Outdated Show resolved Hide resolved
vllm/model_executor/models/ultravox.py Outdated Show resolved Hide resolved
vllm/model_executor/models/ultravox.py Outdated Show resolved Hide resolved
vllm/model_executor/models/ultravox.py Outdated Show resolved Hide resolved
vllm/model_executor/models/ultravox.py Outdated Show resolved Hide resolved
@ywang96
Copy link
Member

ywang96 commented Aug 21, 2024

@petersalas Overall I think this PR is in a good shape! I'll give this PR a go with some manual testing just as a validation as well as leaving @DarkLight1337 with some time in case he wants to take a look too.

Otherwise if everything goes well and all test pass, we should be able to merge this PR this week!

@petersalas
Copy link
Contributor Author

Amazing, thank you!

Copy link
Member

@ywang96 ywang96 left a comment

Choose a reason for hiding this comment

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

I've run the examples of this model with TP=1 and TP=2 (and it's working really well!) and confirmed test_ultravox.py passed in my dev environment.

Left some final comments, otherwise LGTM! Thank you and fixie.ai for contributing this model to vLLM!

examples/openai_audio_api_client.py Outdated Show resolved Hide resolved
examples/openai_audio_api_client.py Show resolved Hide resolved
vllm/model_executor/models/__init__.py Show resolved Hide resolved
@DarkLight1337
Copy link
Member

@ywang96 Let's apply my suggestion in this PR.

@ywang96
Copy link
Member

ywang96 commented Aug 21, 2024

@ywang96 Let's apply my suggestion in this PR.

Actually I don't have access to push changes to this branch...

@ywang96
Copy link
Member

ywang96 commented Aug 21, 2024

@petersalas per discussion above - could you also push a change to line 189 in supported_models.rst to change - Supported Modality(ies) to - Supported Modalities?

@ywang96 ywang96 added the ready ONLY add when PR is ready to merge/full CI is needed label Aug 21, 2024
@ywang96
Copy link
Member

ywang96 commented Aug 21, 2024

@petersalas Looks like moving the cached tokenizer from multimodal/image.py to multimodal/utils.py broke some VLM test - could you fix it? Thanks!

[2024-08-21T19:45:14Z] E   ImportError: cannot import name 'cached_get_tokenizer' from 'vllm.multimodal.image' (/usr/local/lib/python3.10/dist-packages/vllm/multimodal/image.py)

@petersalas
Copy link
Contributor Author

Looks like moving the cached tokenizer from multimodal/image.py to multimodal/utils.py broke some VLM test - could you fix it? Thanks!

[2024-08-21T19:45:14Z] E   ImportError: cannot import name 'cached_get_tokenizer' from 'vllm.multimodal.image' (/usr/local/lib/python3.10/dist-packages/vllm/multimodal/image.py)

Fixed, sorry about that!

@ywang96 ywang96 enabled auto-merge (squash) August 21, 2024 21:56
@ywang96 ywang96 merged commit 1ca0d4f into vllm-project:main Aug 21, 2024
48 checks passed
petersalas added a commit to fixie-ai/vllm that referenced this pull request Aug 22, 2024
simon-mo pushed a commit that referenced this pull request Aug 22, 2024
omrishiv pushed a commit to omrishiv/vllm that referenced this pull request Aug 26, 2024
omrishiv pushed a commit to omrishiv/vllm that referenced this pull request Aug 26, 2024
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
Signed-off-by: Alvant <alvasian@yandex.ru>
KuntaiDu pushed a commit to KuntaiDu/vllm that referenced this pull request Nov 20, 2024
KuntaiDu pushed a commit to KuntaiDu/vllm that referenced this pull request Nov 20, 2024
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.

3 participants