|
| 1 | +"""KDA Path E adapter — wraps mlx-lm's gated_delta kernel (vectorised gate). |
| 2 | +
|
| 3 | +The same upstream Metal kernel (``mlx_lm/models/gated_delta.py``, |
| 4 | +``_make_gated_delta_kernel(vectorized=True)``) that powers GDN Path E also |
| 5 | +handles the per-K vectorised gate used by KDA-style attention — see |
| 6 | +``mlx_lm/models/kimi_linear.py::KimiDeltaAttention`` which calls |
| 7 | +``gated_delta_update`` with ``a_logits`` shaped ``[B, T, num_heads, head_dim]``. |
| 8 | +
|
| 9 | +The kernel selection happens automatically inside ``gated_delta_kernel``: |
| 10 | +when ``g.ndim == 4`` it picks ``_gated_delta_kernel_vec``; when ``g.ndim == 3`` |
| 11 | +it picks the scalar variant used by GDN. Group expansion (Hv > Hk) is also |
| 12 | +handled inside the kernel (``hk_idx = hv_idx / (Hv / Hk)``). |
| 13 | +
|
| 14 | +Our naive_recurrent_kda signature (FLA convention): |
| 15 | + naive_recurrent_kda(q, k, v, g, beta, scale=None, |
| 16 | + initial_state=None, output_final_state=False) |
| 17 | + -> (o, S) |
| 18 | + where: |
| 19 | + - q, k: [B, T, H, K] (un-repeated; HV/H expansion is kernel-side) |
| 20 | + - v: [B, T, HV, V] |
| 21 | + - g: [B, T, HV, K] (per-K log-decay; state is multiplied by exp(g)) |
| 22 | + - beta: [B, T, HV] |
| 23 | + - S: [B, HV, K, V] (FLA layout — K rows, V cols) |
| 24 | + FLA pre-scales q by 1/sqrt(K). |
| 25 | +
|
| 26 | +Upstream gated_delta_kernel signature: |
| 27 | + gated_delta_kernel(q, k, v, g, beta, state, mask=None) |
| 28 | + - q, k: [B, T, Hk, Dk] |
| 29 | + - v: [B, T, Hv, Dv] |
| 30 | + - g: [B, T, Hv, Dk] (vectorized) OR [B, T, Hv] (scalar) |
| 31 | + - beta: [B, T, Hv] (kernel applies it as-is, no sigmoid) |
| 32 | + - state: [B, Hv, Dv, Dk] (upstream layout — V rows, K cols; transposed vs FLA) |
| 33 | + Upstream does NOT pre-scale q. Decay is plain exp(g) where g is the value |
| 34 | + we pass in directly (kernel does ``state[i] = state[i] * g_[s_idx]``), |
| 35 | + so we pass ``g_decay = exp(our_g)`` directly here. |
| 36 | +
|
| 37 | +Constraints: |
| 38 | + - Upstream Metal kernel requires Dk % 32 == 0 and Dv % 4 == 0; smaller |
| 39 | + dims fall back to the pure-ops reference path. |
| 40 | +""" |
| 41 | + |
| 42 | +from __future__ import annotations |
| 43 | + |
| 44 | +import math |
| 45 | + |
| 46 | +import mlx.core as mx |
| 47 | + |
| 48 | +from cppmega_v4.nn._external._mlx_lm_gated_delta_vendored import ( |
| 49 | + gated_delta_kernel as _upstream_kernel, |
| 50 | + gated_delta_ops as _upstream_ops, |
| 51 | +) |
| 52 | + |
| 53 | + |
| 54 | +def kda_update( |
| 55 | + q: mx.array, |
| 56 | + k: mx.array, |
| 57 | + v: mx.array, |
| 58 | + g: mx.array, |
| 59 | + beta: mx.array, |
| 60 | + *, |
| 61 | + scale: float | None = None, |
| 62 | + initial_state: mx.array | None = None, |
| 63 | + output_final_state: bool = False, |
| 64 | +): |
| 65 | + """Path E entry — same signature as ``naive_recurrent_kda``. |
| 66 | +
|
| 67 | + Args: |
| 68 | + q, k: [B, T, H, K] (FLA convention; HV/H expansion is kernel-side) |
| 69 | + v: [B, T, HV, V] |
| 70 | + g: [B, T, HV, K] per-K log-decay (state *= exp(g) per step) |
| 71 | + beta: [B, T, HV] |
| 72 | + scale: optional — defaults to 1/sqrt(K) |
| 73 | + initial_state: optional [B, HV, K, V] |
| 74 | + output_final_state: if True, return (o, S_final[B, HV, K, V]) |
| 75 | +
|
| 76 | + Returns: |
| 77 | + (o[B, T, HV, V], S_final or None) |
| 78 | + """ |
| 79 | + if q.ndim != 4 or k.shape != q.shape: |
| 80 | + raise ValueError( |
| 81 | + f"q/k must be [B, T, H, K]; got q={q.shape}, k={k.shape}" |
| 82 | + ) |
| 83 | + if v.ndim != 4 or v.shape[:2] != q.shape[:2]: |
| 84 | + raise ValueError(f"v must be [B, T, HV, V]; got v={v.shape}") |
| 85 | + if g.shape != (*v.shape[:3], k.shape[-1]): |
| 86 | + raise ValueError( |
| 87 | + f"g must be [B, T, HV, K]; got g={g.shape}, expected {(*v.shape[:3], k.shape[-1])}" |
| 88 | + ) |
| 89 | + if beta.shape != v.shape[:3]: |
| 90 | + raise ValueError(f"beta must be [B, T, HV]; got beta={beta.shape}") |
| 91 | + |
| 92 | + b_size, t_size, h_size, kdim = q.shape |
| 93 | + hv_size, vdim = v.shape[2], v.shape[-1] |
| 94 | + if hv_size % h_size != 0: |
| 95 | + raise ValueError(f"HV ({hv_size}) must be divisible by H ({h_size})") |
| 96 | + |
| 97 | + # FLA pre-scales q by 1/sqrt(K); upstream does not. |
| 98 | + fla_scale = scale if scale is not None else 1.0 / math.sqrt(kdim) |
| 99 | + q_scaled = (q.astype(mx.float32) * fla_scale).astype(q.dtype) |
| 100 | + |
| 101 | + # Upstream kernel multiplies state by `g` as-is each step. FLA convention: |
| 102 | + # state is multiplied by `exp(g)`. Pre-exponentiate. |
| 103 | + g_decay = mx.exp(g.astype(mx.float32)) |
| 104 | + |
| 105 | + # Upstream state layout: [B, Hv, Dv, Dk]. FLA: [B, HV, K, V]. Transpose |
| 106 | + # last two axes when handing off. |
| 107 | + if initial_state is None: |
| 108 | + state = mx.zeros((b_size, hv_size, vdim, kdim), dtype=mx.float32) |
| 109 | + else: |
| 110 | + state = mx.transpose(initial_state.astype(mx.float32), (0, 1, 3, 2)) |
| 111 | + |
| 112 | + beta_f = beta.astype(mx.float32) |
| 113 | + |
| 114 | + # Upstream Metal kernel needs Dk % 32 == 0 and Dv % 4 == 0; otherwise |
| 115 | + # fall through to the pure-ops reference (which also handles vector-gate). |
| 116 | + use_kernel = (kdim % 32 == 0) and (vdim % 4 == 0) and mx.metal.is_available() |
| 117 | + |
| 118 | + if use_kernel: |
| 119 | + y, new_state = _upstream_kernel( |
| 120 | + q_scaled, k, v, g_decay, beta_f, state, mask=None, |
| 121 | + ) |
| 122 | + else: |
| 123 | + y, new_state = _upstream_ops( |
| 124 | + q_scaled, k, v, g_decay, beta_f, state, mask=None, |
| 125 | + ) |
| 126 | + |
| 127 | + final = None |
| 128 | + if output_final_state: |
| 129 | + # Convert back to FLA layout [B, HV, K, V]. |
| 130 | + final = mx.transpose(new_state, (0, 1, 3, 2)) |
| 131 | + return y, final |
| 132 | + |
| 133 | + |
| 134 | +__all__ = ["kda_update"] |
0 commit comments