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] Subclass ModelRunner to support cross-attention & encoder sequences (towards eventual encoder/decoder model support) #4942

Conversation

afeldman-nm
Copy link
Contributor

This PR is a step towards encoder/decoder model support. This PR creates a specialized ModelRunner subclass for encoder/decoder models; it differs from the base ModelRunner class primarily in that it (1) expects each SequenceGroup to have an encoder sequence, and (2) it properly constructs the AttentionMetadata structure to support both self- and cross-attention.


A quick overview of the plan for supporting encoder/decoder models in vLLM:

  • Architectural assumptions:
    • The encoder/decoder model comprises one non-autoregressive encoder module and one autoregressive decoder module.
    • A single inference call to the model consumes an encoder prompt and a decoder prompt. The model output is the result of decoder inference against the decoder prompt, conditional on the encoder hidden states which result from applying the encoder to the encoder prompt. The encoder hidden states are not part of the overall model output
    • Thus, encoder inference is a prerequisite for decoder inference. The decoder consumes encoder hidden states via cross-attention, which is not present in decoder-only models.
    • It is assumed that these architectural details are handled inside the model definition; however, to support the inference process for such models, vLLM core must be changed to accommodate cross-attention
  • Encoder/decoder inference process & cross-attention:
    • Prefill phase: (1) Non-autoregressive encoder inference yields encoder hidden states in a single pass; no KV caching occurs. (2) decoder prefill yields first-token-prediction & cached KVs. Within the decoder, cross-attention layers cache the KVs derived from encoder hidden states:

      • Key_{cross-attn, layer-n} = W_{K, cross-attn, layer-n} x (Encoder hidden states)

      • Value_{cross-attn, layer-n} = W_{V, cross-attn, layer-n} x (Encoder hidden states)

      • Note that all cross-attention layers consume the same encoder hidden states; however each cross-attention layers' keys and values differ because each layer has unique W_{K, cross-attn, layer-n} and W_{V, cross-attn, layer-n}. Therefore, the cross-attention KV cache must store KVs for each decoder layer, even though these KVs are all derived from a single set of encoder hidden states.

      • Note that self-attention layer behavior is unchanged compared to what it would be in a decoder-only model (cache KVs computed from the previous decoder layer outputs.)

    • Decode phase: during each iteration of the autoregressive decode process,

      • Each self-attention layer appends the last predicted token's KVs to the KV cache, and then utilizes cached KVs for next-token prediction (again, this is unchanged compared to a decoder-only model)
      • Each cross-attention layer has read-only access to cross-attention KVs, to use for next-token prediction. The cross-attention KV cache is never modified after prefill

To implement the above encoder/decoder inference process, the following functionality will be added to vLLM over the course of multiple PRs:

  1. Support cross-attention KV cache & memory management (allocate/swap/free) in block manager
  2. Invoke cross-attention operation via the Attention wrapper & Attention metadata data structure
  3. (This PR) Modify ModelRunner to construct input tensors & Attention metadata structures for cross-attention
  4. Small changes to LLM engine & scheduler so that vLLM requests can include an encoder input prompt

Note 1: because this PR makes an incremental contribution (cross-attention KV-caching and memory management), this PR will not enable end-to-end encoder/decoder support (this will rely on later PRs.)

Note 2: the best effort is being made to ensure that encoder/decoder models are compatible with existing vLLM features. At this time, encoder/decoder models are unlikely to be compatible with the following vLLM features:

  • Speculative decoding
  • Chunked prefill
  • Automatic prefix caching
  • Sliding window
  • Flash attention
  • CUDA graph

INCREMENTAL FIX TOWARDS #187

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!

@afeldman-nm afeldman-nm marked this pull request as draft May 21, 2024 10:09
@afeldman-nm afeldman-nm changed the title [Core] Correctly invoke prefill & decode kernels for cross-attention (towards eventual encoder/decoder model support) [Core] Subclass ModelRunner to support cross-attention & encoder sequences (towards eventual encoder/decoder model support) May 21, 2024
@afeldman-nm afeldman-nm mentioned this pull request May 23, 2024
@afeldman-nm afeldman-nm force-pushed the afeldman-nm/infra_enc_dec_model_runner branch from 62f7903 to 0285548 Compare June 11, 2024 03:49
@afeldman-nm afeldman-nm marked this pull request as ready for review June 21, 2024 14:46
@JBurtn JBurtn mentioned this pull request Jun 22, 2024
This was referenced Jun 25, 2024
@afeldman-nm afeldman-nm force-pushed the afeldman-nm/infra_enc_dec_model_runner branch from a5c28fc to db5539a Compare July 15, 2024 09:06
vllm/inputs/data.py Outdated Show resolved Hide resolved
vllm/inputs/data.py Outdated Show resolved Hide resolved
@afeldman-nm
Copy link
Contributor Author

/ready

@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Aug 6, 2024
Copy link
Member

@njhill njhill left a comment

Choose a reason for hiding this comment

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

Thanks again @afeldman-nm!

@afeldman-nm
Copy link
Contributor Author

/ready

@robertgshaw2-neuralmagic robertgshaw2-neuralmagic merged commit fd95e02 into vllm-project:main Aug 6, 2024
56 checks passed
@robertgshaw2-neuralmagic robertgshaw2-neuralmagic deleted the afeldman-nm/infra_enc_dec_model_runner branch August 6, 2024 20:51
@afeldman-nm
Copy link
Contributor Author

Once again thanks @sroy745 @njhill @maxdebayser @DarkLight1337 @WoosukKwon @khluu @robertgshaw2-neuralmagic for all of your excellent help in landing this PR!

  • Usage example: examples/offline_inference_encoder_decoder.py
  • Correctness test against HF: tests/models/test_bart.py
  • Parallel test: tests/distributed/test_basic_distributed_correctness_enc_dec.py

sfc-gh-mkeralapura pushed a commit to sfc-gh-mkeralapura/vllm that referenced this pull request Aug 12, 2024
…ences (towards eventual encoder/decoder model support) (vllm-project#4942)

Co-authored-by: Andrew Feldman <[email protected]>
Co-authored-by: Nick Hill <[email protected]>
kylesayrs pushed a commit to neuralmagic/vllm that referenced this pull request Aug 17, 2024
…ences (towards eventual encoder/decoder model support) (vllm-project#4942)

Co-authored-by: Andrew Feldman <[email protected]>
Co-authored-by: Nick Hill <[email protected]>
fialhocoelho pushed a commit to opendatahub-io/vllm that referenced this pull request Aug 22, 2024
…ences (towards eventual encoder/decoder model support) (vllm-project#4942)

Co-authored-by: Andrew Feldman <[email protected]>
Co-authored-by: Nick Hill <[email protected]>
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
…ences (towards eventual encoder/decoder model support) (vllm-project#4942)

Co-authored-by: Andrew Feldman <[email protected]>
Co-authored-by: Nick Hill <[email protected]>
Signed-off-by: Alvant <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants