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

[Hardware][Intel CPU][DOC] Update docs for CPU backend #6212

Merged
merged 25 commits into from
Oct 22, 2024

Conversation

zhouyuan
Copy link
Contributor

@zhouyuan zhouyuan commented Jul 8, 2024

This patch adds the typical deployment considerations for vLLM with CPU backend, since it's different with the GPU backend.

related #3654

https://vllm--6212.org.readthedocs.build/en/6212/

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
Contributor

@rafvasq rafvasq left a comment

Choose a reason for hiding this comment

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

Just wanted to offer some proofreading for grammar and readability :)

docs/source/getting_started/cpu-installation.rst Outdated Show resolved Hide resolved
docs/source/getting_started/cpu-installation.rst Outdated Show resolved Hide resolved
docs/source/getting_started/cpu-installation.rst Outdated Show resolved Hide resolved
docs/source/getting_started/cpu-installation.rst Outdated Show resolved Hide resolved
docs/source/getting_started/cpu-installation.rst Outdated Show resolved Hide resolved
docs/source/getting_started/cpu-installation.rst Outdated Show resolved Hide resolved
@zhouyuan zhouyuan changed the title [Hardware][Intel CPU][DOC] adding typical deployment considerations for CPU backend [Hardware][Intel CPU][DOC] adding deployment considerations for CPU backend Jul 22, 2024
@zhouyuan zhouyuan marked this pull request as ready for review August 28, 2024 15:51
@zhouyuan zhouyuan force-pushed the wip_cpu_reference_setup branch 3 times, most recently from 7e96e83 to acb0913 Compare October 8, 2024 07:18
@zhouyuan zhouyuan changed the title [Hardware][Intel CPU][DOC] adding deployment considerations for CPU backend [Hardware][Intel CPU][DOC] Update docs for CPU backend Oct 8, 2024
@zhouyuan
Copy link
Contributor Author

zhouyuan commented Oct 8, 2024

Hi @WoosukKwon I have made updates to the CPU documentation to reflect the recent changes. Could you please review these diff?

thanks, -yuan

@zhouyuan
Copy link
Contributor Author

Hi @DarkLight1337 @Isotr0py

Could you please kindly help to take a look on this? This diff is pure for CPU backend doc update.

thanks, -yuan

Copy link
Collaborator

@Isotr0py Isotr0py left a comment

Choose a reason for hiding this comment

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

I'm fine with the cpu-installation part of this doc update. Thanks for updating documentation about new feature on CPU backend!

Let's see if others can have a look on nginx server part. (I'm not familiar with the nginx server deployment)

docs/source/getting_started/cpu-installation.rst Outdated Show resolved Hide resolved
@DarkLight1337
Copy link
Member

(I'm not familiar with the nginx server deployment)

@simon-mo do you know anyone who can review this?

@zhouyuan
Copy link
Contributor Author

Thank you! @Isotr0py @DarkLight1337

Let's see if others can have a look on nginx server part. (I'm not familiar with the nginx server deployment)

The intention here is to make one example for multiple instances base deployment: e.g., a load-balancer in the front + several vLLM serving endpoints. It is indeed not bounded to CPU backend. Not sure where is the best place to put this part. I'm OK to move this to somewhere else.

thanks, -yuan

@Isotr0py
Copy link
Collaborator

Not sure where is the best place to put this part. I'm OK to move this to somewhere else.

Seems that the Nginx Loadbalancer part is put to Getting Started chapter. I think we can move it to Serving chapter just like deploying with k8s and deploying with docker, renaming to deploying nginx loadbalancer.

@zhouyuan zhouyuan force-pushed the wip_cpu_reference_setup branch 2 times, most recently from 25f9703 to fc1f394 Compare October 11, 2024 08:48
Copy link
Collaborator

@Isotr0py Isotr0py left a comment

Choose a reason for hiding this comment

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

I can deploy the nginx server following the nginx server instructions, so I'm fine with this part now. Just leave some minor nits.

20241014145646

docs/source/serving/deploying_with_nginx.rst Outdated Show resolved Hide resolved
docs/source/serving/deploying_with_nginx.rst Outdated Show resolved Hide resolved
@Isotr0py Isotr0py enabled auto-merge (squash) October 15, 2024 04:47
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Oct 15, 2024
@zhouyuan
Copy link
Contributor Author

@Isotr0py @simon-mo Thank you for the review. The failures in CI seems not related with this patch. I'm not able to re-trigger it without modifying the patch, Could you please kindly help here to re-trigger it?

thanks, -yuan

@simon-mo
Copy link
Collaborator

Hmmm please can you edit the documentation with gpu example? That's the primary reader's use case

@zhouyuan
Copy link
Contributor Author

Hmmm please can you edit the documentation with gpu example? That's the primary reader's use case

Hi Simon, make sense, I will modify to use GPU docker as the example.

thanks, -yuan

auto-merge was automatically disabled October 16, 2024 23:03

Head branch was pushed to by a user without write access

@zhouyuan
Copy link
Contributor Author

zhouyuan commented Oct 17, 2024

Hi @simon-mo, gentle ping, I modified the example in Nginx to use GPU docker, could you please check?
85d0ea0

thanks, -yuan

zhouyuan and others added 4 commits October 18, 2024 08:50
This patch adds the typical deployment considerations for vLLM with CPU backend.

Signed-off-by: Yuan Zhou <[email protected]>
@zhouyuan zhouyuan force-pushed the wip_cpu_reference_setup branch from cdf8055 to 85d0ea0 Compare October 18, 2024 00:50
@simon-mo simon-mo merged commit 32a1ee7 into vllm-project:main Oct 22, 2024
37 checks passed
charlifu pushed a commit to charlifu/vllm that referenced this pull request Oct 23, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: charlifu <[email protected]>
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: Alvant <[email protected]>
MErkinSag pushed a commit to MErkinSag/vllm that referenced this pull request Oct 26, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: Erkin Sagiroglu <[email protected]>
garg-amit pushed a commit to garg-amit/vllm that referenced this pull request Oct 28, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: Amit Garg <[email protected]>
FerdinandZhong pushed a commit to FerdinandZhong/vllm that referenced this pull request Oct 29, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: qishuai <[email protected]>
NickLucche pushed a commit to NickLucche/vllm that referenced this pull request Oct 31, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: NickLucche <[email protected]>
NickLucche pushed a commit to NickLucche/vllm that referenced this pull request Oct 31, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: NickLucche <[email protected]>
sumitd2 pushed a commit to sumitd2/vllm that referenced this pull request Nov 14, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: Sumit Dubey <[email protected]>
KuntaiDu pushed a commit to KuntaiDu/vllm that referenced this pull request Nov 20, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
mfournioux pushed a commit to mfournioux/vllm that referenced this pull request Nov 20, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[email protected]>
Signed-off-by: Maxime Fournioux <[email protected]>
tlrmchlsmth pushed a commit to neuralmagic/vllm that referenced this pull request Nov 23, 2024
…6212)

Signed-off-by: Yuan Zhou <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Gubrud, Aaron D <[email protected]>
Co-authored-by: adgubrud <[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 x86 CPU
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants