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] Add Prefix Caching Warmup Step #3901

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

Conversation

robertgshaw2-neuralmagic
Copy link
Collaborator

@robertgshaw2-neuralmagic robertgshaw2-neuralmagic commented Apr 7, 2024

Adds warmup step for prefix caching.

Currently, vLLM runs over two out of three attention cases during warmup:

  • prefill with no kv cache (model_runner.profile_run)
  • decode (model_runner.capture_model)

context_fwd_attention runs prefill with KV cache. Currently, this is implemented as a triton function with @triton.jit decorator. As a result, the code is generate at runtime. Since context_fwd_attention does not run on the warmup step, this causes ~3sec delay on the first request that uses context_fwd_attention

  • note: it seems triton caches in between runs, since if we re-launch the server the issue goes away

cc @SageMoore @ElizaWszola @tlrmchlsmth

FIX #3846

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!

Comment on lines +168 to +169
if self.cache_config.enable_prefix_caching:
self.model_runner.warmup_prefix_attn(self.gpu_cache)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this called only in profiling? Or each inference?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warm_up_model is not called on the hotpath

Copy link
Member

@zhuohan123 zhuohan123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general looks good! Left some small comments on how we run the warm up run.

computed. This thus triggers context_attention_fwd and generates
the code.
"""
NUM_ITERATIONS = 10
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel one iteration should be good enough?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought so too, but empirically seemed that I needed more than 1 run to make timing stable, so I just picked 10.
This takes <1s so its not impactful to UX, but agree the code is a bit silly

Let me do some more experiments.

Comment on lines 814 to 832
request_0 = SequenceGroupMetadata(
request_id="first_request",
is_prompt=True,
seq_data={0: SequenceData(prompt_tokens)},
sampling_params=SamplingParams(temperature=0),
block_tables={0: block_table},
)
self.execute_model([request_0], kv_caches)

# Prompt forward with block 1 computed. (Triggers
# context_attention_fwd).
request_1 = SequenceGroupMetadata(
request_id="second_request",
is_prompt=True,
seq_data={0: SequenceData(prompt_tokens)},
sampling_params=SamplingParams(temperature=0),
block_tables={0: block_table},
computed_block_nums=block_table[:NUM_COMPUTED_BLOCKS],
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just run request_1? I believe the only goal here is to activate the triton kernel.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think that should work

@robertgshaw2-neuralmagic
Copy link
Collaborator Author

Will address. Thanks Zhuohan

@zhuohan123
Copy link
Member

@robertgshaw2-neuralmagic Let me know when this PR is ready for another round of review!

@Juelianqvq
Copy link
Contributor

@robertgshaw2-neuralmagic This pr solves my problem. cc.

Copy link

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 github-actions bot added the stale label Oct 29, 2024
Copy link

mergify bot commented Oct 29, 2024

This pull request has merge conflicts that must be resolved before it can be
merged. @robertgshaw2-neuralmagic please rebase it. 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 Oct 29, 2024
@github-actions github-actions bot added unstale and removed stale labels Nov 2, 2024
@simon-mo simon-mo requested a review from youkaichao as a code owner November 26, 2024 05:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants