-
Notifications
You must be signed in to change notification settings - Fork 3.1k
[Doc] Steps to add a new attention backend #8155
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -52,3 +52,31 @@ python3 -m sglang.launch_server --tp 8 --model deepseek-ai/DeepSeek-R1 --attenti | |||||
```bash | ||||||
python3 -m sglang.launch_server --model meta-llama/Meta-Llama-3.1-8B-Instruct --attention-backend ascend | ||||||
``` | ||||||
|
||||||
|
||||||
## Steps to add a new attention backend | ||||||
To add a new attention backend, you can learn from the existing backends | ||||||
(`python/sglang/srt/layers/attention/triton_backend.py`, `python/sglang/srt/layers/attention/flashattention_backend.py`) | ||||||
and follow the steps below. | ||||||
|
||||||
1. Run without cuda graph. Support the two forward functions | ||||||
- forward_extend | ||||||
- Will be used for prefill, prefill with KV cache, and target verification | ||||||
- It will be called once per layer | ||||||
- forward_decode | ||||||
- Will be used for normal decode, and draft decode | ||||||
- It will be called once per layer | ||||||
- init_forward_metadata | ||||||
- Initialize the class and common metadata shared by all layers | ||||||
- Call the plan function for optimizations like split_kv | ||||||
- It will be called once per forward | ||||||
2. Run with cuda graph. It has two phases (capture and replay) and you need to implement three functions | ||||||
- init_cuda_graph_state | ||||||
- It will be called once during life time | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||
- Create all common shared buffers | ||||||
- init_forward_metadata_capture_cuda_graph | ||||||
- It will be called before capturing a cuda graph | ||||||
- It is similar to init_forward_metadata but write the medatada to some pre-defined buffers | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's a typo in "medatada". It should be "metadata". Also, it's good practice to end sentences with a period.
Suggested change
|
||||||
- init_forward_metadata_replay_cuda_graph | ||||||
- It will be called before replaying a cuda graph | ||||||
- This function is in the critical path and needs to be fast |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading "Support the two forward functions" is a bit misleading as there are three functions listed below (
forward_extend
,forward_decode
, andinit_forward_metadata
). To improve clarity, I suggest rephrasing it to indicate that these are the functions to implement for running without a CUDA graph.