docs: document flash attention supports_mapping#46013
Open
nightcityblade wants to merge 1 commit into
Open
Conversation
stevhliu
approved these changes
May 18, 2026
| The maximum sequence length in the key/value tensor during a varlen forward. | ||
| Return: | ||
| supports_mapping (`dict[str, bool]`, *optional*): | ||
| Mapping indicating whether each flash attention feature is supported by the active backend. |
Member
There was a problem hiding this comment.
just specifying the wording a bit more :)
Suggested change
| Mapping indicating whether each flash attention feature is supported by the active backend. | |
| A dict containing the underlying information of the Flash Attention function on its supported parameters. Keys are all valid parameters (and alternative names) across all standards and values indicate whether each parameter could be found in the active backend's signature. For more information, please check `_lazy_define_process_function` that creates this mapping. |
Member
There was a problem hiding this comment.
updated to match the existing description
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Documents the
supports_mappingargument in_process_flash_attention_kwargsand fixes the docstring section heading fromReturntoReturns.Fixes #45995
Before submitting
Pull Request section?
to it if that's the case. Issue: docs: Add missing parameter documentation #45995
documentation guidelines, and
here are tips on formatting docstrings.
python3 -m py_compile src/transformers/modeling_flash_attention_utils.pyandpython3 -m ruff check src/transformers/modeling_flash_attention_utils.py.Who can review?
Documentation: @stevhliu
Attention: @vasqu @ArthurZucker @Cyrilvallez