mlx-bun 0.2.0 → 0.4.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 (433) hide show
  1. package/README.md +71 -588
  2. package/docs/README.md +94 -0
  3. package/docs/{design → archive/investigations}/audio-input-plan.md +4 -4
  4. package/docs/{design → archive/investigations}/diffusion-gemma-port.md +3 -3
  5. package/docs/{design → archive/investigations}/faithful-l1-consolidation.md +4 -4
  6. package/docs/{design → archive/investigations}/minicpm5-decode-megakernel.md +11 -11
  7. package/docs/archive/investigations/openjarvis-fit.md +198 -0
  8. package/docs/{design → archive/investigations}/optimization_plan.md +1 -1
  9. package/docs/{design → archive/investigations}/pre-colibri-stabilization.md +5 -5
  10. package/docs/archive/investigations/qwen38-27b-campaign-log.md +1092 -0
  11. package/docs/{design → archive/investigations}/the-dreaming-handoff.md +2 -2
  12. package/docs/archive/planning/release-notes-v0.3.0.md +35 -0
  13. package/docs/design/batching.md +1841 -0
  14. package/docs/design/decode-speed-program.md +2346 -169
  15. package/docs/design/dreaming-nightly-pipeline.md +675 -282
  16. package/docs/design/generic-model-support.md +655 -334
  17. package/docs/design/kv-cache.md +824 -0
  18. package/docs/design/orpo-training.md +673 -1239
  19. package/docs/design/speculative-decoding.md +1990 -0
  20. package/docs/design/turboquant.md +2212 -0
  21. package/docs/design/unified-engine-frontier-plan.md +1833 -727
  22. package/docs/design/web-chat-redesign.md +666 -1083
  23. package/docs/planning/PRODUCT_ROADMAP.md +50 -1
  24. package/docs/planning/release-notes-v0.4.0.md +45 -0
  25. package/docs/planning/video-series.md +2 -2
  26. package/docs/reference/benchmarks.md +3613 -0
  27. package/docs/reference/cli.md +434 -160
  28. package/docs/reference/distribution.md +328 -182
  29. package/docs/reference/environment.md +398 -0
  30. package/docs/reference/glossary.md +39 -0
  31. package/docs/reference/library-api.md +566 -168
  32. package/docs/reference/memory.md +227 -64
  33. package/docs/reference/models.md +113 -6
  34. package/docs/reference/server-api.md +944 -429
  35. package/docs/reference/server-config.md +740 -338
  36. package/docs/reference/training.md +393 -254
  37. package/docs/reference/troubleshooting.md +158 -0
  38. package/package.json +9 -4
  39. package/src/audio/decode.ts +2 -2
  40. package/src/audio/features.ts +2 -2
  41. package/src/backends/mlx/assistant-target.ts +46 -0
  42. package/src/backends/mlx/autoregressive-draft-rows.ts +120 -0
  43. package/src/backends/mlx/autoregressive.ts +108 -0
  44. package/src/backends/mlx/batch-group.ts +1790 -0
  45. package/src/backends/mlx/cache-attachment.ts +67 -0
  46. package/src/backends/mlx/cache-layout.ts +31 -0
  47. package/src/backends/mlx/checkpoint-state.ts +53 -0
  48. package/src/backends/mlx/continuation-persistence.ts +106 -0
  49. package/src/backends/mlx/continuation-request.ts +43 -0
  50. package/src/backends/mlx/continuation.ts +77 -0
  51. package/src/backends/mlx/diffusion.ts +39 -0
  52. package/src/backends/mlx/draft-target.ts +32 -0
  53. package/src/backends/mlx/evaluation.ts +105 -0
  54. package/src/backends/mlx/fill-append.ts +45 -0
  55. package/src/backends/mlx/full-kv-row-append.ts +32 -0
  56. package/src/backends/mlx/full-kv-row-donor.ts +54 -0
  57. package/src/backends/mlx/full-transitioning-kv-rows.ts +65 -0
  58. package/src/backends/mlx/gateway-binding.ts +130 -0
  59. package/src/backends/mlx/graph.ts +38 -0
  60. package/src/backends/mlx/kv-codec.ts +9 -0
  61. package/src/backends/mlx/kv-maintenance.ts +133 -0
  62. package/src/backends/mlx/kv-tensor-rows.ts +212 -0
  63. package/src/backends/mlx/memory-client.ts +189 -0
  64. package/src/backends/mlx/methods.ts +90 -0
  65. package/src/backends/mlx/model-prompt.ts +164 -0
  66. package/src/backends/mlx/model-serving.ts +79 -0
  67. package/src/backends/mlx/prefill-cohort.ts +89 -0
  68. package/src/backends/mlx/prefill-rows.ts +200 -0
  69. package/src/backends/mlx/prefill.ts +33 -0
  70. package/src/backends/mlx/projected-context-rows.ts +72 -0
  71. package/src/backends/mlx/request-policy.ts +20 -0
  72. package/src/backends/mlx/request-state-policy.ts +41 -0
  73. package/src/backends/mlx/rollback.ts +89 -0
  74. package/src/backends/mlx/row-sampling.ts +49 -0
  75. package/src/backends/mlx/serial-executor.ts +242 -0
  76. package/src/backends/mlx/speculative-group.ts +359 -0
  77. package/src/backends/mlx/speculative-round.ts +161 -0
  78. package/src/backends/mlx/speculative.ts +114 -0
  79. package/src/backends/mlx/state-rows.ts +104 -0
  80. package/src/backends/mlx/state-views.ts +46 -0
  81. package/src/backends/mlx/target-layout-capability.ts +35 -0
  82. package/src/backends/mlx/text-engine.ts +73 -0
  83. package/src/backends/mlx/transitioning-kv-rows.ts +165 -0
  84. package/src/cli.ts +66 -58
  85. package/src/client.ts +66 -0
  86. package/src/config.ts +21 -4
  87. package/src/contracts/completion.ts +16 -0
  88. package/src/contracts/execution.ts +60 -0
  89. package/src/contracts/generation.ts +103 -0
  90. package/src/contracts/host.ts +7 -0
  91. package/src/contracts/jobs.ts +66 -0
  92. package/src/contracts/pi-provider.ts +30 -0
  93. package/src/contracts/pi.ts +259 -0
  94. package/src/contracts/prefix-cache.ts +23 -0
  95. package/src/contracts/resources.ts +25 -0
  96. package/src/contracts/sampling.ts +23 -0
  97. package/src/contracts/scheduling.ts +45 -0
  98. package/src/contracts/tsconfig.json +14 -0
  99. package/src/diffusion/diffusion-generate.ts +218 -153
  100. package/src/embed.ts +1 -1
  101. package/src/engine/admission.ts +59 -0
  102. package/src/engine/cancellation.ts +38 -0
  103. package/src/engine/engine.ts +56 -0
  104. package/src/engine/execution-coordinator.ts +70 -0
  105. package/src/engine/execution-plan.ts +53 -0
  106. package/src/engine/resources.ts +53 -0
  107. package/src/engine/scheduler.ts +72 -0
  108. package/src/engine/session.ts +247 -0
  109. package/src/eval/README.md +44 -1
  110. package/src/eval/kl.ts +236 -3
  111. package/src/eval/reference-logits.ts +207 -0
  112. package/src/eval/runner.ts +8 -96
  113. package/src/fill/echo-index.ts +188 -0
  114. package/src/fill/fill-session.ts +452 -0
  115. package/src/fill/proposal.ts +68 -0
  116. package/src/fill/schema-rows.ts +506 -0
  117. package/src/fill/tool-boundary.ts +103 -0
  118. package/src/fit.ts +30 -16
  119. package/src/generate.ts +709 -417
  120. package/src/grammar.ts +12 -7
  121. package/src/harness-pi.ts +14 -33
  122. package/src/hub-rest.ts +4 -4
  123. package/src/index.ts +7 -0
  124. package/src/inference/denoising.ts +17 -0
  125. package/src/inference/draft-acceptance.ts +41 -0
  126. package/src/inference/draft-output.ts +49 -0
  127. package/src/inference/graph.ts +33 -0
  128. package/src/inference/prefill.ts +39 -0
  129. package/src/inference/rollback.ts +7 -0
  130. package/src/jobs/db.ts +4 -0
  131. package/src/jobs/index.ts +2 -0
  132. package/src/jobs/job-entry.ts +12 -12
  133. package/src/jobs/runner.ts +98 -13
  134. package/src/jobs/task-client.ts +19 -0
  135. package/src/jobs/types.ts +2 -58
  136. package/src/kv-scheme.ts +70 -12
  137. package/src/kv-store.ts +177 -63
  138. package/src/lab/README.md +18 -0
  139. package/src/{assets → lab/curve}/curve-designer.html +2 -2
  140. package/src/{curve-sampler.ts → lab/curve/curve-sampler.ts} +2 -2
  141. package/src/{expert-trace.ts → lab/expert-trace/expert-trace.ts} +5 -5
  142. package/src/lab/paged-kv/paged-kv-rows.ts +83 -0
  143. package/src/{model → lab/paged-kv}/paged-kv.ts +32 -15
  144. package/src/library.ts +40 -0
  145. package/src/lora.ts +18 -0
  146. package/src/media-fetch.ts +1 -1
  147. package/src/memory/article.ts +1 -1
  148. package/src/memory/chunk.ts +1 -1
  149. package/src/memory/model.ts +30 -169
  150. package/src/memory/prompts.ts +1 -1
  151. package/src/memory/rest.ts +1 -1
  152. package/src/memory/schedule.ts +1 -1
  153. package/src/memory/stages.ts +4 -1
  154. package/src/memory/vault.ts +1 -3
  155. package/src/mlx/array.ts +11 -11
  156. package/src/mlx/compile.ts +12 -2
  157. package/src/mlx/ffi.ts +58 -11
  158. package/src/mlx/materialize.ts +23 -0
  159. package/src/mlx/metal-kernel.ts +10 -11
  160. package/src/mlx/ops.ts +33 -13
  161. package/src/mlx/quantized-rows.ts +36 -0
  162. package/src/mlx/token-bitmask.ts +52 -0
  163. package/src/mlx/turboquant-kv-decode.ts +82 -0
  164. package/src/mlx/turboquant-kv-inverse.ts +122 -0
  165. package/src/mlx/turboquant-ops.ts +33 -3
  166. package/src/mlx/turboquant-tables.ts +2 -2
  167. package/src/model/artifact-identity.ts +73 -0
  168. package/src/model/batched-kv.ts +235 -0
  169. package/src/model/batched-mask.ts +20 -6
  170. package/src/model/batched-quant.ts +9 -3
  171. package/src/model/batched-quantized-kv.ts +144 -0
  172. package/src/model/batched-rotating-quant.ts +78 -17
  173. package/src/model/batched-rotating-state.ts +76 -0
  174. package/src/model/batched-rotating.ts +65 -23
  175. package/src/model/batched-row-storage.ts +52 -0
  176. package/src/model/batched-ssm.ts +52 -0
  177. package/src/model/batched-turboquant-kv.ts +93 -0
  178. package/src/model/compiled-decode.ts +8 -2
  179. package/src/model/decoded-kv-donor.ts +12 -0
  180. package/src/model/delayed-quantized-kv.ts +72 -0
  181. package/src/model/delayed-rotating-quantized-kv.ts +93 -0
  182. package/src/model/delayed-turboquant-kv.ts +55 -0
  183. package/src/model/diffusion-gemma.ts +8 -8
  184. package/src/model/factory.ts +76 -33
  185. package/src/model/fingerprint.ts +1 -1
  186. package/src/model/flash-attention.ts +3 -3
  187. package/src/model/full-prefill-padding.ts +56 -0
  188. package/src/model/full-prefill-row.ts +105 -0
  189. package/src/model/gemma4-base.ts +179 -80
  190. package/src/model/gemma4.ts +40 -32
  191. package/src/model/generated/gemma4-12b.ts +6 -3
  192. package/src/model/generated/gemma4-26b.ts +6 -3
  193. package/src/model/generated/gemma4-e4b.ts +6 -3
  194. package/src/model/glm52-cache.ts +80 -4
  195. package/src/model/glm52-dsa.ts +13 -9
  196. package/src/model/glm52-memory.ts +1 -1
  197. package/src/model/glm52-mla.ts +12 -6
  198. package/src/model/glm52.ts +19 -40
  199. package/src/model/implementation.ts +69 -0
  200. package/src/model/kv-attention-view.ts +67 -0
  201. package/src/model/minicpm5.ts +17 -15
  202. package/src/model/profile.ts +12 -2
  203. package/src/model/qwen-append.ts +12 -0
  204. package/src/model/qwen-conv.ts +52 -0
  205. package/src/model/qwen3-delta-state.ts +74 -0
  206. package/src/model/qwen3-delta.ts +59 -36
  207. package/src/model/qwen3_5-checkpoint.ts +164 -0
  208. package/src/model/qwen3_5.ts +202 -78
  209. package/src/model/rotating-kv-donor.ts +35 -0
  210. package/src/model/rotating-kv-layout.ts +262 -0
  211. package/src/model/rotating-row-transaction.ts +35 -0
  212. package/src/model/speculative-rotating-kv.ts +101 -0
  213. package/src/model/ssm-prefill-padding.ts +39 -0
  214. package/src/model/support.ts +1 -1
  215. package/src/model/trellis-balanced-scatter.ts +51 -0
  216. package/src/model/trellis-linear.ts +672 -0
  217. package/src/model/trellis-shared-m.ts +151 -0
  218. package/src/model/trellis-shared-scatter.ts +144 -0
  219. package/src/model/trellis-splitk-prefill.ts +158 -0
  220. package/src/model/trellis-tiled-prefill.ts +136 -0
  221. package/src/model/trellis-vector-expand.ts +62 -0
  222. package/src/model/trellis-wide-prefill.ts +94 -0
  223. package/src/model/turboquant-codec.ts +83 -0
  224. package/src/model/universal/dense.ts +15 -14
  225. package/src/model/universal/modules.ts +8 -1
  226. package/src/native-pack.ts +6 -5
  227. package/src/pi-provider.ts +6 -64
  228. package/src/pi-web.ts +8 -315
  229. package/src/preflight.ts +31 -15
  230. package/src/prompt-cache.ts +110 -69
  231. package/src/quantize/allocator.ts +1 -1
  232. package/src/quantize/config-writer.ts +10 -3
  233. package/src/quantize/rotate.ts +4 -4
  234. package/src/quantize/trellis.ts +586 -0
  235. package/src/responses.ts +28 -1
  236. package/src/runtime-config.ts +18 -4
  237. package/src/sampler.ts +40 -29
  238. package/src/serve/batch-scheduler.ts +8 -1671
  239. package/src/serve/chat-request.ts +391 -0
  240. package/src/serve/chat-stage.ts +195 -0
  241. package/src/serve/checkpoint-identity.ts +64 -0
  242. package/src/serve/completion-executor.ts +15 -7
  243. package/src/serve/discovery-routes.ts +12 -13
  244. package/src/serve/generation-gateway.ts +183 -213
  245. package/src/serve/http.ts +159 -0
  246. package/src/serve/inference-request.ts +79 -0
  247. package/src/serve/isolate.ts +297 -105
  248. package/src/serve/lab-routes.ts +3 -0
  249. package/src/serve/lane-registry.ts +2 -1
  250. package/src/serve/model-admin-routes.ts +7 -5
  251. package/src/serve/model-binding.ts +43 -0
  252. package/src/serve/model-host.ts +511 -0
  253. package/src/serve/openai-wire.ts +103 -0
  254. package/src/serve/parent-application.ts +56 -0
  255. package/src/serve/pipeline.ts +33 -0
  256. package/src/serve/preparation.ts +33 -0
  257. package/src/serve/request-plan.ts +23 -18
  258. package/src/serve/request-prep.ts +344 -0
  259. package/src/serve/response-lease.ts +24 -0
  260. package/src/serve/responses-client.ts +69 -0
  261. package/src/serve/session-completion-engine.ts +110 -0
  262. package/src/serve/session-search.ts +1 -1
  263. package/src/serve/static-routes.ts +5 -5
  264. package/src/serve/text-completion-stage.ts +104 -0
  265. package/src/serve/token-streams.ts +519 -0
  266. package/src/server.ts +335 -2711
  267. package/src/spec/assistant-rows.ts +92 -0
  268. package/src/spec/assistant-source.ts +31 -55
  269. package/src/spec/cache-identity.ts +22 -0
  270. package/src/spec/deepspec-rows.ts +29 -0
  271. package/src/spec/deepspec-source.ts +16 -14
  272. package/src/spec/dflash-source.ts +36 -12
  273. package/src/spec/drafter.ts +153 -142
  274. package/src/spec/dspark/ab-stats.ts +3 -3
  275. package/src/spec/dspark/calibration.ts +2 -2
  276. package/src/spec/dspark/deepspec-module.ts +97 -122
  277. package/src/spec/dspark/generate-dflash.ts +2 -2
  278. package/src/spec/dspark/generate.ts +2 -2
  279. package/src/spec/dspark/loader.ts +1 -1
  280. package/src/spec/dspark/module-dflash.ts +129 -172
  281. package/src/spec/dspark/module.ts +3 -3
  282. package/src/spec/dspark/quantize-drafter.ts +1 -1
  283. package/src/spec/generate.ts +1 -1
  284. package/src/spec/glm52-mtp-graph.ts +29 -0
  285. package/src/spec/glm52-mtp-rows.ts +132 -0
  286. package/src/spec/glm52-mtp-source.ts +54 -137
  287. package/src/spec/glm52-mtp-state.ts +33 -0
  288. package/src/spec/ngram-source.ts +93 -21
  289. package/src/spec/projected-draft-rows.ts +73 -0
  290. package/src/spec/qwen-mtp-module.ts +171 -0
  291. package/src/spec/qwen-mtp-rows.ts +219 -0
  292. package/src/spec/qwen-mtp-source.ts +147 -195
  293. package/src/spec/qwen-mtp-state.ts +30 -0
  294. package/src/spec/serve-loop.ts +201 -201
  295. package/src/spec/source.ts +110 -13
  296. package/src/spec/two-model-rows.ts +61 -0
  297. package/src/spec/two-model.ts +44 -102
  298. package/src/ssd-cache.ts +99 -19
  299. package/src/ssd-durability.ts +36 -20
  300. package/src/tool-call.ts +51 -14
  301. package/src/train/flash-cce.ts +2 -2
  302. package/src/train/forward.ts +6 -0
  303. package/src/train/loss.ts +1 -1
  304. package/src/train/prefix-shared.ts +5 -1
  305. package/src/train/segmented.ts +5 -3
  306. package/src/train/trainer.ts +6 -6
  307. package/src/vision/prompt.ts +1 -1
  308. package/src/vision/qwen3vl-tower.ts +52 -10
  309. package/src/web/app.html +1 -1
  310. package/src/web/app.js +62 -60
  311. package/src/web/src/adapters-panel.ts +3 -3
  312. package/src/web/src/assistant.ts +2 -36
  313. package/src/web/src/chat.ts +4 -4
  314. package/src/web/src/composer.ts +4 -4
  315. package/src/web/src/hub.ts +1 -1
  316. package/src/web/src/markdown.ts +0 -0
  317. package/src/web/src/memory-panel.ts +1 -1
  318. package/src/web/src/model-picker.ts +1 -1
  319. package/src/web/src/palette.ts +1 -1
  320. package/src/web/src/protocol.ts +3 -39
  321. package/src/web/src/sessions.ts +1 -1
  322. package/src/web/src/ui-catalog.ts +4 -18
  323. package/src/web-assets.ts +47 -0
  324. package/src/weights.ts +55 -9
  325. package/docs/archive/investigations/curve-runs/bisector-route.json +0 -98
  326. package/docs/archive/investigations/curve-runs/bisector-trace.json +0 -1393
  327. package/docs/archive/investigations/curve-runs/curve-terrain.json +0 -1179
  328. package/docs/archive/investigations/curve-runs/curve-terrain.svg +0 -42
  329. package/docs/archive/investigations/hlg-ab.html +0 -34
  330. package/docs/archive/investigations/hlg-explorer.html +0 -238
  331. package/docs/archive/investigations/hlg-figs/cliff.svg +0 -1
  332. package/docs/archive/investigations/hlg-figs/cross.svg +0 -1
  333. package/docs/archive/investigations/hlg-figs/edges.svg +0 -1
  334. package/docs/archive/investigations/hlg-figs/k20-grids.svg +0 -1
  335. package/docs/archive/investigations/hlg-figs/k20-peaks.svg +0 -1
  336. package/docs/archive/investigations/hlg-figs/lw-curve.svg +0 -1
  337. package/docs/archive/investigations/hlg-figs/terrain.svg +0 -1
  338. package/docs/archive/investigations/hlg-report.html +0 -262
  339. package/docs/archive/investigations/hlg-runs/hlg-ab.json +0 -149
  340. package/docs/archive/investigations/hlg-runs/hlg-blind-prompts.md +0 -87
  341. package/docs/archive/investigations/hlg-runs/hlg-blind.json +0 -107
  342. package/docs/archive/investigations/hlg-runs/hlg-cliff.json +0 -197
  343. package/docs/archive/investigations/hlg-runs/hlg-cross.json +0 -505
  344. package/docs/archive/investigations/hlg-runs/hlg-edge.json +0 -388
  345. package/docs/archive/investigations/hlg-runs/hlg-eval1.json +0 -25
  346. package/docs/archive/investigations/hlg-runs/hlg-frontier.json +0 -86
  347. package/docs/archive/investigations/hlg-runs/hlg-grid.json +0 -242
  348. package/docs/archive/investigations/hlg-runs/hlg-grid2.json +0 -343
  349. package/docs/archive/investigations/hlg-runs/hlg-lw-coarse.json +0 -110
  350. package/docs/archive/investigations/hlg-runs/hlg-map.json +0 -383
  351. package/docs/archive/investigations/hlg-runs/run0-original.log +0 -159
  352. package/docs/archive/investigations/hlg-runs/runA-recommended.log +0 -131
  353. package/docs/archive/investigations/hlg-runs/runAA-cliff-cpm5.log +0 -26
  354. package/docs/archive/investigations/hlg-runs/runAB-grid2-e4b.log +0 -18
  355. package/docs/archive/investigations/hlg-runs/runAC-peak-e4b-partial.log +0 -25
  356. package/docs/archive/investigations/hlg-runs/runAD-ab-samples.log +0 -8
  357. package/docs/archive/investigations/hlg-runs/runAE-edge-e4b.log +0 -51
  358. package/docs/archive/investigations/hlg-runs/runAF-logit-calibration.log +0 -10
  359. package/docs/archive/investigations/hlg-runs/runAG-eval-config2.log +0 -16
  360. package/docs/archive/investigations/hlg-runs/runB-gain-variants.log +0 -192
  361. package/docs/archive/investigations/hlg-runs/runC-pivots.log +0 -162
  362. package/docs/archive/investigations/hlg-runs/runD-oetf.log +0 -132
  363. package/docs/archive/investigations/hlg-runs/runE-eotf.log +0 -162
  364. package/docs/archive/investigations/hlg-runs/runF-shaper-working.log +0 -86
  365. package/docs/archive/investigations/hlg-runs/runG-shaper-sweep.log +0 -101
  366. package/docs/archive/investigations/hlg-runs/runH-wsweep.log +0 -176
  367. package/docs/archive/investigations/hlg-runs/runI-asweep.log +0 -176
  368. package/docs/archive/investigations/hlg-runs/runJ-knobmap.log +0 -49
  369. package/docs/archive/investigations/hlg-runs/runK-frontier.log +0 -19
  370. package/docs/archive/investigations/hlg-runs/runL-widemap.log +0 -65
  371. package/docs/archive/investigations/hlg-runs/runM-frontier-emb.log +0 -15
  372. package/docs/archive/investigations/hlg-runs/runN-verify.log +0 -116
  373. package/docs/archive/investigations/hlg-runs/runO-frontier-seed5000.log +0 -15
  374. package/docs/archive/investigations/hlg-runs/runP-grid-AxSm.log +0 -15
  375. package/docs/archive/investigations/hlg-runs/runQ-grid-tgW.log +0 -15
  376. package/docs/archive/investigations/hlg-runs/runR-blind-transcript.log +0 -79
  377. package/docs/archive/investigations/hlg-runs/runS-cross-coherence.log +0 -33
  378. package/docs/archive/investigations/hlg-runs/runT-cross-cpm5.log +0 -33
  379. package/docs/archive/investigations/hlg-runs/runU-cross-12b.log +0 -33
  380. package/docs/archive/investigations/hlg-runs/runV-lw-e4b.log +0 -22
  381. package/docs/archive/investigations/hlg-runs/runW-lw-12b.log +0 -22
  382. package/docs/archive/investigations/hlg-runs/runX-lw-cpm5.log +0 -22
  383. package/docs/archive/investigations/hlg-runs/runY-cliff-e4b.log +0 -26
  384. package/docs/archive/investigations/hlg-runs/runZ-cliff-12b.log +0 -26
  385. package/docs/archive/mlx-bun-lab-report.html +0 -275
  386. package/docs/archive/wwdc-mlx-bun.html +0 -848
  387. package/docs/design/adapters-end-to-end.md +0 -205
  388. package/docs/design/batching-perf-path.md +0 -255
  389. package/docs/design/batching-v2-plan.md +0 -529
  390. package/docs/design/bucketing-stage.md +0 -197
  391. package/docs/design/compat-cli-surface-design.md +0 -230
  392. package/docs/design/docs-reorg-plan.md +0 -165
  393. package/docs/design/dspark-serving-program.md +0 -371
  394. package/docs/design/dspark-speculative-decoding.md +0 -318
  395. package/docs/design/grammar-spec-batching-integration.md +0 -301
  396. package/docs/design/memory-inference-path.md +0 -422
  397. package/docs/design/memory-synthesis.md +0 -287
  398. package/docs/design/memory-system.md +0 -237
  399. package/docs/design/mlx-lm-serving-execution-seam.md +0 -81
  400. package/docs/design/mlx-lm-tool-parity-plan.md +0 -545
  401. package/docs/design/omlx-adoption-map.md +0 -98
  402. package/docs/design/orpo-dynamic-lambda.md +0 -220
  403. package/docs/design/orpo-future-enhancements.md +0 -340
  404. package/docs/design/paged-kv-cache.md +0 -214
  405. package/docs/design/parallel-slots.md +0 -567
  406. package/docs/design/parity-tier-dag.md +0 -161
  407. package/docs/design/repo-cleanup-plan.md +0 -231
  408. package/docs/design/runtime-isolation.md +0 -263
  409. package/docs/design/segmented-backward-training.md +0 -543
  410. package/docs/design/spec-decode-larger-targets.md +0 -229
  411. package/docs/design/ssd-kv-cold-tier.md +0 -415
  412. package/docs/design/structured-output.md +0 -484
  413. package/docs/design/tauri-desktop-app.md +0 -127
  414. package/docs/design/the-dreaming-master-plan.md +0 -445
  415. package/docs/design/turboquant-kv.md +0 -235
  416. package/docs/design/turboquant-weights.md +0 -467
  417. package/docs/design/w4a16-compute-precision-spike.md +0 -232
  418. package/docs/design/web-chat-beat-matrix.md +0 -315
  419. package/docs/design/write-pipeline-entity.md +0 -468
  420. package/docs/planning/IDEAS.md +0 -69
  421. package/docs/reference/embedding.md +0 -197
  422. package/docs/reference/features-matrix.md +0 -101
  423. package/docs/reference/orpo-quickstart.md +0 -135
  424. package/src/flags.ts +0 -11
  425. /package/docs/{design → archive/investigations}/colibri-glm52-port.md +0 -0
  426. /package/docs/{planning → archive/planning}/chunk-task-roadmap.md +0 -0
  427. /package/docs/{planning → archive/planning}/curve-sampler-research-plan.md +0 -0
  428. /package/docs/{planning → archive/planning}/memory-docs-and-dag-plan.md +0 -0
  429. /package/docs/{planning → archive/planning}/pi-integration-review.md +0 -0
  430. /package/docs/{planning → archive/planning}/release-notes-v0.2.0.md +0 -0
  431. /package/src/{memory-plan.ts → admission-plan.ts} +0 -0
  432. /package/{docs/archive/investigations → src/serve/assets}/curve-terrain.html +0 -0
  433. /package/{docs/dag → src/serve/assets}/training-inference-map.html +0 -0
