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

[Doc] Consistent naming of attention backends #9498

Merged
merged 5 commits into from
Oct 21, 2024

Conversation

tdoublep
Copy link
Member

@tdoublep tdoublep commented Oct 18, 2024

Right now if you try to enable an unsupported feature (e.g., multi-step with xformers) you get a message like:

ValueError: Multi-Step not supported for attention backend: xformers. Set VLLM_ATTENTION_BACKEND to a value from ['flash-attn', 'rocm-flash-attn', 'flashinfer']

I find this confusing because the names given do not match how the environment variable needs to be set in order to enable the corresponding feature (e.g. rocm-flash-attn vs. ROCM_FLASH). The actual names are all-caps and defined by this enum. Those values do not match the string "names" defined in each attention backend class.

This PR fixes this, so the user will be suggested a list of strings that will actually work.

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.

🚀

Copy link
Collaborator

@comaniac comaniac 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 unifying that

@comaniac comaniac added the ready ONLY add when PR is ready to merge/full CI is needed label Oct 18, 2024
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) October 20, 2024 04:38
@DarkLight1337
Copy link
Member

Please take a look at the CI failure.

Signed-off-by: Thomas Parnell <[email protected]>
auto-merge was automatically disabled October 21, 2024 09:00

Head branch was pushed to by a user without write access

@tdoublep
Copy link
Member Author

@DarkLight1337 CI issues are fixed now.

@DarkLight1337 DarkLight1337 merged commit 496e991 into vllm-project:main Oct 21, 2024
61 checks passed
@tdoublep tdoublep deleted the fix-attn-backend-names branch October 21, 2024 14:58
charlifu pushed a commit to charlifu/vllm that referenced this pull request Oct 23, 2024
vrdn-23 pushed a commit to vrdn-23/vllm that referenced this pull request Oct 23, 2024
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
garg-amit pushed a commit to garg-amit/vllm that referenced this pull request Oct 28, 2024
FerdinandZhong pushed a commit to FerdinandZhong/vllm that referenced this pull request Oct 29, 2024
sumitd2 pushed a commit to sumitd2/vllm that referenced this pull request Nov 14, 2024
KuntaiDu pushed a commit to KuntaiDu/vllm that referenced this pull request Nov 20, 2024
mfournioux pushed a commit to mfournioux/vllm that referenced this pull request Nov 20, 2024
tlrmchlsmth pushed a commit to neuralmagic/vllm that referenced this pull request Nov 23, 2024
Signed-off-by: Thomas Parnell <[email protected]>
Signed-off-by: Tyler Michael Smith <[email protected]>
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.

4 participants