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

[Platform][Refactor] Extract func get_default_attn_backend to Platform #10358

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

MengqingCao
Copy link
Contributor

Extrct func get_default_attn_backend to Platform and implement it on different backends.

Part of #9268

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.

🚀

Copy link
Member

@youkaichao youkaichao left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the refactor!

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

DarkLight1337 commented Nov 16, 2024

PTAL at the failing kernels tests. You can ignore the HF connection errors.

Copy link

mergify bot commented Nov 17, 2024

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

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 Nov 17, 2024
@MengqingCao
Copy link
Contributor Author

PTAL at the failing kernels tests. You can ignore the HF connection errors.

Well, when getting the default attention backend via the current_platform runtime instance, we can no longer mock different backends via mock vllm.attention.selector.current_platform.is_cpu. I will take a look at how to change the test cases to adapt to the current changes.

@youkaichao
Copy link
Member

maybe you can directly mock which_attn_to_use

@MengqingCao
Copy link
Contributor Author

maybe you can directly mock which_attn_to_use

Won't this invalidate the test? I mean this might skip the actual execution of the test.

@youkaichao
Copy link
Member

Won't this invalidate the test?

good point.

maybe:

if device == "cpu":
    from vllm.platforns.cpu import CpuPlatform
    with patch("vllm.platforms.current_platform", CpuPlatform()):

@MengqingCao
Copy link
Contributor Author

if device == "cpu":
    from vllm.platforns.cpu import CpuPlatform
    with patch("vllm.platforms.current_platform", CpuPlatform()):

Thanks! Mocking current_platform works, but with a slight change, i.e. we need to mock vllm.attention.selector.current_platform

Copy link

mergify bot commented Nov 18, 2024

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

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 Nov 18, 2024
@MengqingCao
Copy link
Contributor Author

CI failed because VllmConfig was not set before calling CustomOp. I'll fix this in the next commit.

image

@MengqingCao
Copy link
Contributor Author

I fixed the UTs in tests/kernels/test_layernorm.py, tests/kernels/test_activation.py, tests/kernels/test_pos_encoding.py and tests/kernels/test_rotary_embedding.py

image

However, I have some trouble in triton now. Thus, I didn't fix tests/kernels/test_moe.py and tests/kernels/test_awq_marlin.py
image

@youkaichao Could you help fix the remaining UTs in tests/kernels/test_moe.py and tests/kernels/test_awq_marlin.py ?

@youkaichao
Copy link
Member

@MengqingCao sorry for the trouble. these errors should be fixed by #10431 . please merge main to fix the test error. and you can revert the changes to tests/kernels/test_rotary_embedding.py etc.

@MengqingCao
Copy link
Contributor Author

@MengqingCao sorry for the trouble. these errors should be fixed by #10431 . please merge main to fix the test error. and you can revert the changes to tests/kernels/test_rotary_embedding.py etc.

Thanks, got it

Signed-off-by: Mengqing Cao <cmq0113@163.com>
@mergify mergify bot removed the needs-rebase label Nov 19, 2024
@DarkLight1337 DarkLight1337 merged commit 8c1fb50 into vllm-project:main Nov 19, 2024
53 checks passed
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