Repository navigation
perf(wan): XLA-fused RMSNorm + RoPE producer for self-attention Q/K #508
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
Open
Open
Changes from all commits
Commits
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 |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| """ | ||
| Copyright 2026 Google LLC | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| https://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| """ | ||
|
|
||
| """Optimized fused producers for Wan Attention.""" | ||
|
|
||
| import functools | ||
| from typing import Tuple | ||
|
|
||
| import jax | ||
| import jax.numpy as jnp | ||
|
|
||
|
|
||
| # Static (non-array) parameters of the producer. They select shapes/epsilons and | ||
| # must be compile-time constants so the jitted wrapper below can trace them. | ||
| _STATIC_ARGNAMES = ("q_heads", "kv_heads", "dim_head", "eps", "k_eps") | ||
|
|
||
|
|
||
| @functools.partial(jax.jit, static_argnames=_STATIC_ARGNAMES) | ||
| def fused_rmsnorm_rope( | ||
| raw_q: jax.Array, | ||
| raw_k: jax.Array, | ||
| q_norm_scale: jax.Array, | ||
| k_norm_scale: jax.Array, | ||
| freqs_cis: jax.Array, | ||
| q_heads: int, | ||
| kv_heads: int | None = None, | ||
| dim_head: int = 128, | ||
| eps: float = 1e-6, | ||
| k_eps: float | None = None, | ||
| ) -> Tuple[jax.Array, jax.Array]: | ||
| """XLA-fused FP32 RMSNorm + BF16 RoPE + Head Transposition producer. | ||
|
|
||
| Performs FP32 RMSNorm normalization for numerical stability, casts to input | ||
| dtype (e.g. BF16), and applies RoPE rotation and head transposition in input | ||
| dtype precision, avoiding FP32 RoPE intermediates on long sequence lengths. | ||
| Accepts an optional `kv_heads` for GQA (`kv_heads != q_heads`); defaults to | ||
| `q_heads` (MHA, as used by `FlaxWanAttention`). | ||
|
|
||
| The function is `jax.jit`-wrapped (shape/epsilon parameters static). Inside the | ||
| pipeline's outer jit this is inlined and changes nothing; when called eagerly | ||
| (e.g. a full-size transformer block exercised in a unit test without an outer | ||
| jit) it lets XLA fuse the normalize/rotate chain instead of materialising | ||
| every intermediate, which otherwise exceeds HBM on long sequences. | ||
|
|
||
| Args: | ||
| raw_q: Raw query projection of shape [B, Sq, Dq] (where Dq = q_heads * dim_head). | ||
| raw_k: Raw key projection of shape [B, Sk, Dk] (where Dk = kv_heads * dim_head). | ||
| q_norm_scale: RMSNorm scale parameter for query of shape [Dq]. | ||
| k_norm_scale: RMSNorm scale parameter for key of shape [Dk]. | ||
| freqs_cis: Complex rotary embedding tensor of shape [1, 1, S, dim_head // 2]. | ||
| q_heads: Number of query attention heads. | ||
| kv_heads: Number of key/value attention heads (defaults to q_heads for MHA). | ||
| dim_head: Dimension of each attention head. | ||
| eps: Epsilon for query RMSNorm numerical stability (and key if k_eps is None). | ||
| k_eps: Optional separate epsilon for key RMSNorm numerical stability. | ||
|
|
||
| Returns: | ||
| Transposed and RoPE-rotated (q_out, k_out) of shapes [B, q_heads, Sq, dim_head] | ||
| and [B, kv_heads, Sk, dim_head]. | ||
| """ | ||
| kv_heads = q_heads if kv_heads is None else kv_heads | ||
| effective_k_eps = eps if k_eps is None else k_eps | ||
| B, Sq, Dq = raw_q.shape | ||
| _, Sk, Dk = raw_k.shape | ||
|
|
||
| if Dq != q_heads * dim_head: | ||
| raise ValueError(f"raw_q feature dim ({Dq}) must equal q_heads ({q_heads}) * dim_head ({dim_head})") | ||
| if Dk != kv_heads * dim_head: | ||
| raise ValueError(f"raw_k feature dim ({Dk}) must equal kv_heads ({kv_heads}) * dim_head ({dim_head})") | ||
|
|
||
| # 1. FP32 RMSNorm for stability, then cast directly to target activation dtype. | ||
| # | ||
| # Association matters: Flax's `_normalize` computes `mul = rsqrt(var + eps)`, | ||
| # then `mul *= scale`, then `y = x * mul` -- i.e. x * (rsqrt * scale). Folding | ||
| # left-to-right as (x * rsqrt) * scale rounds differently and makes this path | ||
| # drift from `nnx.RMSNorm` bit-for-bit. Keep the parenthesisation below in | ||
| # step with Flax so the fused producer stays a pure fusion, not a numerical | ||
| # change. | ||
| q_fp32 = raw_q.astype(jnp.float32) | ||
| q_rms = jax.lax.rsqrt(jnp.mean(jnp.square(q_fp32), axis=-1, keepdims=True) + eps) | ||
| q_norm = (q_fp32 * (q_rms * q_norm_scale.astype(jnp.float32))).astype(raw_q.dtype) | ||
|
|
||
| k_fp32 = raw_k.astype(jnp.float32) | ||
| k_rms = jax.lax.rsqrt(jnp.mean(jnp.square(k_fp32), axis=-1, keepdims=True) + effective_k_eps) | ||
| k_norm = (k_fp32 * (k_rms * k_norm_scale.astype(jnp.float32))).astype(raw_k.dtype) | ||
|
|
||
| # 2. Reshape and transpose to [B, heads, S, dim_head] | ||
| q_h = q_norm.reshape(B, Sq, q_heads, dim_head).transpose(0, 2, 1, 3) | ||
| k_h = k_norm.reshape(B, Sk, kv_heads, dim_head).transpose(0, 2, 1, 3) | ||
|
|
||
| # 3. Direct RoPE with freqs_cis [1, 1, S, dim_head // 2] in input dtype | ||
| if freqs_cis.shape[2] != Sq or freqs_cis.shape[2] != Sk: | ||
| raise ValueError( | ||
| f"freqs_cis has {freqs_cis.shape[2]} positions, but raw_q/raw_k have Sq={Sq}, Sk={Sk}; " | ||
| "fused_rmsnorm_rope requires Sq == Sk == freqs_cis.shape[2]." | ||
| ) | ||
| cos = jnp.real(freqs_cis) | ||
| sin = jnp.imag(freqs_cis) | ||
| cos_q, sin_q = cos.astype(raw_q.dtype), sin.astype(raw_q.dtype) | ||
| cos_k, sin_k = cos.astype(raw_k.dtype), sin.astype(raw_k.dtype) | ||
|
|
||
| q_pairs = q_h.reshape(B, q_heads, Sq, -1, 2) | ||
| q_0, q_1 = q_pairs[..., 0], q_pairs[..., 1] | ||
| q_out_0 = q_0 * cos_q - q_1 * sin_q | ||
| q_out_1 = q_0 * sin_q + q_1 * cos_q | ||
| q_out = jnp.stack([q_out_0, q_out_1], axis=-1).reshape(B, q_heads, Sq, dim_head) | ||
|
|
||
| k_pairs = k_h.reshape(B, kv_heads, Sk, -1, 2) | ||
| k_0, k_1 = k_pairs[..., 0], k_pairs[..., 1] | ||
| k_out_0 = k_0 * cos_k - k_1 * sin_k | ||
| k_out_1 = k_0 * sin_k + k_1 * cos_k | ||
| k_out = jnp.stack([k_out_0, k_out_1], axis=-1).reshape(B, kv_heads, Sk, dim_head) | ||
|
|
||
| return q_out, k_out |
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.
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.
Could we add one module-level test for this branch? The new tests call
fused_rmsnorm_ropeagainst a copy of the RoPE math, so the wiring here (scale and epsilon reads,_unflatten_headson V) is untested. A tinyFlaxWanAttentionwithqk_normand randomrotary_emb, compared againstnorm_q/norm_k+_unflatten_heads+self._apply_rope, would pin it.