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] Enable support for CPU backend in AsyncLLMEngine. #3993

Merged
merged 4 commits into from
Apr 22, 2024

Conversation

sighingnow
Copy link
Contributor

FILL IN THE PR DESCRIPTION HERE

FIX #xxxx (link existing issues this PR will resolve)

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!

@@ -333,6 +333,9 @@ def from_engine_args(
if engine_config.device_config.device_type == "neuron":
raise NotImplementedError("Neuron is not supported for "
"async engine yet.")
elif engine_config.device_config.device_type == "cpu":
from vllm.executor.cpu_executor import CPUExecutor
Copy link
Contributor

Choose a reason for hiding this comment

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

should also guard ray enabled case?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed. An assertion has been added.

@sighingnow
Copy link
Contributor Author

Hi @WoosukKwon, could you please take another look on this PR?

Thanks!

Signed-off-by: Tao He <sighingnow@gmail.com>
@sighingnow
Copy link
Contributor Author

Rebased to main and conflicits resolved.

Signed-off-by: Tao He <sighingnow@gmail.com>
@tianyil1
Copy link

tianyil1 commented Apr 16, 2024

In the official vLLM-cpu-env docker container, if I used the "python3 -m vllm.entrypoints.openai.api_server --device cpu --model Mistral-7B-v0.1/", it will throw the below error:
image

If I applied this PR patch into vLLM, it can solved my problem!

Copy link
Collaborator

@WoosukKwon WoosukKwon left a comment

Choose a reason for hiding this comment

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

@sighingnow LGTM! Thanks for the PR!

@zhouyuan Thanks for the review! Just curious: Don't we need more optimizations (e.g., process binding) for the API server? If so, do you have a plan to contribute these optimizations?

@WoosukKwon WoosukKwon enabled auto-merge (squash) April 22, 2024 07:58
@WoosukKwon WoosukKwon merged commit 077f0a2 into vllm-project:main Apr 22, 2024
46 of 47 checks passed
@sighingnow sighingnow deleted the ht/cpu-async branch April 22, 2024 09:23
@zhouyuan
Copy link
Contributor

@sighingnow LGTM! Thanks for the PR!

@zhouyuan Thanks for the review! Just curious: Don't we need more optimizations (e.g., process binding) for the API server? If so, do you have a plan to contribute these optimizations?

@WoosukKwon Hi Woosuk, thanks for checking, yes more optimizations are required for the framework and kernels as vLLM is designed for GPU friendly. In general to make CPU backend happy we are looking on

  • separate the threads for tokenizer
  • optimize the memory access, inside and outside NUMA node
  • optimize the KV cache format to be more CPU friendly

Ideally the components may need to have both GPU and CPU optimized impls, but may introduce too big changes. We are experimenting some local patches. Will try to compile some concrete plans and discuss with vLLM community.

thanks,
-yuan

xjpang pushed a commit to xjpang/vllm that referenced this pull request Apr 25, 2024
robertgshaw2-neuralmagic pushed a commit to neuralmagic/nm-vllm that referenced this pull request Apr 26, 2024
alexeykondrat pushed a commit to alexeykondrat/ci-vllm that referenced this pull request May 1, 2024
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request May 7, 2024
Temirulan pushed a commit to Temirulan/vllm-whisper that referenced this pull request Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants