@mlx-bun/inference 0.0.0-stage → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (467) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +1475 -2
  3. package/THIRD_PARTY_NOTICES.md +3404 -0
  4. package/dist/native/libmlx_bun_ane.dylib +0 -0
  5. package/dist/native/libmlx_bun_expert_io.dylib +0 -0
  6. package/dist/native/mlx-bun-frame-extract +0 -0
  7. package/examples/fit-model.ts +25 -0
  8. package/examples/qwen3-forward.ts +42 -0
  9. package/examples/qwen3-generate.ts +28 -0
  10. package/examples/trellis-expand.ts +23 -0
  11. package/package.json +129 -4
  12. package/src/adapters/available.ts +110 -0
  13. package/src/adapters/index.ts +3 -0
  14. package/src/adapters/manager.ts +316 -0
  15. package/src/artifacts/auxiliary-files.ts +45 -0
  16. package/src/artifacts/config-dialects.ts +94 -0
  17. package/src/artifacts/config.ts +341 -0
  18. package/src/artifacts/draft-vocabulary.ts +30 -0
  19. package/src/artifacts/expert-offload-build.ts +75 -0
  20. package/src/artifacts/expert-offload.ts +89 -0
  21. package/src/artifacts/experts/index.ts +3 -0
  22. package/src/artifacts/experts/io.ts +386 -0
  23. package/src/artifacts/experts/residency.ts +1134 -0
  24. package/src/artifacts/experts/usage.ts +415 -0
  25. package/src/artifacts/fingerprint.ts +44 -0
  26. package/src/artifacts/glm52/container.ts +305 -0
  27. package/src/artifacts/glm52/expert-layout.ts +249 -0
  28. package/src/artifacts/glm52/index.ts +7 -0
  29. package/src/artifacts/glm52/kernel-layout.ts +124 -0
  30. package/src/artifacts/glm52/layout.ts +152 -0
  31. package/src/artifacts/glm52/memory.ts +500 -0
  32. package/src/artifacts/glm52/resident-weights.ts +135 -0
  33. package/src/artifacts/glm52/weights.ts +503 -0
  34. package/src/artifacts/glm52-config.ts +262 -0
  35. package/src/artifacts/identity.ts +94 -0
  36. package/src/artifacts/index.ts +15 -0
  37. package/src/artifacts/mmap.ts +90 -0
  38. package/src/artifacts/safetensors-writer.ts +249 -0
  39. package/src/artifacts/safetensors.ts +164 -0
  40. package/src/artifacts/turboquant-fold.ts +42 -0
  41. package/src/artifacts/weight-audit.ts +43 -0
  42. package/src/artifacts/weights.ts +255 -0
  43. package/src/contracts/index.ts +2 -0
  44. package/src/contracts/mlx/attention.ts +8 -0
  45. package/src/contracts/mlx/cache.ts +510 -0
  46. package/src/contracts/mlx/checkpoint.ts +10 -0
  47. package/src/contracts/mlx/draft-checkpoint.ts +14 -0
  48. package/src/contracts/mlx/draft-projection.ts +27 -0
  49. package/src/contracts/mlx/draft-target.ts +84 -0
  50. package/src/contracts/mlx/drafter.ts +176 -0
  51. package/src/contracts/mlx/forward-work.ts +23 -0
  52. package/src/contracts/mlx/glm52-weights.ts +25 -0
  53. package/src/contracts/mlx/graph.ts +309 -0
  54. package/src/contracts/mlx/head.ts +6 -0
  55. package/src/contracts/mlx/index.ts +15 -0
  56. package/src/contracts/mlx/kv-codec.ts +9 -0
  57. package/src/contracts/mlx/media.ts +113 -0
  58. package/src/contracts/mlx/positions.ts +16 -0
  59. package/src/contracts/mlx/row-table.ts +2 -0
  60. package/src/contracts/mlx/trainable.ts +103 -0
  61. package/src/contracts/mlx/whisper.ts +96 -0
  62. package/src/contracts/portable/composition.ts +106 -0
  63. package/src/contracts/portable/denoising.ts +17 -0
  64. package/src/contracts/portable/execution.ts +79 -0
  65. package/src/contracts/portable/generation.ts +103 -0
  66. package/src/contracts/portable/graph.ts +80 -0
  67. package/src/contracts/portable/index.ts +15 -0
  68. package/src/contracts/portable/memory-plan.ts +26 -0
  69. package/src/contracts/portable/object-cache.ts +8 -0
  70. package/src/contracts/portable/prefill.ts +63 -0
  71. package/src/contracts/portable/prefix-cache.ts +33 -0
  72. package/src/contracts/portable/prompt.ts +2 -0
  73. package/src/contracts/portable/resources.ts +25 -0
  74. package/src/contracts/portable/rollback.ts +7 -0
  75. package/src/contracts/portable/sampling.ts +44 -0
  76. package/src/contracts/portable/scheduling.ts +54 -0
  77. package/src/contracts/portable/token-delivery.ts +4 -0
  78. package/src/contracts/portable/tsconfig.json +14 -0
  79. package/src/embeddings/index.ts +1 -0
  80. package/src/embeddings/text.ts +85 -0
  81. package/src/execution/admission.ts +59 -0
  82. package/src/execution/batch-group.ts +1240 -0
  83. package/src/execution/batch-types.ts +225 -0
  84. package/src/execution/cancellation.ts +38 -0
  85. package/src/execution/continuation-request.ts +45 -0
  86. package/src/execution/continuation-types.ts +10 -0
  87. package/src/execution/coordinator.ts +70 -0
  88. package/src/execution/denoising-group.ts +180 -0
  89. package/src/execution/engine.ts +56 -0
  90. package/src/execution/fill-group.ts +505 -0
  91. package/src/execution/fit.ts +184 -0
  92. package/src/execution/gateway-binding.ts +178 -0
  93. package/src/execution/grammar-group.ts +224 -0
  94. package/src/execution/index.ts +18 -0
  95. package/src/execution/methods.ts +75 -0
  96. package/src/execution/mixed-iteration.ts +96 -0
  97. package/src/execution/plan.ts +65 -0
  98. package/src/execution/prefill-cohort.ts +100 -0
  99. package/src/execution/prefill-rows.ts +263 -0
  100. package/src/execution/request-policy.ts +19 -0
  101. package/src/execution/row-sampling.ts +49 -0
  102. package/src/execution/scheduler.ts +92 -0
  103. package/src/execution/session.ts +247 -0
  104. package/src/execution/speculative-group.ts +797 -0
  105. package/src/execution/tasks.ts +44 -0
  106. package/src/generation/autoregressive.ts +840 -0
  107. package/src/generation/bindings/autoregressive.ts +104 -0
  108. package/src/generation/bindings/denoising.ts +60 -0
  109. package/src/generation/bindings/prefill-policy.ts +36 -0
  110. package/src/generation/checkpoint-identity.ts +60 -0
  111. package/src/generation/denoising.ts +85 -0
  112. package/src/generation/diffusion.ts +583 -0
  113. package/src/generation/fill/echo-index.ts +188 -0
  114. package/src/generation/fill/index.ts +3 -0
  115. package/src/generation/fill/proposal.ts +69 -0
  116. package/src/generation/fill/schema-rows.ts +506 -0
  117. package/src/generation/fill/session.ts +464 -0
  118. package/src/generation/fill/tool-boundary.ts +103 -0
  119. package/src/generation/fill-append.ts +58 -0
  120. package/src/generation/generate.ts +44 -0
  121. package/src/generation/grammar-step.ts +39 -0
  122. package/src/generation/index.ts +14 -0
  123. package/src/generation/phase-dispatch.ts +115 -0
  124. package/src/generation/prefill.ts +33 -0
  125. package/src/generation/result.ts +49 -0
  126. package/src/generation/scopes.ts +157 -0
  127. package/src/generation/speculative/acceptance.ts +41 -0
  128. package/src/generation/speculative/adaptive-draft-gate.ts +166 -0
  129. package/src/generation/speculative/bindings/assistant-rows.ts +102 -0
  130. package/src/generation/speculative/bindings/autoregressive-rows.ts +124 -0
  131. package/src/generation/speculative/bindings/binding.ts +106 -0
  132. package/src/generation/speculative/bindings/deepspec-rows.ts +33 -0
  133. package/src/generation/speculative/bindings/draft-target.ts +10 -0
  134. package/src/generation/speculative/bindings/glm52-mtp-rows.ts +128 -0
  135. package/src/generation/speculative/bindings/projected-context-rows.ts +78 -0
  136. package/src/generation/speculative/bindings/projected-draft-rows.ts +95 -0
  137. package/src/generation/speculative/bindings/qwen-mtp-rows.ts +336 -0
  138. package/src/generation/speculative/bindings/two-model-rows.ts +63 -0
  139. package/src/generation/speculative/cache-identity.ts +16 -0
  140. package/src/generation/speculative/draft-kind.ts +149 -0
  141. package/src/generation/speculative/draft-policy.ts +41 -0
  142. package/src/generation/speculative/draft-registry.ts +118 -0
  143. package/src/generation/speculative/draft-vocab.ts +110 -0
  144. package/src/generation/speculative/index.ts +17 -0
  145. package/src/generation/speculative/output.ts +49 -0
  146. package/src/generation/speculative/round.ts +307 -0
  147. package/src/generation/speculative/source.ts +144 -0
  148. package/src/generation/speculative/sources/assistant-source.ts +64 -0
  149. package/src/generation/speculative/sources/deepspec-source.ts +70 -0
  150. package/src/generation/speculative/sources/dflash-source.ts +84 -0
  151. package/src/generation/speculative/sources/dflash2-source.ts +86 -0
  152. package/src/generation/speculative/sources/glm52-mtp-source.ts +66 -0
  153. package/src/generation/speculative/sources/ngram-source.ts +165 -0
  154. package/src/generation/speculative/sources/qwen-mtp-source.ts +154 -0
  155. package/src/generation/speculative/sources/two-model.ts +75 -0
  156. package/src/generation/types.ts +194 -0
  157. package/src/index.ts +20 -0
  158. package/src/input/audio/audiotoolbox.ts +112 -0
  159. package/src/input/audio/decode.ts +133 -0
  160. package/src/input/audio/features.ts +202 -0
  161. package/src/input/audio/index.ts +6 -0
  162. package/src/input/audio/transcode.ts +67 -0
  163. package/src/input/audio/whisper-mel.ts +185 -0
  164. package/src/input/audio/whisper-tokenizer.ts +238 -0
  165. package/src/input/chat-template.ts +389 -0
  166. package/src/input/index.ts +6 -0
  167. package/src/input/media-fetch.ts +439 -0
  168. package/src/input/packed-mixed.ts +43 -0
  169. package/src/input/special-tokens.ts +75 -0
  170. package/src/input/token-groups.ts +49 -0
  171. package/src/input/tokenizer.ts +336 -0
  172. package/src/input/tool-call.ts +689 -0
  173. package/src/input/vision/index.ts +3 -0
  174. package/src/input/vision/preprocess.ts +247 -0
  175. package/src/input/vision/prompt.ts +398 -0
  176. package/src/input/vision/qwen3vl-preprocess.ts +409 -0
  177. package/src/input/vision/qwen3vl-prompt.ts +237 -0
  178. package/src/input/vision/video-frames.ts +100 -0
  179. package/src/kernels/ane/fill.ts +101 -0
  180. package/src/kernels/ane/linear.ts +416 -0
  181. package/src/kernels/attention/flash.ts +694 -0
  182. package/src/kernels/attention/kvq4-decode.ts +155 -0
  183. package/src/kernels/attention/masks.ts +40 -0
  184. package/src/kernels/attention/multi-query.ts +193 -0
  185. package/src/kernels/attention/paged.ts +130 -0
  186. package/src/kernels/delta/gated.ts +306 -0
  187. package/src/kernels/delta/index.ts +3 -0
  188. package/src/kernels/delta/silu-rms-heads.ts +69 -0
  189. package/src/kernels/delta/state.ts +74 -0
  190. package/src/kernels/gated-rms-norm.ts +64 -0
  191. package/src/kernels/glm52/layout.ts +37 -0
  192. package/src/kernels/glm52/streamed-experts.ts +360 -0
  193. package/src/kernels/logits.ts +38 -0
  194. package/src/kernels/quantization/affine-row.ts +154 -0
  195. package/src/kernels/quantization/affine-rows.ts +36 -0
  196. package/src/kernels/quantization/affine-split-mma.ts +144 -0
  197. package/src/kernels/quantization/affine3-mma.ts +117 -0
  198. package/src/kernels/quantization/affine3-rows.ts +103 -0
  199. package/src/kernels/quantization/affine4-mma.ts +113 -0
  200. package/src/kernels/quantization/affine4-rows.ts +102 -0
  201. package/src/kernels/residual-rms-norm.ts +65 -0
  202. package/src/kernels/sampling/index.ts +2 -0
  203. package/src/kernels/sampling/normalized-argmax.ts +116 -0
  204. package/src/kernels/sampling/token-bitmask.ts +52 -0
  205. package/src/kernels/softcap.ts +35 -0
  206. package/src/kernels/trellis/codebook.ts +123 -0
  207. package/src/kernels/trellis/down-codebook.ts +184 -0
  208. package/src/kernels/trellis/down-factored.ts +180 -0
  209. package/src/kernels/trellis/down-k3-interleaved-factored.ts +146 -0
  210. package/src/kernels/trellis/down-mma-wide.ts +195 -0
  211. package/src/kernels/trellis/down-mma.ts +145 -0
  212. package/src/kernels/trellis/expand.ts +42 -0
  213. package/src/kernels/trellis/gate-up-codebook-mma.ts +141 -0
  214. package/src/kernels/trellis/gate-up-codebook.ts +137 -0
  215. package/src/kernels/trellis/gate-up-factored.ts +197 -0
  216. package/src/kernels/trellis/gate-up-mma-wide.ts +147 -0
  217. package/src/kernels/trellis/gate-up-mma.ts +148 -0
  218. package/src/kernels/trellis/gate-up.ts +248 -0
  219. package/src/kernels/trellis/geometry.ts +22 -0
  220. package/src/kernels/trellis/index.ts +103 -0
  221. package/src/kernels/trellis/launch.ts +12 -0
  222. package/src/kernels/trellis/mixed-gate-up-factored.ts +119 -0
  223. package/src/kernels/trellis/mixed-gate-up.ts +146 -0
  224. package/src/kernels/trellis/qualified.ts +34 -0
  225. package/src/kernels/trellis/reduce.ts +150 -0
  226. package/src/kernels/trellis/scatter.ts +407 -0
  227. package/src/kernels/trellis/splitk-prefill.ts +152 -0
  228. package/src/kernels/trellis/tiled-prefill.ts +131 -0
  229. package/src/kernels/trellis/vector-expand.ts +58 -0
  230. package/src/kernels/trellis/wide-prefill.ts +89 -0
  231. package/src/kernels/turboquant/decode.ts +82 -0
  232. package/src/kernels/turboquant/index.ts +5 -0
  233. package/src/kernels/turboquant/inverse.ts +122 -0
  234. package/src/kernels/turboquant/ops.ts +860 -0
  235. package/src/kernels/turboquant/signs.ts +130 -0
  236. package/src/kernels/turboquant/tables.ts +124 -0
  237. package/src/layers/affine-verify-linear.ts +75 -0
  238. package/src/layers/ane-prefill-split.ts +283 -0
  239. package/src/layers/compiled-normalization.ts +41 -0
  240. package/src/layers/delta-heads.ts +23 -0
  241. package/src/layers/dense-embedding.ts +29 -0
  242. package/src/layers/dense-linear.ts +32 -0
  243. package/src/layers/dequantized-linear.ts +72 -0
  244. package/src/layers/folded-attention.ts +42 -0
  245. package/src/layers/geglu.ts +130 -0
  246. package/src/layers/helpers.ts +7 -0
  247. package/src/layers/index.ts +36 -0
  248. package/src/layers/kv4-decode-attention.ts +15 -0
  249. package/src/layers/layer-norm.ts +24 -0
  250. package/src/layers/loading.ts +92 -0
  251. package/src/layers/lora.ts +150 -0
  252. package/src/layers/normalization.ts +9 -0
  253. package/src/layers/prefix-layout.ts +33 -0
  254. package/src/layers/quantized-append-attention.ts +32 -0
  255. package/src/layers/quantized-attention.ts +353 -0
  256. package/src/layers/quantized-embedding.ts +39 -0
  257. package/src/layers/quantized-linear.ts +137 -0
  258. package/src/layers/quantized-switch-linear.ts +37 -0
  259. package/src/layers/qwen-append.ts +12 -0
  260. package/src/layers/qwen-mrope.ts +238 -0
  261. package/src/layers/rope-2d.ts +110 -0
  262. package/src/layers/rope.ts +389 -0
  263. package/src/layers/swiglu.ts +23 -0
  264. package/src/layers/trellis-codebook-down.ts +52 -0
  265. package/src/layers/trellis-codebook-gate-up.ts +42 -0
  266. package/src/layers/trellis-down.ts +117 -0
  267. package/src/layers/trellis-gate-up.ts +71 -0
  268. package/src/layers/trellis-linear.ts +211 -0
  269. package/src/layers/trellis-prompt.ts +102 -0
  270. package/src/layers/trellis-reduce-gate-up.ts +73 -0
  271. package/src/layers/trellis-scatter-down.ts +98 -0
  272. package/src/models/ane-install.ts +74 -0
  273. package/src/models/audio/conformer.ts +656 -0
  274. package/src/models/cache-composition.ts +44 -0
  275. package/src/models/capabilities.ts +89 -0
  276. package/src/models/chat-template.ts +10 -0
  277. package/src/models/composition.ts +107 -0
  278. package/src/models/diffusion-gemma/experts.ts +59 -0
  279. package/src/models/diffusion-gemma/family.ts +21 -0
  280. package/src/models/diffusion-gemma/model.ts +900 -0
  281. package/src/models/diffusion-gemma/vision.ts +549 -0
  282. package/src/models/drafter-loaders.ts +49 -0
  283. package/src/models/drafters.ts +39 -0
  284. package/src/models/factory.ts +351 -0
  285. package/src/models/families.ts +70 -0
  286. package/src/models/family.ts +125 -0
  287. package/src/models/gemma4/assistant-target.ts +46 -0
  288. package/src/models/gemma4/assistant.ts +327 -0
  289. package/src/models/gemma4/blocks.ts +755 -0
  290. package/src/models/gemma4/compiled-decode.ts +452 -0
  291. package/src/models/gemma4/family.ts +39 -0
  292. package/src/models/gemma4/gemma4-12b.ts +677 -0
  293. package/src/models/gemma4/gemma4-26b.ts +544 -0
  294. package/src/models/gemma4/gemma4-e4b.ts +599 -0
  295. package/src/models/gemma4/graphs.ts +147 -0
  296. package/src/models/gemma4/media.ts +88 -0
  297. package/src/models/gemma4/model.ts +860 -0
  298. package/src/models/gemma4/serving-blocks.ts +72 -0
  299. package/src/models/gemma4/trainable.ts +186 -0
  300. package/src/models/gemma4/written-blocks.ts +232 -0
  301. package/src/models/gemma4/written-forward.ts +159 -0
  302. package/src/models/gemma4/written-input.ts +29 -0
  303. package/src/models/glm52/atlas.ts +507 -0
  304. package/src/models/glm52/coupling.ts +388 -0
  305. package/src/models/glm52/dsa.ts +601 -0
  306. package/src/models/glm52/family.ts +20 -0
  307. package/src/models/glm52/mla.ts +812 -0
  308. package/src/models/glm52/model.ts +1127 -0
  309. package/src/models/glm52/moe.ts +223 -0
  310. package/src/models/glm52/mtp.ts +60 -0
  311. package/src/models/glm52/pilot.ts +537 -0
  312. package/src/models/glm52/reference.ts +445 -0
  313. package/src/models/glm52/residency.ts +557 -0
  314. package/src/models/glm52/streamed-experts.ts +447 -0
  315. package/src/models/graph.ts +59 -0
  316. package/src/models/implementation.ts +230 -0
  317. package/src/models/index.ts +15 -0
  318. package/src/models/media-input.ts +15 -0
  319. package/src/models/memory-plan.ts +39 -0
  320. package/src/models/minicpm5/family.ts +29 -0
  321. package/src/models/minicpm5/model.ts +394 -0
  322. package/src/models/minicpm5/trainable.ts +90 -0
  323. package/src/models/profile.ts +337 -0
  324. package/src/models/qwen/blocks.ts +658 -0
  325. package/src/models/qwen/checkpoint.ts +190 -0
  326. package/src/models/qwen/families.ts +57 -0
  327. package/src/models/qwen/media-input.ts +161 -0
  328. package/src/models/qwen/mtp.ts +101 -0
  329. package/src/models/qwen/qwen3-moe.ts +355 -0
  330. package/src/models/qwen/qwen3.ts +323 -0
  331. package/src/models/qwen/qwen38-27b-trellis-m1max.ts +1532 -0
  332. package/src/models/qwen/qwen38-27b-trellis-m4pro.ts +1092 -0
  333. package/src/models/qwen/qwen3_5.ts +433 -0
  334. package/src/models/qwen/written-layers.ts +285 -0
  335. package/src/models/row-table.ts +1 -0
  336. package/src/models/runtime.ts +73 -0
  337. package/src/models/speculative/deepspec-artifact.ts +10 -0
  338. package/src/models/speculative/deepspec.ts +744 -0
  339. package/src/models/speculative/dflash.ts +553 -0
  340. package/src/models/speculative/dflash2-artifact.ts +9 -0
  341. package/src/models/speculative/dflash2-operations.ts +1 -0
  342. package/src/models/speculative/dflash2.ts +576 -0
  343. package/src/models/speculative/loader.ts +29 -0
  344. package/src/models/support.ts +79 -0
  345. package/src/models/universal/archs.ts +365 -0
  346. package/src/models/universal/blocks.ts +479 -0
  347. package/src/models/universal/dense.ts +255 -0
  348. package/src/models/universal/family.ts +17 -0
  349. package/src/models/vision/qwen3vl.ts +566 -0
  350. package/src/models/vision/siglip.ts +520 -0
  351. package/src/models/vision/unified.ts +176 -0
  352. package/src/models/whisper/family.ts +19 -0
  353. package/src/models/whisper/fast.ts +734 -0
  354. package/src/models/whisper/model.ts +430 -0
  355. package/src/runtime/compiled-trace.ts +16 -0
  356. package/src/runtime/config.ts +77 -0
  357. package/src/runtime/expert-trace.ts +71 -0
  358. package/src/runtime/graph-forward.ts +65 -0
  359. package/src/runtime/integers.ts +6 -0
  360. package/src/runtime/native.ts +16 -0
  361. package/src/runtime/resources.ts +53 -0
  362. package/src/runtime/row-operations.ts +42 -0
  363. package/src/runtime/trace.ts +161 -0
  364. package/src/sampling/curve.ts +122 -0
  365. package/src/sampling/draft.ts +55 -0
  366. package/src/sampling/extras.ts +45 -0
  367. package/src/sampling/filters.ts +134 -0
  368. package/src/sampling/grammar.ts +630 -0
  369. package/src/sampling/hlg.ts +290 -0
  370. package/src/sampling/index.ts +9 -0
  371. package/src/sampling/processors.ts +142 -0
  372. package/src/sampling/sampler.ts +120 -0
  373. package/src/sampling/step.ts +343 -0
  374. package/src/sampling/types.ts +161 -0
  375. package/src/sampling/window-filters.ts +46 -0
  376. package/src/scoring/decisions.ts +96 -0
  377. package/src/scoring/full-sequence.ts +103 -0
  378. package/src/scoring/index.ts +9 -0
  379. package/src/scoring/kl.ts +29 -0
  380. package/src/scoring/perplexity.ts +165 -0
  381. package/src/scoring/response-logps.ts +65 -0
  382. package/src/state/affine-attention.ts +180 -0
  383. package/src/state/attachment.ts +68 -0
  384. package/src/state/attention-read.ts +215 -0
  385. package/src/state/batched-kv.ts +294 -0
  386. package/src/state/batched-mask.ts +445 -0
  387. package/src/state/batched-quant.ts +389 -0
  388. package/src/state/batched-quantized-kv.ts +209 -0
  389. package/src/state/batched-rotating-quant.ts +457 -0
  390. package/src/state/batched-rotating-state.ts +149 -0
  391. package/src/state/batched-rotating.ts +430 -0
  392. package/src/state/batched-row-storage.ts +179 -0
  393. package/src/state/batched-ssm.ts +54 -0
  394. package/src/state/batched-turboquant-kv.ts +144 -0
  395. package/src/state/bf16-first-kv.ts +663 -0
  396. package/src/state/cache-service.ts +592 -0
  397. package/src/state/capabilities.ts +65 -0
  398. package/src/state/checkpoint.ts +46 -0
  399. package/src/state/continuation-persistence.ts +126 -0
  400. package/src/state/decode-step-inputs.ts +31 -0
  401. package/src/state/decoded-kv-donor.ts +12 -0
  402. package/src/state/delayed-quantized-kv.ts +141 -0
  403. package/src/state/delayed-rotating-quantized-kv.ts +178 -0
  404. package/src/state/delayed-turboquant-kv.ts +123 -0
  405. package/src/state/durability.ts +214 -0
  406. package/src/state/encoder-cache.ts +26 -0
  407. package/src/state/full-kv-row-append.ts +33 -0
  408. package/src/state/full-kv-row-donor.ts +54 -0
  409. package/src/state/full-prefill-padding.ts +56 -0
  410. package/src/state/full-prefill-row.ts +112 -0
  411. package/src/state/full-transitioning-kv-rows.ts +70 -0
  412. package/src/state/glm52-cache.ts +783 -0
  413. package/src/state/grouped-heads-kv4-cache.ts +26 -0
  414. package/src/state/index.ts +38 -0
  415. package/src/state/kv-attention-view.ts +77 -0
  416. package/src/state/kv-budget.ts +14 -0
  417. package/src/state/kv-scheme.ts +315 -0
  418. package/src/state/kv-storage.ts +57 -0
  419. package/src/state/kv-tensor-rows.ts +212 -0
  420. package/src/state/kv.ts +324 -0
  421. package/src/state/kv4-head256-cache.ts +46 -0
  422. package/src/state/latent-legos.ts +895 -0
  423. package/src/state/layout.ts +277 -0
  424. package/src/state/leases.ts +26 -0
  425. package/src/state/paged/cache.ts +689 -0
  426. package/src/state/paged/codec.ts +36 -0
  427. package/src/state/paged/rows.ts +223 -0
  428. package/src/state/persistence-types.ts +173 -0
  429. package/src/state/persistence-worker.ts +83 -0
  430. package/src/state/persistence.ts +1036 -0
  431. package/src/state/persistence.worker.d.ts +3 -0
  432. package/src/state/persistence.worker.js +264 -0
  433. package/src/state/prefix-cache.ts +685 -0
  434. package/src/state/quantized-kv.ts +369 -0
  435. package/src/state/quantized-tensor.ts +26 -0
  436. package/src/state/request-policy.ts +48 -0
  437. package/src/state/retention-policy.ts +37 -0
  438. package/src/state/rollback.ts +131 -0
  439. package/src/state/rotating-kv-donor.ts +35 -0
  440. package/src/state/rotating-kv-layout.ts +341 -0
  441. package/src/state/rotating-kv.ts +529 -0
  442. package/src/state/rotating-quantized-kv.ts +616 -0
  443. package/src/state/rotating-row-transaction.ts +35 -0
  444. package/src/state/rows.ts +104 -0
  445. package/src/state/softcap-attention.ts +118 -0
  446. package/src/state/speculative/glm52-mtp-state.ts +38 -0
  447. package/src/state/speculative/qwen-mtp-state.ts +34 -0
  448. package/src/state/speculative-rotating-kv.ts +113 -0
  449. package/src/state/ssd-cache.ts +434 -0
  450. package/src/state/ssm-prefill-padding.ts +39 -0
  451. package/src/state/ssm.ts +422 -0
  452. package/src/state/target-layout.ts +7 -0
  453. package/src/state/tiered-prefix-cache.ts +45 -0
  454. package/src/state/training-cache.ts +300 -0
  455. package/src/state/transitioning-kv-rows.ts +267 -0
  456. package/src/state/turboquant-attention.ts +97 -0
  457. package/src/state/turboquant-codec.ts +90 -0
  458. package/src/state/turboquant-kv.ts +442 -0
  459. package/src/state/views.ts +26 -0
  460. package/src/transcription/index.ts +3 -0
  461. package/src/transcription/silero-vad.ts +379 -0
  462. package/src/transcription/whisper/decode.ts +773 -0
  463. package/src/transcription/whisper/format.ts +74 -0
  464. package/src/transcription/whisper/index.ts +4 -0
  465. package/src/transcription/whisper/timing.ts +274 -0
  466. package/src/transcription/whisper/transcribe.ts +394 -0
  467. package/src/transcription/whisper/types.ts +22 -0
