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

[Bugfix] [Core] don't schedule prefill if freeing kv cache #5633

Closed
wants to merge 9 commits into from

Conversation

toslunar
Copy link
Contributor

@toslunar toslunar commented Jun 18, 2024

FIX #5578

This PR makes the priority "running > swapped > waiting" strict. The previous code has chance to schedule new prefills even if preemption/swap happens or there's a swapped request, which (unintentionally) changes the order of requests.

#3853 says

1. Schedule all decodes
2. Schedule all chunked prefills (running prefills)
3. Schedule swapped
4. Schedule new prefills

and it has been implemented that (3.) is skipped if (1.) or (2.) fails to schedule all. The new change is to skip (4.) if any previous step fails to schedule all.

Re-adding preempted requests to chunked prefill may be OK but it seems better to implement "partial preemption" of a sequence (i.e. freeing some tail part of KV cache), which is out of scope of the PR.


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!

@toslunar
Copy link
Contributor Author

The testcase test_running_prefill_prioritized_over_swap is failing. The scenario has to be rewritten because it's still important to test the priority Step 2 > Step 3.

The current failure is at setup and caused by prioritizing swapped seq group (id: "1") over waiting seq group (id: "2"), i.e. Step 3 over Step 4, which is expected by the change of the algorithm.

@simon-mo simon-mo requested a review from rkooo567 June 18, 2024 21:16
@toslunar
Copy link
Contributor Author

The PR is ready for review. Each CI passes at least once before or after the empty commit.

@rkooo567
Copy link
Collaborator

sorry will need 1 more day to review!

@toslunar
Copy link
Contributor Author

toslunar commented Sep 6, 2024

The technique 231ec60#diff-2c6af6e25b8d1074f25ef5ad2901121b30bc1528de74d2b3625636fcb8181624R386-R389 to run test_running_prefill_prioritized_over_swap no longer works for some reason after the merge.

@toslunar
Copy link
Contributor Author

toslunar commented Oct 8, 2024

Is there anything I'm supposed to do? Removing the test is my suggestion, rather than indicating I'm working in progress. I'm sorry that it's unclear from my last comment.

@comaniac
Copy link
Collaborator

comaniac commented Oct 8, 2024

Can you fix the tests to match the desired behavior instead of removing them?

Copy link

mergify bot commented Nov 26, 2024

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

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 26, 2024
@hmellor
Copy link
Collaborator

hmellor commented Feb 18, 2025

@toslunar do you plan to continue this work?

Signed-off-by: Toshiki Kataoka <[email protected]>
@mergify mergify bot removed the needs-rebase label Feb 18, 2025
@toslunar
Copy link
Contributor Author

Yes! It seems test_running_prefill_prioritized_over_swap has been removed (by #9569).

But I'll recreate a PR with a squashed commit in order to visibly keep the CI results here, while the commits have to be signed off now.

@hmellor
Copy link
Collaborator

hmellor commented Feb 19, 2025

Ok, thanks for the update! Shall I close this PR and wait for the recreated one?

@toslunar
Copy link
Contributor Author

Thank you. I created the new PR.

@toslunar toslunar closed this Feb 19, 2025
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.

[Bug]: chunked prefill scheudler uses up swap on many n>=2 requests
4 participants