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

[Core] Implementing disaggregated prefilling, and caching KV cache in CPU/disk/database. #8498

Open
wants to merge 325 commits into
base: main
Choose a base branch
from

Conversation

KuntaiDu
Copy link
Collaborator

@KuntaiDu KuntaiDu commented Sep 16, 2024

TL; DR: implemented disaggregated prefill with <100 core line change (and most of them are comments)

This PR is a continuation of PR #6170 , with a new design that allows future extension.

Current supported applications:

  • Disaggregated prefilling. Check examples/disagg_prefill/disagg_prefill_example.sh for an example, and benchmarks/disagg_prefill for various benchmarks. Benchmarking script are all one-click runnable (after setting HF_TOKEN)
  • Connecting to a KV cache storage service LMCache. Examples TBD.

Two roles: KV provider (e.g. prefill vLLM instance) and KV consumer (e.g. decode vLLM instance)

  • Provider side: insert: insert a KV cache to a buffer, so that it can be transferred upon request
  • Consumer side: drop_select: select a KV cache based on tokens, transfer the selected KV, and drop this KV out from the buffer

Example workflow (the buffer in the following figure is the same as insert)
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.

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

mergify bot commented Nov 15, 2024

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

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 15, 2024
@mergify mergify bot removed the needs-rebase label Nov 17, 2024
@KuntaiDu
Copy link
Collaborator Author

KuntaiDu commented Nov 18, 2024

Now the end-to-end disagg prefill example in the example folder is functional (thanks to Kaichao's suggestion the core change is also much less). The remaining chores are cleaning up the tests, adjust benchmarking files and do some perf benchmark.

  • move configuration to vllmconfig
  • adjust distributed initialization method
  • adjust the abstraction --- now we call anything an "connector", which basically means a connection between P and D instance. The connection can be done via torch.distributed, or by third-party library like LMCache and Mooncake
  • update perf benchmark files

We are also aware other bugs and feature requests --- we will fix them in future PRs.

  • torch.distributed heartbeat
  • Transfer the generated tokens in disagg prefill to bypass token sampling in decode instance
  • Implement a disaggregated prefill engine designated for disagg prefill to avoid OpenAI API server reduction
  • Pipelining
  • XpYd support
  • RDMA support

@KuntaiDu
Copy link
Collaborator Author

  • Overhead: on llama 8B, the total overhead added by disaggregated prefill is 17.61 ms (measured by benchmarks/disagg_benchmarks/disagg_overhead_benchmark.sh)

Performance benchmark now crashes at high QPS, need some debugging to find out why.

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.