@@ -0,0 +1,457 @@
1
+ // Batched sliding-window QUANTIZED KV — the composition that lets a
2
+ // per-layer kv_config naming ROTATING layers (gemma) batch. No stack ships
3
+ // this (mlx-lm's batched path is bf16-only; optiq's mixed-KV hook is
4
+ // serial-only), so per the composition rule the oracle is the SERIAL
5
+ // RotatingQuantizedKVCache per row: each joiner's prefill alone converts through
6
+ // its bf16-first lego, and this class only
7
+ // re-arranges those bytes across the batch axis + runs the mlx-lm
8
+ // BatchRotatingKVCache ring mechanics (batched-rotating.ts) over
9
+ // (packed, scales, biases) triples instead of bf16 tensors.
10
+ //
11
+ // Same safety argument as batched-quant.ts: quantization packs along
12
+ // HEAD_DIM, so the token axis stays token-granular in all three tensors —
13
+ // left-pad columns are zeros, masked by buildBatchedRotatingMask (token-axis
14
+ // only; shared verbatim with the bf16 twin), never dequantized into anything
15
+ // a real row reads.
16
+ //
17
+ // Subclasses RotatingQuantizedKVCache so Attention.forward's `instanceof`
18
+ // dispatch (packages/inference/src/models/gemma4/model.ts) routes to the quantized path with the L1 model file
19
+ // untouched. PERSISTENT (like BatchedRotatingCache, unlike the ephemeral
20
+ // per-step BatchedQuantDecodeMaskCache): the scheduler passes it through
21
+ // every step; it self-tracks per-row offset/leftPad and the scalar ring
22
+ // state. Multi-token blocks use the same chronological storage operation as
23
+ // the bf16 layout; one-token updates keep the existing in-place ring kernel.
24
+ //
25
+ // Gates: packages/inference/tests/state/batched-rotating-quant.test.ts (model-free byte-identity vs
26
+ // the serial oracle per row, through ring wrap, B=1 and B=2) + the gemma
27
+ // scheduler gate in `02d723a:tests/parity/batched-kv-quant-parity.test.ts`.
28
+
29
+ import { MlxArray } from "@mlx-bun/mlx/array";
30
+ import * as ops from "@mlx-bun/mlx/ops";
31
+ import { Dtype } from "@mlx-bun/mlx/ffi";
32
+ import { RotatingQuantizedKVCache } from "./rotating-quantized-kv";
33
+ import { type AttentionRead, type BatchableCache, type Cache, type Mask, type PaddedPrefillCache, type PrefillPadding } from "../contracts/mlx/cache";
34
+ import { buildBatchedRotatingMask } from "./batched-rotating";
35
+ import { AttentionMasks, withLease, type MaskLease } from "./attention-read";
36
+ import { affineRead, type AffineKernel, type AffineKernels } from "./affine-attention";
37
+ import { isRotatingQuantizedCache } from "./capabilities";
38
+ import type { QuantRow } from "./batched-quant";
39
+ import { BatchedRotatingState, type RotatingPositionSnapshot } from "./batched-rotating-state";
40
+ import {
41
+ appendRotatingStorage,
42
+ rowRollIndices,
43
+ mergeStorageRows,
44
+ quantizedRowStorage,
45
+ temporalStorageView,
46
+ } from "./batched-row-storage";
47
+
48
+ const STEP = 256; // shared with RotatingQuantizedKVCache.STEP and the bf16 twin
49
+
50
+ const disposeTriple = (t: ops.QuantizedTensor): void => {
51
+ t.packed.dispose();
52
+ t.scales.dispose();
53
+ t.biases.dispose();
54
+ };
55
+ const mapTriple = (
56
+ t: ops.QuantizedTensor, f: (a: MlxArray) => MlxArray,
57
+ ): ops.QuantizedTensor => ({ packed: f(t.packed), scales: f(t.scales), biases: f(t.biases) });
58
+
59
+ /** Batched ring over quantized triples — mlx-lm BatchRotatingKVCache
60
+ * mechanics (see batched-rotating.ts) with RotatingQuantizedKVCache
61
+ * storage. Scalar ring state (`ringIdx`/`offset` reuse the base fields);
62
+ * per-row `offsetArr` (absolute positions → RoPE) and `leftPad`.
63
+ *
64
+ * Reads: the sliding window is `maxSize`. Decode, which runs with no prefill
65
+ * padding pending (finalize first), writes one position in place at the ring
66
+ * head; a window writes by concatenation, which also serves padded prefill
67
+ * chunks. Each attends under mlx-lm's batched rotating mask
68
+ * (`buildBatchedRotatingMask`) for its write, built once per forward through
69
+ * `masks`, with the decode and masked-window kernels of `kernels`: that mask
70
+ * is always an array, which `quantizedSdpa` never tiles, so the unfused
71
+ * kernel both composed sets hold there is what every configuration computes
72
+ * today. A row it extracts attends alone with the same `kernels`. The
73
+ * deprecated `updateAndFetchQuantized` picks the write from the length
74
+ * instead, so a one-row window without pending padding wrote in place there
75
+ * and concatenates here: the same bits until the ring wraps, a different key
76
+ * order after. */
77
+ export class BatchedRotatingQuantCache extends RotatingQuantizedKVCache implements BatchableCache, PaddedPrefillCache {
78
+ #rows: BatchedRotatingState;
79
+ /** Per-row RoPE positions. STABLE ACROSS A STEP — refreshed only at
80
+ * releaseRopeArr() (the scheduler's post-dispatch hook), never inside
81
+ * the update: a graph that captures it before the update ropes Q after
82
+ * (an in-update dispose would be a use-after-dispose), and one that
83
+ * re-reads it for Q after the update would see K and Q at different
84
+ * positions after an in-update refresh. Widens the base's readonly to
85
+ * mutable. */
86
+ override ropeOffsetArr: MlxArray;
87
+
88
+ private constructor(
89
+ maxSize: number, groupSize: number, bits: number, kernels: AffineKernels, leftPad: number[], offsets: number[],
90
+ masks: AttentionMasks,
91
+ ) {
92
+ super(maxSize, groupSize, bits, kernels, masks);
93
+ this.#rows = new BatchedRotatingState(maxSize, leftPad, offsets);
94
+ this.ropeOffsetArr = offsets.length ? MlxArray.fromInt32(Int32Array.from(offsets), [offsets.length]) : ops.zeros([0], Dtype.int32);
95
+ }
96
+
97
+ /** `kernels`: the composition's kernel set for these bits and group size.
98
+ * `masks`: the per-forward masks of the model this layout serves. */
99
+ static empty(maxSize: number, groupSize: number, bits: number, kernels: AffineKernels, leftPad: readonly number[],
100
+ masks = new AttentionMasks()): BatchedRotatingQuantCache {
101
+ return new BatchedRotatingQuantCache(maxSize, groupSize, bits, kernels, [...leftPad], leftPad.map(pad => -pad), masks);
102
+ }
103
+
104
+ override appendDecode(k: MlxArray, v: MlxArray): AttentionRead {
105
+ return withLease(this.#ringMask(1, false), mask => {
106
+ const [keys, values] = this.#updateInPlace(k, v);
107
+ return affineRead(keys, values, mask, this.kernels.decode);
108
+ });
109
+ }
110
+
111
+ override appendWindow(k: MlxArray, v: MlxArray): AttentionRead {
112
+ return this.appendWindowUnder(k, v, this.#ringMask(k.shape[2]!, true), this.kernels.maskedWindow);
113
+ }
114
+
115
+ /** The window write (concatenation) attended with `kernel` under `mask`,
116
+ * for the layout that owns this ring and knows its mask is plain causal
117
+ * (`SpeculativeRotatingAffineLayout`). Takes ownership of `mask`. */
118
+ appendWindowUnder(k: MlxArray, v: MlxArray, mask: MaskLease, kernel: AffineKernel): AttentionRead {
119
+ return withLease(mask, held => {
120
+ const [keys, values] = this.#updateConcat(k, v);
121
+ return affineRead(keys, values, held, kernel);
122
+ });
123
+ }
124
+
125
+ /** The mask of an `N`-position write before it: `block` for concatenation,
126
+ * not for an in-place write. The bf16 ring's family and builder
127
+ * (`BatchedRotatingCache`). */
128
+ #ringMask(N: number, block: boolean): MaskLease {
129
+ const rows = this.#rows;
130
+ const key = `${N}|${block}|${rows.leftPad.join(",")}|${rows.ringIndex}|${rows.totalOffset}|${rows.rotated}`;
131
+ return this.masks.lease(`batched-rotating:${this.maxSize}`, key, () => ({
132
+ mode: "array",
133
+ arr: buildBatchedRotatingMask(rows.batchSize, N, rows.leftPad, this.maxSize, this.maxSize,
134
+ rows.ringIndex, rows.totalOffset, rows.rotated, block),
135
+ }));
136
+ }
137
+
138
+ get positionSnapshot(): RotatingPositionSnapshot { return this.#rows.snapshot(); }
139
+ validOffset(row: number): number { return this.#rows.validOffset(row); }
140
+ preparePrefill(padding: PrefillPadding, rightPaddedBatch?: boolean): void { this.#rows.preparePrefill(padding, rightPaddedBatch); this.releaseRopeArr(); }
141
+ finalizePrefill(): void {
142
+ const shifts = this.#rows.prefillRoll();
143
+ if (shifts?.some(shift => shift !== 0) && this.keys && this.values) {
144
+ using indices = rowRollIndices(this.keys.packed.shape[2]!, shifts);
145
+ const keys = quantizedRowStorage.rollRows(this.keys, indices);
146
+ let values: ops.QuantizedTensor;
147
+ try { values = quantizedRowStorage.rollRows(this.values, indices); }
148
+ catch (error) { disposeTriple(keys); throw error; }
149
+ disposeTriple(this.keys); disposeTriple(this.values); this.keys = keys; this.values = values;
150
+ }
151
+ this.#rows.finalizePrefill(); this.releaseRopeArr();
152
+ }
153
+ /** Adopt owned tensors without changing their physical ring columns. */
154
+ static adoptPhysical(keys: ops.QuantizedTensor | null, values: ops.QuantizedTensor | null, groupSize: number, bits: number,
155
+ kernels: AffineKernels, position: RotatingPositionSnapshot, masks = new AttentionMasks()): BatchedRotatingQuantCache {
156
+ const cache = new BatchedRotatingQuantCache(position.maxSize, groupSize, bits, kernels, [...position.leftPad], [...position.offsets], masks);
157
+ cache.#rows.restore(position); cache.keys = keys; cache.values = values;
158
+ cache.offset = position.totalOffset; cache.ringIdx = position.ringIndex;
159
+ return cache;
160
+ }
161
+
162
+ get offsetArr(): number[] { return this.#rows.offsets; }
163
+ get rowOffsets(): readonly number[] { return this.#rows.offsets; }
164
+ get leftPad(): number[] { return this.#rows.leftPad; }
165
+ get batchSize(): number { return this.#rows.batchSize; }
166
+ makeEmptyBatch(): BatchedRotatingQuantCache {
167
+ return BatchedRotatingQuantCache.empty(this.maxSize, this.groupSize, this.bits, this.kernels, [], this.masks);
168
+ }
169
+ /** Bytes one row holds for `tokens` more positions, capped at the window. */
170
+ projectedBytes(tokens: number): number {
171
+ const perRow = this.keys && this.values && this.batchSize
172
+ ? [this.keys.packed, this.keys.scales, this.keys.biases, this.values.packed, this.values.scales, this.values.biases]
173
+ .reduce((bytes, array) => bytes + array.nbytes, 0) / (this.batchSize * this.keys.packed.shape[2]!) : 0;
174
+ return perRow * Math.min(tokens, this.maxSize);
175
+ }
176
+
177
+ get #B(): number {
178
+ return this.#rows.batchSize;
179
+ }
180
+
181
+ #seqLen2(): number {
182
+ return this.keys ? this.keys.packed.shape[2]! : 0;
183
+ }
184
+
185
+ /** Scheduler hook, called on every fwd cache AFTER the step's graph is
186
+ * built — the ONE safe point to swap the rope array for the advanced
187
+ * positions (the step's graph holds its own reference; no JS reads the
188
+ * old handle after this). */
189
+ releaseRopeArr(): void {
190
+ this.ropeOffsetArr.dispose();
191
+ this.ropeOffsetArr = this.#B ? MlxArray.fromInt32(Int32Array.from(this.offsetArr), [this.#B]) : ops.zeros([0], Dtype.int32);
192
+ }
193
+
194
+ #allocTriple(B: number, H: number, T: number, dim: number, dtype: Dtype): ops.QuantizedTensor {
195
+ const elPerInt = 32 / this.bits;
196
+ return {
197
+ packed: ops.zeros([B, H, T, dim / elPerInt], Dtype.uint32),
198
+ scales: ops.zeros([B, H, T, dim / this.groupSize], dtype),
199
+ biases: ops.zeros([B, H, T, dim / this.groupSize], dtype),
200
+ };
201
+ }
202
+
203
+ override makeMask(N: number, windowSize: number | null): Mask {
204
+ const window = windowSize ?? this.maxSize;
205
+ return {
206
+ mode: "array",
207
+ arr: buildBatchedRotatingMask(
208
+ this.#B, N, this.leftPad, this.maxSize, window,
209
+ this.#rows.ringIndex, this.#rows.totalOffset, this.#rows.rotated, N > 1 || this.#rows.hasPendingPadding,
210
+ ),
211
+ };
212
+ }
213
+
214
+ override updateAndFetchQuantized(k: MlxArray, v: MlxArray): [ops.QuantizedTensor, ops.QuantizedTensor] {
215
+ if (k.shape[2] !== 1 || this.#rows.hasPendingPadding) return this.#updateConcat(k, v);
216
+ return this.#updateInPlace(k, v);
217
+ }
218
+
219
+ /** N=1 decode update — the bf16 twin's updateAndFetch (mlx-lm
220
+ * _update_in_place) over triples, with quantize-on-write from the
221
+ * serial oracle. */
222
+ #updateInPlace(k: MlxArray, v: MlxArray): [ops.QuantizedTensor, ops.QuantizedTensor] {
223
+ const [B, H, S, D] = k.shape as [number, number, number, number];
224
+ const vD = v.shape[3]!;
225
+ const prev = this.#rows.totalOffset;
226
+
227
+ // Grow the buffer (in STEP chunks) until it reaches maxSize.
228
+ if (!this.keys || (prev >= this.#seqLen2() && this.#seqLen2() < this.maxSize)) {
229
+ const newSize = Math.min(STEP, this.maxSize - prev);
230
+ const newK = this.#allocTriple(B, H, newSize, D, k.dtype);
231
+ const newV = this.#allocTriple(B, H, newSize, vD, v.dtype);
232
+ if (this.keys && this.values) {
233
+ const grow = (old: ops.QuantizedTensor, add: ops.QuantizedTensor): ops.QuantizedTensor => {
234
+ const cat = (a: MlxArray, b: MlxArray): MlxArray => {
235
+ const out = ops.concatAxis([a, b], 2);
236
+ a.dispose();
237
+ b.dispose();
238
+ return out;
239
+ };
240
+ return {
241
+ packed: cat(old.packed, add.packed),
242
+ scales: cat(old.scales, add.scales),
243
+ biases: cat(old.biases, add.biases),
244
+ };
245
+ };
246
+ this.keys = grow(this.keys, newK);
247
+ this.values = grow(this.values, newV);
248
+ } else {
249
+ this.keys = newK;
250
+ this.values = newV;
251
+ }
252
+ this.#rows.markGrown(prev);
253
+ this.ringIdx = this.#rows.ringIndex;
254
+ }
255
+
256
+ // Trim any overshoot past maxSize (decrements left padding persistently).
257
+ const trimSize = this.#seqLen2() - this.maxSize;
258
+ if (trimSize > 0) {
259
+ const cutFrom = (t: ops.QuantizedTensor): ops.QuantizedTensor =>
260
+ mapTriple(t, (a) => {
261
+ const [b2, h2, s2, d2] = a.shape as [number, number, number, number];
262
+ const s = a.slice([0, 0, trimSize, 0], [b2, h2, s2, d2]);
263
+ a.dispose();
264
+ return s;
265
+ });
266
+ this.keys = cutFrom(this.keys!);
267
+ this.values = cutFrom(this.values!);
268
+ this.#rows.trimOvershoot(trimSize);
269
+ this.ringIdx = this.#rows.ringIndex;
270
+ }
271
+
272
+ // Rotate when the write head reaches the end of the ring.
273
+ this.ringIdx = this.#rows.beginWrite(S);
274
+
275
+ // Quantize + write the new K/V at the ring head (six sliceUpdates).
276
+ const kq = ops.quantize(k, this.groupSize, this.bits);
277
+ const vq = ops.quantize(v, this.groupSize, this.bits);
278
+ const writeAt = (dst: ops.QuantizedTensor, src: ops.QuantizedTensor): ops.QuantizedTensor =>
279
+ ({
280
+ packed: this.#assign2(dst.packed, src.packed, S),
281
+ scales: this.#assign2(dst.scales, src.scales, S),
282
+ biases: this.#assign2(dst.biases, src.biases, S),
283
+ });
284
+ this.keys = writeAt(this.keys!, kq);
285
+ this.values = writeAt(this.values!, vq);
286
+ disposeTriple(kq);
287
+ disposeTriple(vq);
288
+
289
+ this.#rows.commitWrite(S);
290
+ this.offset = this.#rows.totalOffset;
291
+ this.ringIdx = this.#rows.ringIndex;
292
+
293
+ // Return the populated prefix (ring not yet full) or the whole buffer.
294
+ const upTo = this.offset < this.maxSize ? this.offset : this.#seqLen2();
295
+ const cut = (t: ops.QuantizedTensor): ops.QuantizedTensor =>
296
+ mapTriple(t, (a) => {
297
+ const [b2, h2, , d2] = a.shape as [number, number, number, number];
298
+ return a.slice([0, 0, 0, 0], [b2, h2, upTo, d2]);
299
+ });
300
+ return [cut(this.keys!), cut(this.values!)];
301
+ }
302
+
303
+ #updateConcat(k: MlxArray, v: MlxArray): [ops.QuantizedTensor, ops.QuantizedTensor] {
304
+ const kq = ops.quantize(k, this.groupSize, this.bits);
305
+ const vq = ops.quantize(v, this.groupSize, this.bits);
306
+ let keys: ops.QuantizedTensor | undefined;
307
+ let values: ops.QuantizedTensor;
308
+ try {
309
+ keys = appendRotatingStorage(quantizedRowStorage, this.keys, kq, this.#rows);
310
+ values = appendRotatingStorage(quantizedRowStorage, this.values, vq, this.#rows);
311
+ } catch (error) { if (keys) disposeTriple(keys); throw error; }
312
+ finally { disposeTriple(kq); disposeTriple(vq); }
313
+ const history = this.keys ? this.#rows.activeLength : 0;
314
+ if (this.keys) disposeTriple(this.keys);
315
+ if (this.values) disposeTriple(this.values);
316
+ this.keys = keys; this.values = values;
317
+ this.#rows.commitConcat(k.shape[2]!, history);
318
+ this.offset = this.#rows.totalOffset;
319
+ this.ringIdx = this.#rows.ringIndex;
320
+ return [
321
+ quantizedRowStorage.slice(keys, 0, this.#B, 0, this.ringIdx),
322
+ quantizedRowStorage.slice(values, 0, this.#B, 0, this.ringIdx),
323
+ ];
324
+ }
325
+
326
+ #assign2(dst: MlxArray, src: MlxArray, S: number): MlxArray {
327
+ const [B, H, , D] = dst.shape as [number, number, number, number];
328
+ const out = ops.sliceUpdate(dst, src, [0, 0, this.ringIdx, 0], [B, H, this.ringIdx + S, D]);
329
+ dst.dispose();
330
+ return out;
331
+ }
332
+
333
+ /** Ring contents in temporal order, cut to the valid length (extract) —
334
+ * overrides the base to use the BATCHED ring state. */
335
+ override temporalView(): [ops.QuantizedTensor, ops.QuantizedTensor] {
336
+ if (!this.keys || !this.values) throw new Error("cache is empty");
337
+ return [
338
+ temporalStorageView(quantizedRowStorage, this.keys, this.#rows, {
339
+ from: Math.max(0, this.#rows.activeLength - this.maxSize), to: this.#rows.activeLength,
340
+ }),
341
+ temporalStorageView(quantizedRowStorage, this.values, this.#rows, {
342
+ from: Math.max(0, this.#rows.activeLength - this.maxSize), to: this.#rows.activeLength,
343
+ }),
344
+ ];
345
+ }
346
+
347
+ /** Quantized twin of BatchedRotatingCache.extractRow (mlx-lm
348
+ * BatchRotatingKVCache.extract, models/cache.py:1417, over triples):
349
+ * row `i` as a fresh SERIAL RotatingQuantizedKVCache — de-rolled to
350
+ * temporal order, left padding stripped, OWNED contiguous copies;
351
+ * offset = the row's absolute position, ringIdx = the new buffer length
352
+ * (the oracle's `cache._idx = cache.keys.shape[2]`). Token-axis slicing
353
+ * is byte-safe (packing along HEAD_DIM — file header); per-row byte
354
+ * identity vs the serial oracle is the class invariant
355
+ * (packages/inference/tests/state/batched-rotating-quant.test.ts), extraction
356
+ * is a pure slice+copy. */
357
+ extractRow(i: number, limit = Infinity): RotatingQuantizedKVCache {
358
+ if (!this.keys || !this.values) return new RotatingQuantizedKVCache(this.maxSize, this.groupSize, this.bits, this.kernels);
359
+ const pad = Math.max(0, this.leftPad[i]!, this.#rows.activeLength - limit);
360
+ const c = new RotatingQuantizedKVCache(this.maxSize, this.groupSize, this.bits, this.kernels);
361
+ const k = temporalStorageView(quantizedRowStorage, this.keys, this.#rows, {
362
+ row: i, from: pad, to: this.#rows.activeLength, copy: true,
363
+ });
364
+ const v = temporalStorageView(quantizedRowStorage, this.values, this.#rows, {
365
+ row: i, from: pad, to: this.#rows.activeLength, copy: true,
366
+ });
367
+ c.restoreState(k, v, this.offsetArr[i]!, k.packed.shape[2]!);
368
+ return c;
369
+ }
370
+
371
+ /** Keep only `keep` rows along the batch axis (eviction), in place. */
372
+ filter(keep: number[]): void {
373
+ if (this.keys && this.values) {
374
+ const k = quantizedRowStorage.takeRows(this.keys, keep);
375
+ const v = quantizedRowStorage.takeRows(this.values, keep);
376
+ disposeTriple(this.keys);
377
+ disposeTriple(this.values);
378
+ this.keys = k;
379
+ this.values = v;
380
+ }
381
+ this.#rows.filter(keep);
382
+ this.releaseRopeArr(); // safe here: filter runs between steps
383
+ }
384
+
385
+ filterRows(keep: readonly number[]): void { this.filter([...keep]); }
386
+
387
+ override trim(count: number): void {
388
+ this.#rows.trim(count); this.offset = this.#rows.totalOffset; this.ringIdx = this.#rows.ringIndex;
389
+ this.releaseRopeArr();
390
+ }
391
+
392
+ override isTrimmable(): boolean {
393
+ return false; // batched rows never re-enter the prompt cache directly
394
+ }
395
+
396
+ override dispose(): void {
397
+ super.dispose();
398
+ this.releaseRopeArr();
399
+ this.ropeOffsetArr?.dispose();
400
+ }
401
+
402
+ /** Join rows into this empty ring: sources are running rings, whose rows are
403
+ * cut out in temporal order, or serial RotatingQuantizedKVCaches (an adopted
404
+ * lone row or a joiner), in row order. Sources are borrowed. */
405
+ mergeRows(rows: readonly Cache[]): void {
406
+ if (this.#rows.batchSize) throw new Error("BatchedRotatingQuantCache.mergeRows needs an empty batch");
407
+ const parts: QuantRow[] = [], offsets: number[] = [], held: ops.QuantizedTensor[] = [];
408
+ const own = (triple: ops.QuantizedTensor) => { held.push(triple); return triple; };
409
+ try {
410
+ for (const source of rows) {
411
+ if (source instanceof BatchedRotatingQuantCache) {
412
+ const [k0, v0] = source.temporalView(); own(k0); own(v0);
413
+ const valid = k0.packed.shape[2]!;
414
+ for (let b = 0; b < source.batchSize; b++) {
415
+ const pad = Math.max(0, source.leftPad[b]!);
416
+ const cutRow = (t: ops.QuantizedTensor) => own(mapTriple(t, (a) =>
417
+ a.slice([b, 0, pad, 0], [b + 1, a.shape[1]!, valid, a.shape[3]!])));
418
+ parts.push({ keys: cutRow(k0), values: cutRow(v0) });
419
+ offsets.push(source.offsetArr[b]!);
420
+ }
421
+ } else if (isRotatingQuantizedCache(source)) {
422
+ const [keys, values] = (source as RotatingQuantizedKVCache).temporalView();
423
+ parts.push({ keys: own(keys), values: own(values) }); offsets.push(source.offset);
424
+ } else throw new Error(`quantized sliding-window batch cannot merge ${source.signature()}`);
425
+ }
426
+ const merged = BatchedRotatingQuantCache.merge(parts, offsets, this.maxSize, this.groupSize, this.bits, this.kernels);
427
+ this.#rows = merged.#rows; this.keys = merged.keys; this.values = merged.values;
428
+ this.offset = merged.offset; this.ringIdx = merged.ringIdx;
429
+ merged.keys = merged.values = null;
430
+ merged.dispose();
431
+ this.releaseRopeArr();
432
+ } finally { for (const triple of held) disposeTriple(triple); }
433
+ }
434
+
435
+ /** Assemble a batch from per-row temporal quantized slices (the bf16
436
+ * twin's merge over triples). Each row is a solo/adopted/batched cache's
437
+ * temporalView ([1,H,Li,*], Li ≤ maxSize, temporal order) and
438
+ * `offsets[i]` its absolute position. Result is in temporal order
439
+ * (rotated=false, ringIdx=offset=width). */
440
+ static merge(
441
+ rows: QuantRow[], offsets: number[], maxSize: number, groupSize: number, bits: number, kernels: AffineKernels,
442
+ masks = new AttentionMasks(),
443
+ ): BatchedRotatingQuantCache {
444
+ const lens = rows.map((r) => r.keys.packed.shape[2]!);
445
+ const width = Math.max(...lens, 0);
446
+ const leftPad = lens.map((l) => width - l);
447
+ const cache = new BatchedRotatingQuantCache(maxSize, groupSize, bits, kernels, leftPad, offsets, masks);
448
+ cache.#rows.restoreMerged(width, offsets);
449
+ cache.offset = cache.#rows.totalOffset;
450
+ cache.ringIdx = cache.#rows.ringIndex;
451
+ if (width === 0) return cache;
452
+
453
+ cache.keys = mergeStorageRows(quantizedRowStorage, rows.map((row) => row.keys), leftPad);
454
+ cache.values = mergeStorageRows(quantizedRowStorage, rows.map((row) => row.values), leftPad);
455
+ return cache;
456
+ }
457
+ }
@@ -0,0 +1,149 @@
1
+ import type { PrefillPadding } from "../contracts/mlx/cache";
2
+
3
+ export interface RotatingPositionSnapshot {
4
+ readonly maxSize: number;
5
+ readonly offsets: readonly number[];
6
+ readonly leftPad: readonly number[];
7
+ readonly ringIndex: number;
8
+ readonly totalOffset: number;
9
+ readonly rotated: boolean;
10
+ readonly prefillEnds?: readonly number[];
11
+ }
12
+
13
+ /** Acceptance changes row positions, independently of plain or encoded planes. */
14
+ export function rotatingRollbackPlan(snapshot: RotatingPositionSnapshot, before: readonly number[],
15
+ keep: number | readonly number[], preserveColumns = false): { trim: number } | { shifts: number[]; position: RotatingPositionSnapshot } {
16
+ const counts = before.map((_, row) => typeof keep === "number" ? keep : keep[row]!);
17
+ if (!preserveColumns && before.length === 1 && snapshot.totalOffset < snapshot.maxSize)
18
+ return { trim: snapshot.offsets[0]! - before[0]! - counts[0]! };
19
+ const offsets = before.map((offset, row) => offset + counts[row]!);
20
+ const shifts = snapshot.offsets.map((offset, row) => offset - offsets[row]!);
21
+ return { shifts, position: { ...snapshot, offsets,
22
+ leftPad: snapshot.leftPad.map((pad, row) => pad + shifts[row]!) } };
23
+ }
24
+
25
+ /** Host-side row and ring bookkeeping shared by plain and quantized storage. */
26
+ export class BatchedRotatingState {
27
+ readonly maxSize: number;
28
+ offsets: number[];
29
+ leftPad: number[];
30
+ ringIndex = 0;
31
+ totalOffset = 0;
32
+ rotated = false;
33
+ #prefillEnds?: number[];
34
+
35
+ constructor(maxSize: number, leftPad: readonly number[], offsets?: readonly number[]) {
36
+ this.maxSize = maxSize;
37
+ this.leftPad = [...leftPad];
38
+ this.offsets = offsets ? [...offsets] : leftPad.map((pad) => -pad);
39
+ }
40
+
41
+ snapshot(): RotatingPositionSnapshot {
42
+ return { maxSize: this.maxSize, offsets: [...this.offsets], leftPad: [...this.leftPad],
43
+ ringIndex: this.ringIndex, totalOffset: this.totalOffset, rotated: this.rotated,
44
+ ...(this.#prefillEnds ? { prefillEnds: [...this.#prefillEnds] } : {}) };
45
+ }
46
+ restore(snapshot: RotatingPositionSnapshot): void {
47
+ this.offsets = [...snapshot.offsets]; this.leftPad = [...snapshot.leftPad];
48
+ this.ringIndex = snapshot.ringIndex; this.totalOffset = snapshot.totalOffset; this.rotated = snapshot.rotated;
49
+ this.#prefillEnds = snapshot.prefillEnds ? [...snapshot.prefillEnds] : undefined;
50
+ }
51
+
52
+ preparePrefill(padding: PrefillPadding, rightPaddedBatch = padding.rightPadding?.some(pad => pad > 0)): void {
53
+ if (!this.batchSize) { this.leftPad = padding.lengths.map(() => 0); this.offsets = [...this.leftPad]; }
54
+ if (padding.leftPadding) {
55
+ this.leftPad = this.leftPad.map((pad, row) => pad + padding.leftPadding![row]!);
56
+ this.offsets = this.offsets.map((offset, row) => offset - padding.leftPadding![row]!);
57
+ }
58
+ this.#prefillEnds = rightPaddedBatch
59
+ ? padding.lengths.map((length, row) => length + this.offsets[row]!) : undefined;
60
+ }
61
+ get hasPendingPadding(): boolean { return this.#prefillEnds !== undefined; }
62
+ validOffset(row: number): number {
63
+ return Math.min(this.offsets[row]!, this.#prefillEnds?.[row] ?? this.offsets[row]!);
64
+ }
65
+
66
+ prefillRoll(): number[] | undefined {
67
+ return this.#prefillEnds?.map((end, row) => Math.max(0, this.offsets[row]! - end));
68
+ }
69
+ #rollPadding(): void {
70
+ const shifts = this.prefillRoll();
71
+ if (!shifts) return;
72
+ this.leftPad = this.leftPad.map((pad, row) => pad + shifts[row]!);
73
+ this.offsets = this.offsets.map((offset, row) => offset - shifts[row]!);
74
+ }
75
+ finalizePrefill(): void { this.#rollPadding(); this.#prefillEnds = undefined; }
76
+
77
+ get batchSize(): number { return this.leftPad.length; }
78
+ get validLength(): number { return Math.min(this.totalOffset, this.maxSize); }
79
+ get activeLength(): number { return this.rotated ? this.maxSize : this.ringIndex; }
80
+ get trimmable(): boolean { return this.totalOffset < this.maxSize; }
81
+
82
+ markGrown(previousOffset: number): void {
83
+ this.ringIndex = previousOffset;
84
+ }
85
+
86
+ trimOvershoot(tokens: number): void {
87
+ if (tokens <= 0) return;
88
+ this.ringIndex = this.maxSize;
89
+ this.leftPad = this.leftPad.map((pad) => pad - tokens);
90
+ }
91
+
92
+ /** Prepare an N-token write and return its physical ring column. */
93
+ beginWrite(tokens: number): number {
94
+ if (this.ringIndex === this.maxSize) {
95
+ this.rotated = true;
96
+ this.ringIndex = 0;
97
+ }
98
+ if (this.rotated) this.leftPad = this.leftPad.map((pad) => pad - tokens);
99
+ return this.ringIndex;
100
+ }
101
+
102
+ commitWrite(tokens: number): void {
103
+ this.totalOffset += tokens;
104
+ this.offsets = this.offsets.map((offset) => offset + tokens);
105
+ this.ringIndex += tokens;
106
+ }
107
+
108
+ /** mlx-lm BatchRotatingKVCache._update_concat: the block keeps up to
109
+ * maxSize - 1 historical columns so each query has a complete window. */
110
+ commitConcat(tokens: number, historicalLength: number): void {
111
+ if (historicalLength) this.#rollPadding();
112
+ const trim = Math.max(0, historicalLength - this.maxSize + 1);
113
+ this.leftPad = this.leftPad.map(pad => pad - trim);
114
+ this.totalOffset += tokens;
115
+ this.offsets = this.offsets.map(offset => offset + tokens);
116
+ this.ringIndex = historicalLength - trim + tokens;
117
+ this.rotated = false;
118
+ }
119
+
120
+ filter(keep: readonly number[]): void {
121
+ this.offsets = keep.map((row) => this.offsets[row]!);
122
+ this.leftPad = keep.map((row) => this.leftPad[row]!);
123
+ if (this.#prefillEnds) this.#prefillEnds = keep.map(row => this.#prefillEnds![row]!);
124
+ }
125
+
126
+ trim(tokens: number): number {
127
+ const amount = Math.min(this.totalOffset, tokens);
128
+ this.totalOffset -= amount;
129
+ this.ringIndex -= amount;
130
+ this.offsets = this.offsets.map((offset) => offset - amount);
131
+ return amount;
132
+ }
133
+
134
+ restoreMerged(width: number, offsets: readonly number[]): void {
135
+ this.totalOffset = width;
136
+ this.ringIndex = width;
137
+ this.offsets = [...offsets];
138
+ this.rotated = false;
139
+ this.#prefillEnds = undefined;
140
+ }
141
+
142
+ /** Physical ranges that expose a ring buffer in temporal order. */
143
+ temporalRanges(bufferLength: number): readonly [number, number][] {
144
+ if (this.ringIndex === bufferLength) return [[0, bufferLength]];
145
+ if (this.ringIndex < this.totalOffset)
146
+ return [[this.ringIndex, bufferLength], [0, this.ringIndex]];
147
+ return [[0, this.ringIndex]];
148
+ }
149
+ }