docs(attention): document None default behavior in MultiHeadAttention layers - #5561
Open
Ultron09 wants to merge 1 commit into
Open
docs(attention): document None default behavior in MultiHeadAttention layers#5561Ultron09 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 #4182
In
MultiHeadAttentionandMultiHeadDotProductAttention(inflax.linen.attention) as well asMultiHeadAttention(inflax.nnx.nn.attention), several optional arguments default toNone, but their docstrings did not document the exact fallback evaluation behavior whenNoneis provided or left as default.This PR clarifies the
Nonedefault behavior for:qkv_features: defaults toinputs_q.shape[-1](in Linen) orin_features(in NNX).out_features: defaults toinputs_q.shape[-1](in Linen) orin_features(in NNX).deterministic: clarifies behavior whenNonevsdropout_rate > 0.0.precision: clarifies thatNoneuses the default JAX numerical precision.Checklist
cc @vfdev-5 @cgarciae for review.