vllm
vllm copied to clipboard
[Core] Implement sharded state loader
This PR implements a new model loader that directly loads the sharded states of each worker when using DistributedGPUExecutor
. When using tensor parallelism, this avoids each worker reading the full checkpoint just to load a small shard of it. Our tests using Arctic (https://github.com/vllm-project/vllm/pull/4652) showed a 10x improvement in model loading speed from NVMe when using 8x tensor parallelism.
For quantization methods like DeepSpeed's FP_Quantize (also used in https://github.com/vllm-project/vllm/pull/4652) that quantize after loading, this PR allows easy creation of a quantized checkpoint that is directly loaded into each worker, further speeding up model loading.
This PR is separated out from https://github.com/vllm-project/vllm/pull/4652.
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!
We should add a test to ensure it's working correctly (loaded weights and outputs are the same as with the default loader)
We should add a test to ensure it's working correctly (loaded weights and outputs are the same as with the default loader)
Sure, that makes sense. What's the spec of the test runner machine we should target? OK to assume cuda device is present?
@aurickq IIRC we are using L4 GPUs in CI, @simon-mo to confirm
@Yard1 added test, please take a look
One question I have is that can this be implemented using safetensor's partial read? safetensors have all the metadata in headers so you can access the tensors partially
One question I have is that can this be implemented using safetensor's partial read? safetensors have all the metadata in headers so you can access the tensors partially
Conceptually, I think so. Though for larger models like Arctic we prefer this implementation for a few reasons:
- With the current implementation and multi-node inference, we may download only the required files to each node.
- The deepspeedfp quantizer will reshape the parameters and may change its number of elements, which makes it a bit tricky to calculate the right slice to load (need to understand internals of the quantizer to slice the quantized weights).
@aurickq curious how this relates to https://github.com/vllm-project/vllm/pull/3729?
@aurickq curious how this relates to #3729?
Ah, I hadn't seen that PR, thanks for bringing it up! From what I understand, both PRs address the problem of model loading speed, particularly for larger models, but the approaches seem pretty different. #3729 modifies the existing model loading path so each worker loads a different set of tensors, then broadcasts the shards to each other. This PR loads the model once using the default path and dumps each worker state to disk, then subsequent model loads can direct read these states, skipping the default model loading path altogether.
Some first thoughts on the pros/cons:
- This PR requires the creation of a new checkpoint (the worker states), and this checkpoint is only compatible with a fixed configuration (parallelism, quantization, etc.). Whereas #3729 seems more flexible in this regard.
- #3729 seems to require a lot more changes in vllm and in each model definition, whereas this PR only requires a handful of lines of change in vllm, and no changes in any of the models (so any future model is automatically supported).
- #3729 seems to be more coupled with the parallelism implementation (e.g. tensor parallel in this case). However we are currently implementing pipeline-parallelism to support multi-node inference, which also will be automatically supported by this PR.