@@ -0,0 +1,54 @@
1
+ import { captureKvDonorAttention, combineKvDonorAttention } from "../../model/kv-attention-view";
2
+ import type { MlxArray } from "../../mlx/array";
3
+ import * as ops from "../../mlx/ops";
4
+ import type { Cache, KvDonorRows } from "../../model/gemma4-base";
5
+ import { fullRowInner, fullRowPadding } from "../../model/full-prefill-row";
6
+ import { disposeResources } from "../../engine/resources";
7
+
8
+ /** Read full-attention rows in their existing physical columns. Valid token
9
+ * coverage excludes prefill padding; no append, conversion or compaction. */
10
+ export function captureFullKvDonorRows(rows: readonly Cache[], leftPad: readonly number[], width: number): KvDonorRows {
11
+ const parts: KvDonorRows[] = [], padded: MlxArray[] = [];
12
+ try {
13
+ for (const row of rows) parts.push(fullRowInner(row).captureDonorRows!());
14
+ const combine = (field: "keys" | "values") => {
15
+ const views = parts.map((part, index) => {
16
+ const a = part[field], before = leftPad[index]! - fullRowPadding(rows[index]!), after = width - before - a.shape[2]!;
17
+ if (!before && !after) return a;
18
+ using prefix = ops.zeros([1, a.shape[1]!, before, a.shape[3]!], a.dtype);
19
+ using suffix = ops.zeros([1, a.shape[1]!, after, a.shape[3]!], a.dtype);
20
+ const result = ops.concatAxis([prefix, a, suffix], 2); padded.push(result); return result;
21
+ });
22
+ return views.length === 1 ? ops.contiguous(views[0]!) : ops.concatAxis(views, 0);
23
+ };
24
+ const offsets = rows.map(row => row.offset), starts = [...leftPad];
25
+ const keys = combine("keys");
26
+ try { return { keys, values: combine("values"), offsets, starts, ends: offsets.map((offset, row) => starts[row]! + offset) }; }
27
+ catch (error) { keys.dispose(); throw error; }
28
+ } finally { disposeResources([...parts.flatMap(part => [part.keys, part.values]), ...padded]); }
29
+ }
30
+
31
+
32
+ /** Capture full rows in global columns while each encoded view retains its
33
+ * own physical width and numerical attention operation. */
34
+ export function captureFullKvDonorAttention(rows: readonly Cache[], leftPad: readonly number[], width: number): import("../../model/gemma4-base").KvDonorAttention {
35
+ const captured: import("../../model/gemma4-base").KvDonorAttention[] = [];
36
+ try {
37
+ for (const [index, row] of rows.entries()) {
38
+ const view = captureKvDonorAttention(fullRowInner(row));
39
+ const pad = leftPad[index]! - fullRowPadding(row);
40
+ captured.push({ width, dtype: view.dtype, offsets: [row.offset],
41
+ starts: [leftPad[index]!], ends: [leftPad[index]! + row.offset],
42
+ attend(q, scale, mask) {
43
+ if (!mask.arr) return view.attend(q, scale, mask);
44
+ const from = mask.arr.shape.map(() => 0), to = [...mask.arr.shape];
45
+ from[from.length - 1] = pad; to[to.length - 1] = pad + view.width;
46
+ using arr = mask.arr.slice(from, to);
47
+ return view.attend(q, scale, { mode: mask.mode, arr });
48
+ },
49
+ dispose: () => view.dispose(),
50
+ });
51
+ }
52
+ return combineKvDonorAttention(captured);
53
+ } catch (error) { disposeResources(captured); throw error; }
54
+ }
@@ -0,0 +1,65 @@
1
+ import { KVCache, type Cache, type PaddedPrefillCache, type PrefillPadding } from "../../model/gemma4-base";
2
+ import { FullPrefillRow, fullRowInner } from "../../model/full-prefill-row";
3
+ import { cloneKvCaches } from "../../kv-store";
4
+ import { FullKvPositions, SpeculativeTransitioningKvRows, type KvRowTransition, type SpeculativeTransitionedKvLayout } from "./transitioning-kv-rows";
5
+
6
+ type FullLayout = SpeculativeTransitionedKvLayout & PaddedPrefillCache & {
7
+ restorePrefillEnds(ends: readonly number[] | undefined): void;
8
+ }
9
+
10
+ class PrefillPositions extends FullKvPositions {
11
+ override sync(rows: readonly Cache[], preserve: boolean): void {
12
+ const offsets = rows.map(row => row instanceof FullPrefillRow ? row.positionOffset : row.offset);
13
+ this.mergeRows(preserve
14
+ ? [{ planes: [], rowOffsets: offsets, leftPad: [...this.leftPad] }]
15
+ : rows.map((row, index) => ({ planes: [], rowOffsets: [offsets[index]!],
16
+ leftPad: [row instanceof FullPrefillRow ? row.leftPadding : 0] })));
17
+ }
18
+ }
19
+
20
+ /** Full-attention padding composes with the existing precision transition
21
+ * and rollback lifecycle. Codec-specific attention stays in each adapter. */
22
+ export abstract class FullTransitioningKvRows<Layout extends FullLayout>
23
+ extends SpeculativeTransitioningKvRows<Layout> implements PaddedPrefillCache {
24
+ constructor(transition: KvRowTransition<Layout>, row?: Cache) {
25
+ super({ ...transition,
26
+ converted: row => transition.converted(fullRowInner(row)),
27
+ extractRow: row => row instanceof FullPrefillRow ? row.extract() : cloneKvCaches([row])[0]!,
28
+ packRows(layout, rows) {
29
+ layout.mergeRows(rows.map(fullRowInner));
30
+ if (rows.some(row => row instanceof FullPrefillRow)) {
31
+ layout.preparePrefill({ lengths: rows.map(() => 0),
32
+ leftPadding: rows.map(row => row instanceof FullPrefillRow ? row.leftPadding : 0) });
33
+ const ends = rows.map(row => row instanceof FullPrefillRow ? row.padding.endOffsets?.[0] : undefined);
34
+ layout.restorePrefillEnds(ends.some(end => end !== undefined) ? ends.map(end => end ?? Infinity) : undefined);
35
+ }
36
+ },
37
+ }, row, new PrefillPositions());
38
+ }
39
+ preparePrefill(padding: PrefillPadding): void {
40
+ if (this.packed) { this.packed.preparePrefill(padding); return; }
41
+ if (!this.rows.length) this.rows = padding.lengths.map(() => new KVCache());
42
+ this.rows = this.rows.map(row => row instanceof FullPrefillRow ? row : new FullPrefillRow(row as KVCache));
43
+ for (const [index, row] of this.rows.entries()) (row as FullPrefillRow).preparePrefill({
44
+ lengths: [padding.lengths[index]!],
45
+ ...(padding.leftPadding ? { leftPadding: [padding.leftPadding[index]!] } : {}),
46
+ ...(padding.rightPadding ? { rightPadding: [padding.rightPadding[index]!] } : {}),
47
+ });
48
+ this.syncPositions();
49
+ }
50
+ finalizePrefill(): void {
51
+ if (this.packed) { this.packed.finalizePrefill(); return; }
52
+ for (const row of this.rows) if (row instanceof FullPrefillRow) row.finalizePrefill();
53
+ this.syncPositions();
54
+ }
55
+ override filterRows(keep: readonly number[]): void {
56
+ if (!this.packed && keep.length) {
57
+ const pads = [...this.leftPad], shared = Math.min(...keep.map(row => pads[row]!));
58
+ for (const index of keep) {
59
+ const row = this.rows[index]!;
60
+ if (row instanceof FullPrefillRow) row.removeLeftPadding(Math.max(0, row.leftPadding - (pads[index]! - shared)));
61
+ }
62
+ }
63
+ super.filterRows(keep);
64
+ }
65
+ }
@@ -0,0 +1,130 @@
1
+ import { createOrdinaryContinuationRequest } from "./continuation-request";
2
+ import type { MlxSerialServices } from "./serial-executor";
3
+ import { bindPagedRequestState, type MlxRequestStatePolicy } from "./request-state-policy";
4
+ import type { ExecutionContext } from "../../contracts/scheduling";
5
+ import type { ModelConfig } from "../../config";
6
+ import type { KvScheme } from "../../kv-scheme";
7
+ import type { RuntimeModel } from "../../model/factory";
8
+ import { DiffusionGemmaModel } from "../../model/diffusion-gemma";
9
+ import { UniversalDenseModel } from "../../model/universal/dense";
10
+ import { KVCache, RotatingKVCache, isBatchableCache, isPlainKvCache, isRotatingPlainCache } from "../../model/gemma4-base";
11
+ import { SSMCache } from "../../model/qwen3-delta";
12
+ import { Gemma4Model } from "../../model/gemma4";
13
+ import { Qwen35Model } from "../../model/qwen3_5";
14
+ import { runtimeConfig, type RuntimeConfig } from "../../runtime-config";
15
+ import { disposeResources } from "../../engine/resources";
16
+ import { legacyCompiledDecodeAvailable } from "./autoregressive";
17
+ import { MlxBatchExecutionGroup, type MlxBatchExecutionGroupOptions, type MlxGroupMethodRequest } from "./batch-group";
18
+ import type { DraftProvider } from "../../spec/source";
19
+ import { targetRowLayoutFactory } from "./target-layout-capability";
20
+ import { bindSpeculativeGroupRequests } from "./speculative-group";
21
+ import type { GenerateOptions } from "../../generate";
22
+ import type { ExecutionRequirements, ResolvedExecution } from "../../contracts/execution";
23
+ import { resolveExecution } from "../../engine/execution-plan";
24
+
25
+ export interface MlxBatchGroup extends Pick<MlxBatchExecutionGroup,
26
+ "activeRows" | "pendingRows" | "projectedKvBytes" | "kvBudgetBytes" | "submit" | "kick" | "close"> {}
27
+
28
+ /** A model implementation owns capability checks and the execution group.
29
+ * Scheduling never inspects concrete model/cache classes. */
30
+ export interface MlxGatewayBinding {
31
+ configureContinuation?(services: MlxSerialServices): void;
32
+ continuationRequest?(execution: ResolvedExecution | undefined, options: GenerateOptions, prompt: number[],
33
+ onToken: Parameters<typeof createOrdinaryContinuationRequest>[0]["onToken"]): ReturnType<typeof createOrdinaryContinuationRequest> | undefined;
34
+ readonly config: ModelConfig;
35
+ readonly runtime: RuntimeConfig;
36
+ plan(request: ExecutionRequirements, options: GenerateOptions,
37
+ scheduling: { continuous: boolean; quantizedBatch: boolean; checkpoints: boolean }): ResolvedExecution;
38
+ bindAdapterContext?(adapters: string[], key: string): ExecutionContext;
39
+ cachesBatchable(): boolean;
40
+ kvBatchable(scheme: KvScheme): boolean;
41
+ statePolicy?(execution: ResolvedExecution | undefined, options: GenerateOptions, capacityTokens: number): MlxRequestStatePolicy | undefined;
42
+ methodRequest?(execution: ResolvedExecution | undefined, options: GenerateOptions): MlxGroupMethodRequest | undefined;
43
+ createBatchGroup(options: MlxBatchExecutionGroupOptions): MlxBatchGroup;
44
+ }
45
+
46
+ export function bindMlxGateway(model: RuntimeModel, draft?: { provider: DraftProvider; numDraftTokens: number }): MlxGatewayBinding {
47
+ const runtime = runtimeConfig();
48
+ let continuationServices: MlxSerialServices | undefined;
49
+ const kvBatchCapabilities = { delayedAffine: model instanceof Qwen35Model || model instanceof Gemma4Model };
50
+ const cachesBatchable = () => {
51
+ if (model instanceof UniversalDenseModel)
52
+ return !model.args.maskArray && !model.args.layerTypes?.includes("sliding_attention");
53
+ const caches = model.makeCache();
54
+ try {
55
+ const ssm = runtime.value("MLX_BUN_BATCH_SSM") !== "0";
56
+ return caches.every((cache) => cache instanceof KVCache || cache instanceof RotatingKVCache ||
57
+ isBatchableCache(cache) || (ssm && cache instanceof SSMCache));
58
+ } finally { disposeResources(caches); }
59
+ };
60
+ const supportsTargetRows = () => {
61
+ const caches = model.makeCache();
62
+ try { return caches.every(cache => targetRowLayoutFactory(cache) !== undefined); }
63
+ finally { disposeResources(caches); }
64
+ };
65
+ const speculative = draft?.provider.grouped && cachesBatchable() && supportsTargetRows()
66
+ ? bindSpeculativeGroupRequests(model, draft.provider, draft.numDraftTokens) : undefined;
67
+ const adapterState = "loraState" in model ? model.loraState : undefined;
68
+ return {
69
+ config: model.config, runtime,
70
+ configureContinuation: services => { continuationServices = services; },
71
+ continuationRequest(execution, options, prompt, onToken) {
72
+ if (!execution?.checkpoint || execution.mechanism !== "continuous") return undefined;
73
+ const services = continuationServices;
74
+ if (!services?.checkpoints || !services.checkpointPersistence)
75
+ throw new Error("qualified continuation requires bound persistence services");
76
+ return createOrdinaryContinuationRequest({ options, prompt, onToken, execution,
77
+ store: services.checkpoints, persistence: services.checkpointPersistence,
78
+ restore: entry => services.checkpoints!.restore(entry, model),
79
+ interval: services.checkpointEveryTokens!, identity: services.identity });
80
+ },
81
+ statePolicy: (execution, options, capacity) => execution?.pagedKv ? bindPagedRequestState(model, options, capacity) : undefined,
82
+ methodRequest: (execution, options) => execution?.method === "speculative" ? speculative?.(options) : undefined,
83
+ ...(adapterState ? { bindAdapterContext(adapters: string[], key: string): ExecutionContext {
84
+ const selected = [...adapters];
85
+ return { key, enter() {
86
+ const previous = adapterState.active;
87
+ adapterState.active = selected;
88
+ return () => { adapterState.active = previous; };
89
+ } };
90
+ } } : {}),
91
+ plan(request, options, scheduling) {
92
+ return resolveExecution(request, {
93
+ ...scheduling,
94
+ sharedCheckpoints: !!continuationServices?.checkpointPersistence &&
95
+ !request.hasDraft && !request.hasVision && !request.hasGrammar &&
96
+ !request.wantsLogprobs && !options.fill && !options.pagedKv,
97
+ adapterBatch: !!adapterState, pagedBatch: model instanceof Gemma4Model,
98
+ groupedMethods: speculative ? ["autoregressive", "speculative"] : ["autoregressive"],
99
+ speculativeLogprobs: scheduling.continuous && !!speculative,
100
+ sharedSpeculativeAdapters: scheduling.continuous && !!speculative && !!adapterState &&
101
+ draft?.provider.grouped?.supportsTargetAdapters === true,
102
+ turboQuantBatch: scheduling.quantizedBatch,
103
+ speculativeTurboQuant: scheduling.continuous && !!speculative && !!options.turboQuant,
104
+ method: model instanceof DiffusionGemmaModel ? "denoising" : "autoregressive",
105
+ compiledDecode: legacyCompiledDecodeAvailable(model),
106
+ grammarBatch: runtime.value("MLX_BUN_GRAMMAR_BATCH") !== "0",
107
+ speculativeKvQuant: (!(model instanceof Qwen35Model) || runtime.flag("MLX_BUN_QWEN_SPEC_KV4", true)) && (
108
+ (scheduling.continuous && !!speculative && (options.kvBits === 4 || options.kvBits === 8 || !!options.kvConfig?.length)) ||
109
+ (!options.kvConfig?.length && model instanceof Qwen35Model &&
110
+ (options.kvBits === 4 || (scheduling.continuous && !!speculative && options.kvBits === 8)) &&
111
+ (options.quantizedKvStart === 0 || (scheduling.continuous && !!speculative)))
112
+ ),
113
+ }, {
114
+ pagedKv: !!options.pagedKv, fill: !!options.fill,
115
+ compiledDecode: runtime.flag("MLX_BUN_COMPILED_DECODE", true),
116
+ grammarJump: runtime.flag("MLX_BUN_GRAMMAR_JUMP", false),
117
+ });
118
+ },
119
+ cachesBatchable,
120
+ kvBatchable(scheme) {
121
+ const caches = model.makeCache();
122
+ try {
123
+ return scheme.batchable(model.config,
124
+ (layer) => isPlainKvCache(caches[layer]) || isRotatingPlainCache(caches[layer]), caches.length,
125
+ kvBatchCapabilities);
126
+ } finally { disposeResources(caches); }
127
+ },
128
+ createBatchGroup: (options) => new MlxBatchExecutionGroup(model, { ...options, kvBatchCapabilities }),
129
+ };
130
+ }
@@ -0,0 +1,38 @@
1
+ import type { AutoregressiveGraph, GraphDescriptor, LogitSelection } from "../../inference/graph";
2
+ import type { MlxArray } from "../../mlx/array";
3
+
4
+ /** Structural input: generated and hand-written graphs need no union membership. */
5
+ export interface MlxGraphOperations<State> {
6
+ forwardHidden(ids: MlxArray, state: State): MlxArray;
7
+ forwardHiddenAsync?: (ids: MlxArray, state: State) => Promise<MlxArray>;
8
+ logitsFromHidden(hidden: MlxArray): MlxArray;
9
+ }
10
+
11
+ /** Bind once. No array wrapper, await, readback, or synchronization is added
12
+ * to synchronous forward calls. Existing quant-specific kernels stay inside
13
+ * the supplied operations. This adapter does not take ownership of weights. */
14
+ export function bindMlxGraph<State>(
15
+ operations: MlxGraphOperations<State>,
16
+ descriptor: Omit<GraphDescriptor, "backend" | "graphAbi">,
17
+ ): AutoregressiveGraph<MlxArray, State, MlxArray> {
18
+ const forward = operations.forwardHiddenAsync
19
+ ? operations.forwardHiddenAsync.bind(operations)
20
+ : operations.forwardHidden.bind(operations);
21
+ const project = operations.logitsFromHidden.bind(operations);
22
+ return {
23
+ descriptor: Object.freeze({ ...descriptor, backend: "mlx", graphAbi: "mlx-hidden-bsh-v1" }),
24
+ forwardHidden: forward,
25
+ projectLogits(hidden: MlxArray, selection: LogitSelection) {
26
+ if (selection.type === "all") return project(hidden);
27
+ const shape = hidden.shape;
28
+ if (shape.length !== 3) throw new Error("MLX hidden state must have shape [batch, positions, width]");
29
+ const [batch, positions, width] = shape as [number, number, number];
30
+ const start = selection.type === "last" ? positions - 1 : selection.start;
31
+ const end = selection.type === "last" ? positions : selection.end;
32
+ if (!Number.isInteger(start) || !Number.isInteger(end) || start < 0 || end <= start || end > positions)
33
+ throw new Error("invalid logits position selection");
34
+ const selected = hidden.slice([0, start, 0], [batch, end, width]);
35
+ try { return project(selected); } finally { selected.dispose(); }
36
+ },
37
+ };
38
+ }
@@ -0,0 +1,9 @@
1
+ import type { MlxArray } from "../../mlx/array";
2
+
3
+ /** A backend KV representation independent of row storage and scheduling.
4
+ * Inputs are borrowed. Encoding and decoding return caller-owned arrays.
5
+ * A codec may retain values in a rotated domain for attention to invert once. */
6
+ export interface KvCodec<Encoded> {
7
+ encode(keys: MlxArray, values: MlxArray): Encoded;
8
+ decode(encoded: Encoded, length: number, headDim: number, deferValues?: boolean): [MlxArray, MlxArray];
9
+ }
@@ -0,0 +1,133 @@
1
+ import type { KvSchemeOptions } from "../../kv-scheme";
2
+ import { KVCache, QuantizedKVCache, RotatingKVCache, RotatingQuantizedKVCache, TurboQuantKVCache, type Cache } from "../../model/gemma4-base";
3
+ import type { KvQuantSpec, TurboQuantScheme } from "../../config";
4
+ import * as ops from "../../mlx/ops";
5
+ import { clearCache } from "../../mlx/ffi";
6
+
7
+ import { DelayedRotatingQuantizedKVCache } from "../../model/delayed-rotating-quantized-kv";
8
+ import { DelayedQuantizedKVCache } from "../../model/delayed-quantized-kv";
9
+ import { DelayedTurboQuantKVCache } from "../../model/delayed-turboquant-kv";
10
+
11
+ export interface KvMaintenance {
12
+ (cache: Cache[]): void;
13
+ /** Bind state requiring row-local maintenance before shared decode. */
14
+ prepareBatch?(cache: Cache[]): void;
15
+ /** Bind all precision policies before a prefill cohort owns row boundaries. */
16
+ preparePrefill?(cache: Cache[]): void;
17
+ }
18
+
19
+ const unchanged = (_cache: Cache[]): void => {};
20
+ let warnedTurboRotating = false;
21
+
22
+ /** Port of mlx-lm maybe_quantize_kv_cache + BOTH halves of optiq serve's
23
+ * per-layer patched variant (incl. patch_rotating_to_quantized: rotating
24
+ * caches convert too — Phase 9):
25
+ * - per-layer bits/group_size selection (kvConfig overrides kvBits,
26
+ * matching optiq's --kv-config precedence; shipped kv_config.json
27
+ * files cover EVERY cache-owning layer, sliding ones included —
28
+ * verified 12B 48/48, 26B 30/30, e4b 24/24 distinct caches — so
29
+ * rotating quantization engages straight from the config; uniform
30
+ * kvBits — like optiq --kv-bits — reaches them too), and
31
+ * - STREAMING conversion (optiq streaming_kv_quant / serve.py
32
+ * patched_maybe_quantize): eval each layer's quantized triples and
33
+ * clear the buffer pool before building the next layer's conversion.
34
+ * Lazily batching every layer's toQuantized into one eval pins ALL
35
+ * layers' bf16 K/V as graph inputs alongside ALL quantized outputs —
36
+ * the exact transient optiq's fix kills (16.35 → 7.60 GB at 32k on a
37
+ * 24 GB Mac). Numerics untouched: same quantize math, only the eval
38
+ * ordering is forced (tests/parity/kv-quant.test.ts, tests/parity/rotating-kvq.test.ts). */
39
+ export function createKvMaintenance(options: Readonly<Omit<KvSchemeOptions, "kvConfig">> & {
40
+ readonly kvConfig?: readonly Readonly<KvQuantSpec>[];
41
+ }): KvMaintenance {
42
+ const { kvBits, kvConfig, turboQuant } = options;
43
+ if (turboQuant) {
44
+ const start = options.quantizedKvStart ?? 0;
45
+ const scheme = { ...turboQuant };
46
+ const maintain: KvMaintenance = (cache) => maybeTurboQuantizeKv(cache, scheme, start);
47
+ maintain.preparePrefill = (cache) => {
48
+ for (let layer = 0; layer < cache.length; layer++) {
49
+ const row = cache[layer]!;
50
+ if (row instanceof KVCache || row instanceof TurboQuantKVCache)
51
+ cache[layer] = new DelayedTurboQuantKVCache(scheme.kBits, scheme.vBits, start, maintain, row);
52
+ }
53
+ };
54
+ if (start > 0) maintain.prepareBatch = maintain.preparePrefill;
55
+ return maintain;
56
+ }
57
+ if (!kvBits && !kvConfig?.length) return unchanged;
58
+ const start = options.quantizedKvStart ?? (kvConfig?.length ? 0 : 5000);
59
+ const groupSize = options.kvGroupSize ?? 64;
60
+ // Resolve layer policy once when composing execution, never per token.
61
+ const byLayer = kvConfig?.length
62
+ ? new Map(kvConfig.map((entry) => [entry.layerIdx, { ...entry }]))
63
+ : null;
64
+ const maintain: KvMaintenance = (cache) => {
65
+ for (let i = 0; i < cache.length; i++) {
66
+ const c = cache[i]!;
67
+ const conversion = c.affineConversion ?? (c instanceof KVCache || c instanceof RotatingKVCache ? c : undefined);
68
+ if (!conversion || conversion.offset < start || conversion.offset === 0) continue;
69
+ const conversionOffset = conversion.offset;
70
+ // The populated-cache boundary is part of oracle parity: quantizing an
71
+ // empty cache would also quantize the first prefill.
72
+ if (byLayer) {
73
+ const entry = byLayer.get(i);
74
+ if (!entry) continue;
75
+ cache[i] = conversion.toQuantized(entry.groupSize, entry.bits);
76
+ } else {
77
+ cache[i] = conversion.toQuantized(groupSize, kvBits!);
78
+ }
79
+ if (start > 0) cache[i]!.minimumReusableOffset = conversionOffset;
80
+ // Materialize one layer before converting the next to bound the live
81
+ // bf16 source plus quantized destination to one conversion at a time.
82
+ ops.evalAll(cache[i]!.state());
83
+ clearCache();
84
+ }
85
+ };
86
+ maintain.preparePrefill = (cache) => {
87
+ for (let layer = 0; layer < cache.length; layer++) {
88
+ const row = cache[layer]!;
89
+ if (!(row instanceof KVCache || row instanceof QuantizedKVCache || row instanceof RotatingKVCache || row instanceof RotatingQuantizedKVCache)) continue;
90
+ const spec = byLayer ? byLayer.get(layer) : { bits: kvBits!, groupSize };
91
+ if (!spec) continue;
92
+ const rowMaintenance = createKvMaintenance({ kvBits: spec.bits, kvGroupSize: spec.groupSize, quantizedKvStart: start });
93
+ cache[layer] = row instanceof RotatingKVCache || row instanceof RotatingQuantizedKVCache
94
+ ? new DelayedRotatingQuantizedKVCache(row.maxSize, spec.groupSize, spec.bits, start, rowMaintenance, row)
95
+ : new DelayedQuantizedKVCache(spec.groupSize, spec.bits, start, rowMaintenance, row);
96
+ }
97
+ };
98
+ if (start > 0) maintain.prepareBatch = maintain.preparePrefill;
99
+ return maintain;
100
+ }
101
+
102
+ function maybeTurboQuantizeKv(cache: Cache[], scheme: TurboQuantScheme, start: number): void {
103
+ for (let i = 0; i < cache.length; i++) {
104
+ const c = cache[i]!;
105
+ if (c instanceof RotatingKVCache) {
106
+ if (!warnedTurboRotating) {
107
+ warnedTurboRotating = true;
108
+ console.warn(
109
+ "[turbo-quant] sliding-window (RotatingKVCache) layers stay bf16 in v1 " +
110
+ "(full-attention only) — docs/design/turboquant.md.",
111
+ );
112
+ }
113
+ continue;
114
+ }
115
+ const conversion = c.turboConversion ?? (c instanceof KVCache ? c : undefined);
116
+ if (!conversion || conversion.offset < start || conversion.offset === 0) continue;
117
+ const conversionOffset = conversion.offset;
118
+ const tq = c.turboConversion ? c.turboConversion.toTurboQuantized(scheme.kBits, scheme.vBits)
119
+ : TurboQuantKVCache.fromKVCache(c as KVCache, scheme.kBits, scheme.vBits);
120
+ if (start > 0) tq.minimumReusableOffset = conversionOffset;
121
+ cache[i] = tq;
122
+ // state() allocates fresh trimmed slice views for this cache kind
123
+ // (see evalCacheState) — dispose after materializing (throw included),
124
+ // or they leak.
125
+ const state = tq.state();
126
+ try {
127
+ ops.evalAll(state);
128
+ } finally {
129
+ for (const a of state) a.dispose();
130
+ }
131
+ clearCache();
132
+ }
133
+ }
@@ -0,0 +1,212 @@
1
+ import type { MlxArray } from "../../mlx/array";
2
+ import { Dtype } from "../../mlx/ffi";
3
+ import * as ops from "../../mlx/ops";
4
+ import { materializeCopy } from "../../mlx/materialize";
5
+ import { FullPrefillPadding } from "../../model/full-prefill-padding";
6
+ import type { Mask, PrefillPadding } from "../../model/gemma4-base";
7
+ import { cleanupFailure, disposeResources } from "../../engine/resources";
8
+
9
+ /** Borrowed tensor planes with shared token positions. Plane shapes may differ
10
+ * in head width and dtype. Every plane uses [row, head, token, field]. */
11
+ export interface KvTensorRowView {
12
+ readonly planes: readonly MlxArray[];
13
+ readonly rowOffsets: readonly number[];
14
+ readonly leftPad: readonly number[];
15
+ }
16
+
17
+ /** Position and membership operations shared by packed KV representations.
18
+ * A codec supplies tensor planes; this owner never encodes or decodes them. */
19
+ export class KvTensorRows implements KvTensorRowView {
20
+ planes: MlxArray[] = [];
21
+ rowOffsets: number[] = [];
22
+ leftPad: number[] = [];
23
+ #rope: MlxArray | undefined;
24
+ #beforeRound: number[] | undefined;
25
+ readonly #padding = new FullPrefillPadding();
26
+
27
+ restorePrefillEnds(ends: readonly number[] | undefined): void { this.#padding.restoreEnds(ends); }
28
+ preparePrefill(padding: PrefillPadding): void {
29
+ this.#padding.prepare(this, padding); this.#positionsChanged();
30
+ }
31
+ finalizePrefill(): void {
32
+ const next = this.#padding.finalize(this.planes, this);
33
+ if (next) this.#replace(next, this.rowOffsets, this.leftPad);
34
+ }
35
+
36
+ /** Snapshot logical validity without changing physical row alignment. */
37
+ captureDonorValidity(): Pick<import("../../model/gemma4-base").KvDonorRows, "offsets" | "starts" | "ends"> {
38
+ const offsets = this.rowOffsets.map((offset, row) => Math.max(0, this.#padding.validOffset(offset, row)));
39
+ return { offsets, starts: [...this.leftPad], ends: offsets.map((offset, row) => offset + this.leftPad[row]!) };
40
+ }
41
+ get offset(): number { return Math.max(0, ...this.#ends()); }
42
+ get batchSize(): number | null { return this.rowOffsets.length || null; }
43
+ #ends(): number[] { return this.rowOffsets.map((offset, row) => offset + this.leftPad[row]!); }
44
+ get ropeOffsetArr(): MlxArray | undefined {
45
+ if (this.leftPad.every(pad => pad === 0) && this.rowOffsets.every(offset => offset === this.rowOffsets[0])) return undefined;
46
+ return this.#rope ??= ops.fromInt32(this.rowOffsets, [this.rowOffsets.length]);
47
+ }
48
+ #positionsChanged(): void { this.#rope?.dispose(); this.#rope = undefined; }
49
+ bytesPerToken(): number {
50
+ return this.planes.length && this.rowOffsets.length ? this.planes.reduce((bytes, plane) => bytes + plane.nbytes, 0) /
51
+ (this.rowOffsets.length * this.planes[0]!.shape[2]!) : 0;
52
+ }
53
+ trim(count: number): void {
54
+ this.rowOffsets = this.rowOffsets.map(offset => offset - count); this.#positionsChanged();
55
+ }
56
+ specRoundBegin(): void { this.#beforeRound = [...this.rowOffsets]; }
57
+ specRoundCommit(): void { this.#beforeRound = undefined; }
58
+ specRoundRollback(keep: number | readonly number[]): void {
59
+ this.rowOffsets = this.#beforeRound!.map((offset, row) => offset + (typeof keep === "number" ? keep : keep[row]!));
60
+ this.#beforeRound = undefined; this.#positionsChanged();
61
+ }
62
+ makeMask(N: number, window: number | null): Mask {
63
+ const B = this.rowOffsets.length, ends = this.#ends(), S = this.offset + N;
64
+ if (window === null && this.leftPad.every(pad => pad === 0) && ends.every(end => end === ends[0]))
65
+ return { mode: N === 1 ? "" : "causal", arr: null };
66
+ using starts = ops.fromInt32(ends, [B, 1, 1, 1]);
67
+ using relative = ops.arange(0, N, 1, Dtype.int32);
68
+ using queries = ops.reshape(relative, [1, 1, N, 1]);
69
+ using position = ops.add(starts, queries);
70
+ using indices = ops.arange(0, S, 1, Dtype.int32);
71
+ using keys = ops.reshape(indices, [1, 1, 1, S]);
72
+ using pads = ops.fromInt32(this.leftPad, [B, 1, 1, 1]);
73
+ using causal = ops.lessEqual(keys, position);
74
+ using valid = ops.greaterEqual(keys, pads);
75
+ const mask = ops.logicalAnd(causal, valid);
76
+ if (window === null) return { mode: "array", arr: mask };
77
+ using windowSize = ops.fromInt32([window], []);
78
+ using limit = ops.add(keys, windowSize);
79
+ using within = ops.less(position, limit);
80
+ try { return { mode: "array", arr: ops.logicalAnd(mask, within) }; }
81
+ finally { mask.dispose(); }
82
+ }
83
+ #replace(planes: MlxArray[], offsets: number[], pads: number[]): void {
84
+ const previous = this.planes;
85
+ this.planes = planes; this.rowOffsets = offsets; this.leftPad = pads;
86
+ this.#positionsChanged(); disposeResources(previous);
87
+ }
88
+ append(inputs: readonly MlxArray[]): void {
89
+ const B = this.rowOffsets.length, N = inputs[0]!.shape[2]!, ends = this.#ends();
90
+ const needed = Math.max(...ends) + N, capacity = Math.ceil(needed / 256) * 256;
91
+ const common = ends.every(end => end === ends[0]);
92
+ using positions = common ? null : ops.fromInt32(ends.flatMap(end =>
93
+ Array.from({ length: N }, (_, position) => end + position)), [B, 1, N, 1]);
94
+ const next: MlxArray[] = [];
95
+ try {
96
+ for (const [index, input] of inputs.entries()) {
97
+ const old = this.planes[index];
98
+ let base: MlxArray;
99
+ if (!old) base = ops.zeros([B, input.shape[1]!, capacity, input.shape[3]!], input.dtype);
100
+ else if (old.shape[2]! >= needed) base = old;
101
+ else {
102
+ using padding = ops.zeros([B, old.shape[1]!, capacity - old.shape[2]!, old.shape[3]!], old.dtype);
103
+ base = ops.concatAxis([old, padding], 2);
104
+ }
105
+ try {
106
+ const updated = common
107
+ ? ops.sliceUpdate(base, input, [0, 0, ends[0]!, 0], [B, base.shape[1]!, ends[0]! + N, base.shape[3]!])
108
+ : ops.putAlongAxis(base, positions!, input, 2);
109
+ next.push(updated);
110
+ } finally { if (base !== old) base.dispose(); }
111
+ }
112
+ } catch (error) { return cleanupFailure(error, () => disposeResources(next)); }
113
+ this.#replace(next, this.rowOffsets.map(offset => offset + N), this.leftPad);
114
+ }
115
+ mergeRows(rows: readonly KvTensorRowView[]): void {
116
+ const next: MlxArray[] = [], held: MlxArray[] = [];
117
+ let offsets: number[], pads: number[];
118
+ try {
119
+ if (rows.length === 1) {
120
+ const row = rows[0]!;
121
+ for (const plane of row.planes) next.push(ops.copyOf(plane));
122
+ offsets = [...row.rowOffsets]; pads = [...row.leftPad];
123
+ } else {
124
+ const widths = rows.map(row => Math.max(0, ...row.rowOffsets.map((offset, i) => offset + row.leftPad[i]!)));
125
+ const width = Math.max(0, ...widths);
126
+ if (width) {
127
+ const prototype = rows.find((_, index) => widths[index]! > 0)!;
128
+ for (const [field, geometry] of prototype.planes.entries()) {
129
+ const pieces = rows.map((row, index) => {
130
+ const active = widths[index]!;
131
+ if (!active) {
132
+ const empty = ops.zeros([row.rowOffsets.length, geometry.shape[1]!, width, geometry.shape[3]!], geometry.dtype);
133
+ held.push(empty); return empty;
134
+ }
135
+ const plane = row.planes[field]!;
136
+ const view = plane.slice([0, 0, 0, 0], [row.rowOffsets.length, plane.shape[1]!, active, plane.shape[3]!]);
137
+ held.push(view);
138
+ if (active === width) return view;
139
+ using padding = ops.zeros([row.rowOffsets.length, plane.shape[1]!, width - active, plane.shape[3]!], plane.dtype);
140
+ const padded = ops.concatAxis([padding, view], 2); held.push(padded); return padded;
141
+ });
142
+ next.push(ops.concatAxis(pieces, 0));
143
+ }
144
+ }
145
+ offsets = rows.flatMap(row => [...row.rowOffsets]);
146
+ pads = rows.flatMap((row, index) => row.leftPad.map(pad => pad + width - widths[index]!));
147
+ }
148
+ } catch (error) { return cleanupFailure(error, () => disposeResources(next)); }
149
+ finally { disposeResources(held); }
150
+ this.#replace(next, offsets, pads);
151
+ }
152
+ /** Preserve caller-owned physical positions when changing representation.
153
+ * Live tensor bytes are copied; padding never participates in a codec. */
154
+ alignRows(leftPad: readonly number[]): void {
155
+ if (leftPad.every((pad, row) => pad === this.leftPad[row])) return;
156
+ const width = Math.max(0, ...this.rowOffsets.map((offset, row) => offset + leftPad[row]!));
157
+ const rows: MlxArray[][] = [], planes: MlxArray[] = [];
158
+ try {
159
+ for (let row = 0; row < this.rowOffsets.length; row++) rows.push(this.extractRow(row));
160
+ for (let field = 0; field < this.planes.length; field++) {
161
+ const parts: MlxArray[] = [];
162
+ try {
163
+ for (let row = 0; row < rows.length; row++) {
164
+ const geometry = this.planes[field]!, live = rows[row]![field];
165
+ using before = ops.zeros([1, geometry.shape[1]!, leftPad[row]!, geometry.shape[3]!], geometry.dtype);
166
+ using after = ops.zeros([1, geometry.shape[1]!, width - leftPad[row]! - this.rowOffsets[row]!, geometry.shape[3]!], geometry.dtype);
167
+ parts.push(ops.concatAxis(live ? [before, live, after] : [before, after], 2));
168
+ }
169
+ planes.push(ops.concatAxis(parts, 0));
170
+ } finally { disposeResources(parts); }
171
+ }
172
+ } catch (error) { return cleanupFailure(error, () => disposeResources(planes)); }
173
+ finally { disposeResources(rows.flat()); }
174
+ this.#replace(planes, [...this.rowOffsets], [...leftPad]);
175
+ }
176
+ filterRows(keep: readonly number[]): void {
177
+ if (!keep.length) { this.dispose(); return; }
178
+ const next: MlxArray[] = [];
179
+ using indices = this.planes.length ? ops.fromInt32([...keep], [keep.length]) : null;
180
+ const pads = keep.map(row => this.leftPad[row]!);
181
+ const sharedPadding = Math.min(...pads);
182
+ try {
183
+ for (const plane of this.planes) {
184
+ const selected = ops.takeAxis(plane, indices!, 0);
185
+ if (!sharedPadding) next.push(selected);
186
+ else {
187
+ try { next.push(selected.slice([0, 0, sharedPadding, 0], [...selected.shape])); }
188
+ finally { selected.dispose(); }
189
+ }
190
+ }
191
+ }
192
+ catch (error) { return cleanupFailure(error, () => disposeResources(next)); }
193
+ this.#replace(next, keep.map(row => this.rowOffsets[row]!), pads.map(pad => pad - sharedPadding));
194
+ this.#padding.filter(keep);
195
+ }
196
+ extractRow(row: number): MlxArray[] {
197
+ const start = this.leftPad[row]!, count = this.rowOffsets[row]!, result: MlxArray[] = [];
198
+ if (!count) return result;
199
+ try {
200
+ for (const plane of this.planes) {
201
+ using view = plane.slice([row, 0, start, 0], [row + 1, plane.shape[1]!, start + count, plane.shape[3]!]);
202
+ result.push(materializeCopy(view));
203
+ }
204
+ return result;
205
+ } catch (error) { return cleanupFailure(error, () => disposeResources(result)); }
206
+ }
207
+ dispose(): void {
208
+ const previous = this.planes;
209
+ this.planes = []; this.rowOffsets = []; this.leftPad = []; this.#beforeRound = undefined; this.#padding.clear();
210
+ this.#positionsChanged(); disposeResources(previous);
211
+ }
212
+ }