docs(attention): clarify make_causal_mask and make_attention_mask docstrings (#1520) - #5563
Open
Ultron09 wants to merge 1 commit into
Open
docs(attention): clarify make_causal_mask and make_attention_mask docstrings (#1520)#5563Ultron09 wants to merge 1 commit into
Ultron09 wants to merge 1 commit into
Conversation
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?
Fixes #1520
The
make_causal_maskandmake_attention_maskfunctions generate masks of shape[batch..., 1, len_q, len_kv]for multi-head attention. However, users frequently pass embedded feature arrays ([batch..., len, num_features]) instead of sequence arrays ([batch..., len]), causing the sequence length to erroneously bind tonum_features.This PR:
flax.linen.attentionandflax.nnx.nn.attentionwith explicit shape explanations, notes on un-embedded slices vs embedded feature inputs, and how the singleton dimension broadcasts across attention heads.make_attention_maskandmake_causal_maskfor both token IDs and embedded inputs.Checklist
doctest(passed all 90 attempted tests across Linen & NNX attention modules).cc @marcvanzee @vfdev-5 for review.