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

[Frontend][Core] Add plumbing to support audio language models #7446

Merged
merged 4 commits into from
Aug 13, 2024

Conversation

petersalas
Copy link
Contributor

@petersalas petersalas commented Aug 12, 2024

This adds infrastructure to support multi-modal audio language models.

  • MultiModalDataBuiltins defines audio as a tuple of a numpy.ndarray and the sample rate. (librosa is used to parse the audio.)
  • DEFAULT_PLUGINS now includes an AudioPlugin
  • The OpenAI API frontend tentatively supports "audio_url" content parts, albeit with the same restrictions that currently apply to "image_url" parts (e.g. only one multi-modal chunk per prompt).
  • A number of methods/types that were only nominally vision-specific are renamed to be more generically multi-modal. For example, SupportsVision is now SupportsMultiModal.

This PR does not include any such audio models, but does include a test that exercises the OpenAI frontend and audio pipeline (see tests/entrypoints/openai/test_audio.py).

FIX #7335

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.

🚀

@DarkLight1337 DarkLight1337 requested a review from ywang96 August 13, 2024 01:23
@DarkLight1337 DarkLight1337 self-assigned this Aug 13, 2024
Copy link
Member

@DarkLight1337 DarkLight1337 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 implementing this! Overall it looks good, just some small things that need to be resolved.

vllm/entrypoints/chat_utils.py Outdated Show resolved Hide resolved
docs/source/models/vlm.rst Outdated Show resolved Hide resolved
vllm/model_executor/models/internvl.py Outdated Show resolved Hide resolved
vllm/multimodal/utils.py Show resolved Hide resolved
tests/entrypoints/openai/test_audio.py Show resolved Hide resolved
@DarkLight1337
Copy link
Member

Are you going to work on adding a new audio model after this PR?

@ywang96
Copy link
Member

ywang96 commented Aug 13, 2024

This is exciting! Thank you for kicking off the initiative to support audio LMMs!

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) August 13, 2024 15:52
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Aug 13, 2024
@petersalas
Copy link
Contributor Author

petersalas commented Aug 13, 2024

Are you going to work on adding a new audio model after this PR?

If you're open to it, I'd love to bring https://github.com/fixie-ai/ultravox into vLLM. We're currently serving it via an externally registered model + some monkeypatches to handle audio via "image_url" but we'd certainly rather it be directly supported!

@DarkLight1337
Copy link
Member

Going to merge this so I can incorporate it into my #7126 tomorrow.

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.

Just one change needed - Thank you for making this PR! @petersalas

requirements-common.txt Show resolved Hide resolved
auto-merge was automatically disabled August 13, 2024 16:04

Head branch was pushed to by a user without write access

@ywang96 ywang96 enabled auto-merge (squash) August 13, 2024 16:28
@ywang96 ywang96 merged commit 00c3d68 into vllm-project:main Aug 13, 2024
69 checks passed
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 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.

[Feature]: support voice llm like cosyvoice
3 participants