vllm icon indicating copy to clipboard operation
vllm copied to clipboard

[FrontEnd] Keep RPC server tcp protocol

Open esmeetu opened this issue 1 year ago • 9 comments

Motivation: Keep RPC tcp mode is useful when we want to deploy api server and vllm engine server on different machine.

Related PR: https://github.com/vllm-project/vllm/pull/7222

image

Furthermore, i want to decouple api server with vllm engine server in the future, where we can update one of them without shutdown another server.

Use case:

# start rpc server on Node1
vllm serve model_arg --engine-use-rpc

# start api server on Node2
vllm start --adress tcp://Node1:5570

vLLM RPC System(Experimental):

image


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!

esmeetu avatar Aug 09 '24 14:08 esmeetu

👋 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.

🚀

github-actions[bot] avatar Aug 09 '24 14:08 github-actions[bot]

where we can update one of them without shutdown another server

looks like a corner case. what's the motivation for this? when you shutdown the engine server, the api server is not usable.

youkaichao avatar Aug 09 '24 16:08 youkaichao

As part of this, we need to make sure that port selection is robust

robertgshaw2-redhat avatar Aug 09 '24 16:08 robertgshaw2-redhat

I think the main thing is that we make it clear the interface/protocol between the two procs is not yet stable, will likely change over the next few versions as we refine things.

njhill avatar Aug 10 '24 00:08 njhill

where we can update one of them without shutdown another server

looks like a corner case. what's the motivation for this? when you shutdown the engine server, the api server is not usable.

Yes, but when i reboot api server(light), i won't touch engine server (heavy, might multi-node serving the large model). But ipc mode can also achieve this if we know the ipc path. And rpc mode just for distributed server environment.

esmeetu avatar Aug 10 '24 00:08 esmeetu

I think the main thing is that we make it clear the interface/protocol between the two procs is not yet stable, will likely change over the next few versions as we refine things.

Yes, and I also add some ideas in the description.

esmeetu avatar Aug 10 '24 01:08 esmeetu

As part of this, we need to make sure that port selection is robust

ok, will look into this. But currently we can use VLLM_RPC_PORT to control.

esmeetu avatar Aug 10 '24 01:08 esmeetu

when i reboot api server(light), i won't touch engine server (heavy, might multi-node serving the large model)

can you elaborate on this? what's the usecase of rebooting just the api server?

youkaichao avatar Aug 10 '24 01:08 youkaichao

when i reboot api server(light), i won't touch engine server (heavy, might multi-node serving the large model)

can you elaborate on this? what's the usecase of rebooting just the api server?

Such as adding some features for api server or api server crash for some reason.

esmeetu avatar Aug 10 '24 02:08 esmeetu

Unless this (splitting the API server and engine on separate hosts) was a fully supported use case, then I don't think it makes sense to merge this. Instead, I think it would need to be part of a bigger effort that starts with a design doc that covers more than just changing this to TCP.

russellb avatar Nov 08 '24 02:11 russellb

This pull request has been automatically marked as stale because it has not had any activity within 90 days. It will be automatically closed if no further activity occurs within 30 days. Leave a comment if you feel this pull request should remain open. Thank you!

github-actions[bot] avatar Feb 25 '25 02:02 github-actions[bot]

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

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

mergify[bot] avatar Feb 25 '25 02:02 mergify[bot]