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

Async update for vineyard llm cache #12

Merged
merged 4 commits into from
Nov 15, 2024

Conversation

DwyaneShi
Copy link
Collaborator

@DwyaneShi DwyaneShi commented Nov 7, 2024

Have a dedicated thread for performing update operations.

Vineyard is designed to drop updates whose prefix chunks are not already present in the cache, which imposes an ordering requirement on updates: we must perform updates in the issued order for each sequence. For simplicity, we use a single thread to process all updates sequentially.

Internally, we use an object pool to reuse the pinned tensors and restrict the number of inflight tasks. if an update operation cannot get a tensor from the pool, meaning we already have max_inflight_tasks tasks issued, it then simply skips the update. A completed task will return the used tensor back to the pool. The memory utilization of the object pool is configurable via env variable VINEYARD_CACHE_ASYNC_UPDATE_CPU_MEM_UTIL, whose value ranges from 0 to 1, and, e.g., 0.2 means 20% of VINEYARD_CACHE_CPU_MEM_LIMIT_GB (configured cpu memory limit for vineyard) will be used by the object pool.

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.

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!

Vineyard is designed to drop updates whose prefix chunks are
not already present in the cache, which imposes an ordering requirement
on updates: we must perform updates in the issued order for each
sequence. For simplicity, we use a single thread to process all updates sequentially.

Signed-off-by: Haiyang Shi <[email protected]>
Copy link

github-actions bot commented Nov 7, 2024

👋 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 starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

vllm/envs.py Show resolved Hide resolved
vllm/envs.py Show resolved Hide resolved
vllm/utils.py Show resolved Hide resolved
vllm/utils.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Outdated Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Outdated Show resolved Hide resolved
vllm/utils.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Outdated Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Outdated Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Outdated Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Outdated Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Outdated Show resolved Hide resolved
- introduced more env variables to config async update
- enhance comments
- metrics for async update

Signed-off-by: Haiyang Shi <[email protected]>
vllm/utils.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Show resolved Hide resolved
vllm/worker/vineyard_llm_cache.py Outdated Show resolved Hide resolved
- add more comments

Signed-off-by: Haiyang Shi <[email protected]>
- enhance `_update_kv_cache`

Signed-off-by: Haiyang Shi <[email protected]>
@Jeffwan
Copy link

Jeffwan commented Nov 15, 2024

All my comments are addressed. /lgtm

@DwyaneShi DwyaneShi merged commit 22e90d8 into feat/distributed-kv-cache Nov 15, 2024
@DwyaneShi DwyaneShi deleted the haiyang/async-update branch November 15, 2024 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants