mlx-bun 0.4.0 → 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 (601) hide show
  1. package/README.md +1453 -88
  2. package/THIRD_PARTY_NOTICES.md +882 -0
  3. package/bin/mlx-bun.convert.mjs +4 -0
  4. package/bin/mlx-bun.fuse.mjs +4 -0
  5. package/bin/mlx-bun.generate.mjs +4 -0
  6. package/bin/mlx-bun.lora.mjs +4 -0
  7. package/bin/mlx-bun.mjs +13 -21
  8. package/bin/mlx-bun.server.mjs +4 -0
  9. package/bin/mlx-bun.upload.mjs +4 -0
  10. package/dist/web/app.js +9584 -0
  11. package/package.json +50 -53
  12. package/src/cli/ane-install.ts +76 -0
  13. package/src/cli/args.ts +179 -0
  14. package/src/cli/engine-entry.ts +68 -0
  15. package/src/cli/inference.ts +214 -0
  16. package/src/cli/job-entry.ts +97 -0
  17. package/src/cli/library-host.ts +117 -0
  18. package/src/cli/main.ts +57 -0
  19. package/src/cli/memory-engine.ts +163 -0
  20. package/src/cli/memory.ts +36 -0
  21. package/src/cli/mlx-lm-aliases.ts +309 -0
  22. package/src/cli/model-choice.ts +33 -0
  23. package/src/cli/model-selection.ts +84 -0
  24. package/src/cli/module-host.ts +11 -0
  25. package/src/cli/module-verbs.ts +50 -0
  26. package/src/cli/numerical-policy.ts +12 -0
  27. package/src/cli/perplexity.ts +89 -0
  28. package/src/cli/serve-host.ts +423 -0
  29. package/src/cli/serve-isolated.ts +217 -0
  30. package/src/cli/serve-options.ts +106 -0
  31. package/src/cli/serve-state.ts +205 -0
  32. package/src/cli/serve.ts +500 -0
  33. package/src/cli/served-model-host.ts +102 -0
  34. package/src/cli/server-entry.ts +148 -0
  35. package/src/cli/serving-unit.ts +177 -0
  36. package/src/{tui.ts → cli/terminal.ts} +13 -8
  37. package/src/cli/worker-adapters.ts +34 -0
  38. package/src/cli/worker-entry.ts +272 -0
  39. package/src/cli/worker-unit.ts +179 -0
  40. package/src/engine/adapter-operation.ts +26 -0
  41. package/src/engine/cache-services.ts +114 -0
  42. package/src/engine/completion.ts +39 -0
  43. package/src/engine/generation-gateway.ts +358 -0
  44. package/src/engine/index.ts +59 -0
  45. package/src/engine/kv-budget.ts +120 -0
  46. package/src/engine/media-preparation.ts +232 -0
  47. package/src/engine/model-binding.ts +24 -0
  48. package/src/engine/model-host.ts +513 -0
  49. package/src/engine/model-serving.ts +89 -0
  50. package/src/{serve → engine}/preparation.ts +10 -8
  51. package/src/{serve → engine}/session-completion-engine.ts +6 -6
  52. package/src/engine/telemetry.ts +109 -0
  53. package/src/hub/downloads.ts +116 -0
  54. package/src/jobs/db.ts +16 -7
  55. package/src/jobs/events.ts +29 -0
  56. package/src/jobs/executable.ts +5 -0
  57. package/src/jobs/host.ts +51 -0
  58. package/src/jobs/in-process.ts +55 -0
  59. package/src/{contracts/jobs.ts → jobs/protocol.ts} +7 -9
  60. package/src/jobs/runner.ts +150 -231
  61. package/src/jobs/service.ts +75 -0
  62. package/src/jobs/sse.ts +59 -23
  63. package/src/jobs/worker-memory.ts +46 -0
  64. package/src/jobs/worker-process.ts +163 -0
  65. package/src/jobs/worker-supervisor.ts +258 -0
  66. package/src/modules.ts +58 -0
  67. package/src/publishing/catalog-hub.ts +18 -0
  68. package/src/publishing/credentials.ts +31 -0
  69. package/src/publishing/upload.ts +37 -0
  70. package/src/residency/leased-adapters.ts +21 -0
  71. package/src/residency/local-records.ts +16 -0
  72. package/src/residency/model-residency.ts +405 -0
  73. package/src/residency/record-index.ts +28 -0
  74. package/src/residency/resident-estimate.ts +50 -0
  75. package/src/{anthropic.ts → server/anthropic.ts} +3 -81
  76. package/src/server/cache-routes.ts +36 -0
  77. package/src/{serve → server}/chat-request.ts +12 -10
  78. package/src/{serve → server}/chat-stage.ts +27 -22
  79. package/src/{client.ts → server/client.ts} +28 -2
  80. package/src/{serve → server}/completion-executor.ts +42 -42
  81. package/src/server/decision-body.ts +55 -0
  82. package/src/server/decision-routes.ts +134 -0
  83. package/src/server/decision-wire.ts +228 -0
  84. package/src/{serve → server}/discovery-routes.ts +42 -83
  85. package/src/server/generated-token-history.ts +57 -0
  86. package/src/{serve → server}/http.ts +25 -13
  87. package/src/{serve → server}/inference-request.ts +5 -5
  88. package/src/server/job-routes.ts +20 -0
  89. package/src/server/media-prompt.ts +63 -0
  90. package/src/server/memory-completion-client.ts +46 -0
  91. package/src/server/model-routes.ts +192 -0
  92. package/src/{serve → server}/openai-wire.ts +3 -2
  93. package/src/{serve → server}/pipeline.ts +1 -1
  94. package/src/server/prompt-builder.ts +13 -0
  95. package/src/server/prompt-contracts.ts +17 -0
  96. package/src/server/proxy-routes.ts +187 -0
  97. package/src/server/publishing-routes.ts +41 -0
  98. package/src/{serve → server}/request-plan.ts +8 -8
  99. package/src/{serve → server}/request-prep.ts +82 -68
  100. package/src/{serve → server}/responses-client.ts +30 -13
  101. package/src/{responses.ts → server/responses.ts} +12 -93
  102. package/src/server/routes.ts +205 -0
  103. package/src/server/start.ts +72 -0
  104. package/src/server/status-routes.ts +108 -0
  105. package/src/{serve → server}/text-completion-stage.ts +25 -4
  106. package/src/server/text-prompt.ts +12 -0
  107. package/src/{serve → server}/token-streams.ts +36 -38
  108. package/src/server/worker-routes.ts +311 -0
  109. package/src/storage/paths.ts +61 -0
  110. package/src/web/assets.ts +37 -0
  111. package/src/web/{src → browser}/api.ts +5 -23
  112. package/src/web/browser/chat-host.ts +17 -0
  113. package/src/web/browser/installed-panels.ts +6 -0
  114. package/src/web/browser/main.ts +55 -0
  115. package/src/web/browser/markdown.ts +279 -0
  116. package/src/web/browser/memory-panel.ts +9 -0
  117. package/src/web/browser/palette.ts +64 -0
  118. package/src/web/browser/protocol.ts +13 -0
  119. package/src/web/browser/shell.ts +467 -0
  120. package/src/web/{src → browser}/status.ts +32 -36
  121. package/src/web/build.ts +51 -0
  122. package/src/web/public/app.html +1054 -0
  123. package/src/web/{sw.js → public/sw.js} +4 -3
  124. package/src/web/{vendor → public/vendor}/hljs-theme.css +2 -2
  125. package/src/web/{vendor → public/vendor}/hljs.js +2 -2
  126. package/THIRD_PARTY_LICENSES.md +0 -51
  127. package/docs/README.md +0 -94
  128. package/docs/archive/hlg-sampling.md +0 -350
  129. package/docs/archive/investigations/audio-input-plan.md +0 -356
  130. package/docs/archive/investigations/chunk-finetune-experiment.md +0 -84
  131. package/docs/archive/investigations/colibri-glm52-port.md +0 -1486
  132. package/docs/archive/investigations/colibri-oracle-pin.md +0 -1284
  133. package/docs/archive/investigations/curve-bisector-routing.md +0 -123
  134. package/docs/archive/investigations/decode-roofline-lookagain.md +0 -348
  135. package/docs/archive/investigations/diffusion-gemma-port.md +0 -602
  136. package/docs/archive/investigations/dspark-handoff.md +0 -224
  137. package/docs/archive/investigations/expert-offload-single-user-moe.md +0 -292
  138. package/docs/archive/investigations/faithful-l1-consolidation.md +0 -310
  139. package/docs/archive/investigations/hlg-sampling-investigation.md +0 -970
  140. package/docs/archive/investigations/indexshare-performance-spike.md +0 -357
  141. package/docs/archive/investigations/kernel-perf-review-2026-07.md +0 -171
  142. package/docs/archive/investigations/lab-build-journal.md +0 -157
  143. package/docs/archive/investigations/minicpm5-decode-megakernel.md +0 -489
  144. package/docs/archive/investigations/openjarvis-fit.md +0 -198
  145. package/docs/archive/investigations/openwiki-evaluation.md +0 -249
  146. package/docs/archive/investigations/optimization_plan.md +0 -346
  147. package/docs/archive/investigations/orpo-base-uf-experiment-and-directions.md +0 -120
  148. package/docs/archive/investigations/orpo-flash-cce-pin-leak.md +0 -167
  149. package/docs/archive/investigations/orpo-uf-testing-handoff.md +0 -126
  150. package/docs/archive/investigations/pareto-specialized-runtime-findings.md +0 -92
  151. package/docs/archive/investigations/pi-builtin-investigation.md +0 -308
  152. package/docs/archive/investigations/pre-colibri-stabilization.md +0 -329
  153. package/docs/archive/investigations/qwen38-27b-campaign-log.md +0 -1092
  154. package/docs/archive/investigations/segmented-backward-handoff.md +0 -148
  155. package/docs/archive/investigations/starter-model-port-handoff.md +0 -342
  156. package/docs/archive/investigations/steel-flash-cce-handoff.md +0 -489
  157. package/docs/archive/investigations/the-dreaming-handoff.md +0 -141
  158. package/docs/archive/investigations/trainer-validation-experiment.md +0 -173
  159. package/docs/archive/planning/chat-ui-vision-memory-first.md +0 -199
  160. package/docs/archive/planning/chat-ui-vision.md +0 -50
  161. package/docs/archive/planning/chunk-task-roadmap.md +0 -77
  162. package/docs/archive/planning/curve-sampler-research-plan.md +0 -331
  163. package/docs/archive/planning/journal.md +0 -316
  164. package/docs/archive/planning/memory-docs-and-dag-plan.md +0 -194
  165. package/docs/archive/planning/pi-integration-review.md +0 -178
  166. package/docs/archive/planning/release-notes-v0.0.10.md +0 -57
  167. package/docs/archive/planning/release-notes-v0.0.11.md +0 -239
  168. package/docs/archive/planning/release-notes-v0.0.12.md +0 -80
  169. package/docs/archive/planning/release-notes-v0.0.13.md +0 -77
  170. package/docs/archive/planning/release-notes-v0.0.9.md +0 -122
  171. package/docs/archive/planning/release-notes-v0.2.0.md +0 -49
  172. package/docs/archive/planning/release-notes-v0.3.0.md +0 -35
  173. package/docs/archive/planning/web-ui-pass-plan.md +0 -213
  174. package/docs/archive/planning/website-readme-pass-plan.md +0 -224
  175. package/docs/design/batching.md +0 -1841
  176. package/docs/design/decode-speed-program.md +0 -2349
  177. package/docs/design/dreaming-nightly-pipeline.md +0 -684
  178. package/docs/design/generic-model-support.md +0 -705
  179. package/docs/design/kv-cache.md +0 -824
  180. package/docs/design/orpo-training.md +0 -680
  181. package/docs/design/speculative-decoding.md +0 -1990
  182. package/docs/design/turboquant.md +0 -2212
  183. package/docs/design/unified-engine-frontier-plan.md +0 -1880
  184. package/docs/design/web-chat-redesign.md +0 -695
  185. package/docs/planning/PRODUCT_ROADMAP.md +0 -594
  186. package/docs/planning/ResearchTopics.md +0 -119
  187. package/docs/planning/release-notes-v0.4.0.md +0 -45
  188. package/docs/planning/video-series.md +0 -421
  189. package/docs/reference/benchmarks.md +0 -3613
  190. package/docs/reference/cli.md +0 -585
  191. package/docs/reference/distribution.md +0 -355
  192. package/docs/reference/environment.md +0 -398
  193. package/docs/reference/glossary.md +0 -39
  194. package/docs/reference/library-api.md +0 -674
  195. package/docs/reference/memory.md +0 -260
  196. package/docs/reference/models.md +0 -334
  197. package/docs/reference/server-api.md +0 -1775
  198. package/docs/reference/server-config.md +0 -846
  199. package/docs/reference/training.md +0 -462
  200. package/docs/reference/troubleshooting.md +0 -158
  201. package/src/admission-plan.ts +0 -18
  202. package/src/audio/conformer.ts +0 -647
  203. package/src/audio/decode.ts +0 -133
  204. package/src/audio/features.ts +0 -202
  205. package/src/audio/transcode.ts +0 -67
  206. package/src/backends/mlx/assistant-target.ts +0 -46
  207. package/src/backends/mlx/autoregressive-draft-rows.ts +0 -120
  208. package/src/backends/mlx/autoregressive.ts +0 -108
  209. package/src/backends/mlx/batch-group.ts +0 -1790
  210. package/src/backends/mlx/cache-attachment.ts +0 -67
  211. package/src/backends/mlx/cache-layout.ts +0 -31
  212. package/src/backends/mlx/checkpoint-state.ts +0 -53
  213. package/src/backends/mlx/continuation-persistence.ts +0 -106
  214. package/src/backends/mlx/continuation-request.ts +0 -43
  215. package/src/backends/mlx/continuation.ts +0 -77
  216. package/src/backends/mlx/diffusion.ts +0 -39
  217. package/src/backends/mlx/draft-target.ts +0 -32
  218. package/src/backends/mlx/evaluation.ts +0 -105
  219. package/src/backends/mlx/fill-append.ts +0 -45
  220. package/src/backends/mlx/full-kv-row-append.ts +0 -32
  221. package/src/backends/mlx/full-kv-row-donor.ts +0 -54
  222. package/src/backends/mlx/full-transitioning-kv-rows.ts +0 -65
  223. package/src/backends/mlx/gateway-binding.ts +0 -130
  224. package/src/backends/mlx/graph.ts +0 -38
  225. package/src/backends/mlx/kv-codec.ts +0 -9
  226. package/src/backends/mlx/kv-maintenance.ts +0 -133
  227. package/src/backends/mlx/kv-tensor-rows.ts +0 -212
  228. package/src/backends/mlx/memory-client.ts +0 -189
  229. package/src/backends/mlx/methods.ts +0 -90
  230. package/src/backends/mlx/model-prompt.ts +0 -164
  231. package/src/backends/mlx/model-serving.ts +0 -79
  232. package/src/backends/mlx/prefill-cohort.ts +0 -89
  233. package/src/backends/mlx/prefill-rows.ts +0 -200
  234. package/src/backends/mlx/prefill.ts +0 -33
  235. package/src/backends/mlx/projected-context-rows.ts +0 -72
  236. package/src/backends/mlx/request-policy.ts +0 -20
  237. package/src/backends/mlx/request-state-policy.ts +0 -41
  238. package/src/backends/mlx/rollback.ts +0 -89
  239. package/src/backends/mlx/row-sampling.ts +0 -49
  240. package/src/backends/mlx/serial-executor.ts +0 -242
  241. package/src/backends/mlx/speculative-group.ts +0 -359
  242. package/src/backends/mlx/speculative-round.ts +0 -161
  243. package/src/backends/mlx/speculative.ts +0 -114
  244. package/src/backends/mlx/state-rows.ts +0 -104
  245. package/src/backends/mlx/state-views.ts +0 -46
  246. package/src/backends/mlx/target-layout-capability.ts +0 -35
  247. package/src/backends/mlx/text-engine.ts +0 -73
  248. package/src/backends/mlx/transitioning-kv-rows.ts +0 -165
  249. package/src/chat-template.ts +0 -382
  250. package/src/cli.ts +0 -3168
  251. package/src/config.ts +0 -399
  252. package/src/contracts/completion.ts +0 -16
  253. package/src/contracts/execution.ts +0 -60
  254. package/src/contracts/generation.ts +0 -103
  255. package/src/contracts/host.ts +0 -7
  256. package/src/contracts/pi-provider.ts +0 -30
  257. package/src/contracts/pi.ts +0 -259
  258. package/src/contracts/prefix-cache.ts +0 -23
  259. package/src/contracts/resources.ts +0 -25
  260. package/src/contracts/sampling.ts +0 -23
  261. package/src/contracts/scheduling.ts +0 -45
  262. package/src/contracts/tsconfig.json +0 -14
  263. package/src/dataset/generators.ts +0 -1087
  264. package/src/dataset/index.ts +0 -12
  265. package/src/dataset/job.ts +0 -81
  266. package/src/dataset/llm.ts +0 -71
  267. package/src/dataset/registry.ts +0 -528
  268. package/src/diffusion/diffusion-generate.ts +0 -507
  269. package/src/download.ts +0 -505
  270. package/src/embed.ts +0 -77
  271. package/src/engine/admission.ts +0 -59
  272. package/src/engine/cancellation.ts +0 -38
  273. package/src/engine/engine.ts +0 -56
  274. package/src/engine/execution-coordinator.ts +0 -70
  275. package/src/engine/execution-plan.ts +0 -53
  276. package/src/engine/resources.ts +0 -53
  277. package/src/engine/scheduler.ts +0 -72
  278. package/src/engine/session.ts +0 -247
  279. package/src/eval/README.md +0 -130
  280. package/src/eval/ifeval.ts +0 -81
  281. package/src/eval/kl-prompts.ts +0 -29
  282. package/src/eval/kl.ts +0 -590
  283. package/src/eval/perplexity.ts +0 -164
  284. package/src/eval/quality-db.ts +0 -92
  285. package/src/eval/reference-logits.ts +0 -207
  286. package/src/eval/runner.ts +0 -124
  287. package/src/eval/score.ts +0 -49
  288. package/src/eval/tasks/bfcl.ts +0 -535
  289. package/src/eval/tasks/gsm8k.ts +0 -98
  290. package/src/eval/tasks/hashhop.ts +0 -139
  291. package/src/eval/tasks/humaneval.ts +0 -275
  292. package/src/eval/tasks/ifeval.ts +0 -525
  293. package/src/eval/tasks/mmlu.ts +0 -157
  294. package/src/eval/ultrafeedback.ts +0 -60
  295. package/src/evaldb.ts +0 -199
  296. package/src/expert-io.ts +0 -393
  297. package/src/expert-offload-build.ts +0 -77
  298. package/src/expert-offload.ts +0 -76
  299. package/src/expert-residency.ts +0 -1134
  300. package/src/expert-usage.ts +0 -415
  301. package/src/fill/echo-index.ts +0 -188
  302. package/src/fill/fill-session.ts +0 -452
  303. package/src/fill/proposal.ts +0 -68
  304. package/src/fill/schema-rows.ts +0 -506
  305. package/src/fill/tool-boundary.ts +0 -103
  306. package/src/fit.ts +0 -249
  307. package/src/generate.ts +0 -1346
  308. package/src/grammar.ts +0 -591
  309. package/src/harness-pi.ts +0 -184
  310. package/src/hf-push.ts +0 -628
  311. package/src/hub-rest.ts +0 -242
  312. package/src/index.ts +0 -63
  313. package/src/inference/denoising.ts +0 -17
  314. package/src/inference/draft-acceptance.ts +0 -41
  315. package/src/inference/draft-output.ts +0 -49
  316. package/src/inference/graph.ts +0 -33
  317. package/src/inference/prefill.ts +0 -39
  318. package/src/inference/rollback.ts +0 -7
  319. package/src/jobs/index.ts +0 -31
  320. package/src/jobs/job-entry.ts +0 -107
  321. package/src/jobs/task-client.ts +0 -19
  322. package/src/jobs/types.ts +0 -2
  323. package/src/kv-scheme.ts +0 -257
  324. package/src/kv-store.ts +0 -1099
  325. package/src/lab/README.md +0 -18
  326. package/src/lab/curve/curve-designer.html +0 -303
  327. package/src/lab/curve/curve-sampler.ts +0 -122
  328. package/src/lab/expert-trace/expert-trace.ts +0 -69
  329. package/src/lab/paged-kv/paged-kv-rows.ts +0 -83
  330. package/src/lab/paged-kv/paged-kv.ts +0 -270
  331. package/src/library.ts +0 -40
  332. package/src/lora.ts +0 -408
  333. package/src/md-modules.d.ts +0 -49
  334. package/src/media-fetch.ts +0 -442
  335. package/src/memory/article.ts +0 -558
  336. package/src/memory/chunk-validation.ts +0 -150
  337. package/src/memory/chunk.ts +0 -318
  338. package/src/memory/cluster.ts +0 -351
  339. package/src/memory/coverage.ts +0 -134
  340. package/src/memory/crosslink.ts +0 -0
  341. package/src/memory/db.ts +0 -253
  342. package/src/memory/entity.ts +0 -203
  343. package/src/memory/gate.ts +0 -187
  344. package/src/memory/history.ts +0 -152
  345. package/src/memory/ingest.ts +0 -335
  346. package/src/memory/model.ts +0 -183
  347. package/src/memory/normalize.ts +0 -671
  348. package/src/memory/parse.ts +0 -22
  349. package/src/memory/pipeline.ts +0 -275
  350. package/src/memory/prompts.ts +0 -65
  351. package/src/memory/query.ts +0 -334
  352. package/src/memory/reconcile.ts +0 -734
  353. package/src/memory/redirect.ts +0 -108
  354. package/src/memory/reindex.ts +0 -325
  355. package/src/memory/resolve.ts +0 -307
  356. package/src/memory/rest.ts +0 -245
  357. package/src/memory/route.ts +0 -272
  358. package/src/memory/schedule.ts +0 -165
  359. package/src/memory/stages.ts +0 -777
  360. package/src/memory/synthesize.ts +0 -1638
  361. package/src/memory/tools.ts +0 -749
  362. package/src/memory/vault.ts +0 -1194
  363. package/src/memory/wikify.ts +0 -1064
  364. package/src/mlx/array.ts +0 -388
  365. package/src/mlx/autograd.ts +0 -304
  366. package/src/mlx/checkpoint.ts +0 -149
  367. package/src/mlx/compile.ts +0 -168
  368. package/src/mlx/custom-vjp.ts +0 -188
  369. package/src/mlx/ffi.ts +0 -512
  370. package/src/mlx/materialize.ts +0 -23
  371. package/src/mlx/metal-kernel.ts +0 -159
  372. package/src/mlx/ops.ts +0 -1021
  373. package/src/mlx/quantized-rows.ts +0 -36
  374. package/src/mlx/token-bitmask.ts +0 -52
  375. package/src/mlx/turboquant-kv-decode.ts +0 -82
  376. package/src/mlx/turboquant-kv-inverse.ts +0 -122
  377. package/src/mlx/turboquant-ops.ts +0 -861
  378. package/src/mlx/turboquant-tables.ts +0 -237
  379. package/src/mmap.ts +0 -90
  380. package/src/model/artifact-identity.ts +0 -73
  381. package/src/model/batched-kv.ts +0 -235
  382. package/src/model/batched-mask.ts +0 -279
  383. package/src/model/batched-quant.ts +0 -212
  384. package/src/model/batched-quantized-kv.ts +0 -144
  385. package/src/model/batched-rotating-quant.ts +0 -353
  386. package/src/model/batched-rotating-state.ts +0 -149
  387. package/src/model/batched-rotating.ts +0 -338
  388. package/src/model/batched-row-storage.ts +0 -179
  389. package/src/model/batched-ssm.ts +0 -52
  390. package/src/model/batched-turboquant-kv.ts +0 -93
  391. package/src/model/compiled-decode.ts +0 -712
  392. package/src/model/decoded-kv-donor.ts +0 -12
  393. package/src/model/delayed-quantized-kv.ts +0 -72
  394. package/src/model/delayed-rotating-quantized-kv.ts +0 -93
  395. package/src/model/delayed-turboquant-kv.ts +0 -55
  396. package/src/model/diffusion-gemma.ts +0 -1026
  397. package/src/model/factory.ts +0 -189
  398. package/src/model/fingerprint.ts +0 -33
  399. package/src/model/flash-attention.ts +0 -694
  400. package/src/model/full-prefill-padding.ts +0 -56
  401. package/src/model/full-prefill-row.ts +0 -105
  402. package/src/model/gemma4-base.ts +0 -2351
  403. package/src/model/gemma4.ts +0 -1315
  404. package/src/model/generated/gemma4-12b.ts +0 -429
  405. package/src/model/generated/gemma4-26b.ts +0 -448
  406. package/src/model/generated/gemma4-e4b.ts +0 -717
  407. package/src/model/generated/index.ts +0 -18
  408. package/src/model/glm52-atlas.ts +0 -511
  409. package/src/model/glm52-cache.ts +0 -792
  410. package/src/model/glm52-config.ts +0 -262
  411. package/src/model/glm52-container.ts +0 -305
  412. package/src/model/glm52-coupling.ts +0 -388
  413. package/src/model/glm52-dsa.ts +0 -606
  414. package/src/model/glm52-expert-layout.ts +0 -253
  415. package/src/model/glm52-layout.ts +0 -152
  416. package/src/model/glm52-memory.ts +0 -500
  417. package/src/model/glm52-mla.ts +0 -792
  418. package/src/model/glm52-moe.ts +0 -223
  419. package/src/model/glm52-pilot.ts +0 -537
  420. package/src/model/glm52-reference.ts +0 -445
  421. package/src/model/glm52-residency.ts +0 -557
  422. package/src/model/glm52-resident-weights.ts +0 -135
  423. package/src/model/glm52-streamed-experts.ts +0 -453
  424. package/src/model/glm52-streamed-metal.ts +0 -610
  425. package/src/model/glm52-weights.ts +0 -503
  426. package/src/model/glm52.ts +0 -1132
  427. package/src/model/implementation.ts +0 -69
  428. package/src/model/kv-attention-view.ts +0 -67
  429. package/src/model/minicpm5.ts +0 -376
  430. package/src/model/profile.ts +0 -443
  431. package/src/model/qwen-append.ts +0 -12
  432. package/src/model/qwen-conv.ts +0 -52
  433. package/src/model/qwen3-delta-state.ts +0 -74
  434. package/src/model/qwen3-delta.ts +0 -451
  435. package/src/model/qwen3-moe.ts +0 -404
  436. package/src/model/qwen3-mrope.ts +0 -252
  437. package/src/model/qwen3.ts +0 -277
  438. package/src/model/qwen3_5-checkpoint.ts +0 -164
  439. package/src/model/qwen3_5.ts +0 -819
  440. package/src/model/rotating-kv-donor.ts +0 -35
  441. package/src/model/rotating-kv-layout.ts +0 -262
  442. package/src/model/rotating-row-transaction.ts +0 -35
  443. package/src/model/speculative-rotating-kv.ts +0 -101
  444. package/src/model/ssm-prefill-padding.ts +0 -39
  445. package/src/model/support.ts +0 -102
  446. package/src/model/trellis-balanced-scatter.ts +0 -51
  447. package/src/model/trellis-linear.ts +0 -672
  448. package/src/model/trellis-shared-m.ts +0 -151
  449. package/src/model/trellis-shared-scatter.ts +0 -144
  450. package/src/model/trellis-splitk-prefill.ts +0 -158
  451. package/src/model/trellis-tiled-prefill.ts +0 -136
  452. package/src/model/trellis-vector-expand.ts +0 -62
  453. package/src/model/trellis-wide-prefill.ts +0 -94
  454. package/src/model/turboquant-codec.ts +0 -83
  455. package/src/model/universal/archs.ts +0 -332
  456. package/src/model/universal/dense.ts +0 -612
  457. package/src/model/universal/modules.ts +0 -170
  458. package/src/model/universal/rope.ts +0 -381
  459. package/src/native/expert_io.c +0 -523
  460. package/src/native/frame_extract.swift +0 -140
  461. package/src/native-pack.ts +0 -162
  462. package/src/pi-provider.ts +0 -53
  463. package/src/pi-session.ts +0 -81
  464. package/src/pi-terminal.ts +0 -274
  465. package/src/pi-web.ts +0 -1932
  466. package/src/preflight.ts +0 -158
  467. package/src/prompt-cache.ts +0 -460
  468. package/src/quantize/allocator.ts +0 -627
  469. package/src/quantize/atomic-output.ts +0 -38
  470. package/src/quantize/calibration.ts +0 -181
  471. package/src/quantize/config-writer.ts +0 -145
  472. package/src/quantize/index.ts +0 -84
  473. package/src/quantize/job.ts +0 -162
  474. package/src/quantize/quantizer.ts +0 -666
  475. package/src/quantize/rotate.ts +0 -603
  476. package/src/quantize/safetensors-writer.ts +0 -249
  477. package/src/quantize/sensitivity.ts +0 -216
  478. package/src/quantize/trellis.ts +0 -586
  479. package/src/quantize/weight-transform.ts +0 -292
  480. package/src/registry.ts +0 -602
  481. package/src/runtime-config.ts +0 -81
  482. package/src/safetensors.ts +0 -158
  483. package/src/sampler.ts +0 -1011
  484. package/src/serve/admin-routes.ts +0 -184
  485. package/src/serve/assets/curve-terrain.html +0 -105
  486. package/src/serve/assets/training-inference-map.html +0 -575
  487. package/src/serve/aux-routes.ts +0 -132
  488. package/src/serve/batch-scheduler.ts +0 -8
  489. package/src/serve/checkpoint-identity.ts +0 -64
  490. package/src/serve/generation-gateway.ts +0 -496
  491. package/src/serve/isolate.ts +0 -609
  492. package/src/serve/kv-budget.ts +0 -14
  493. package/src/serve/lab-routes.ts +0 -341
  494. package/src/serve/lane-registry.ts +0 -45
  495. package/src/serve/model-admin-routes.ts +0 -155
  496. package/src/serve/model-binding.ts +0 -43
  497. package/src/serve/model-host.ts +0 -511
  498. package/src/serve/parent-application.ts +0 -56
  499. package/src/serve/prompt-response-trace.ts +0 -147
  500. package/src/serve/response-lease.ts +0 -24
  501. package/src/serve/session-search.ts +0 -326
  502. package/src/serve/static-routes.ts +0 -101
  503. package/src/server.ts +0 -1314
  504. package/src/spec/assistant-rows.ts +0 -92
  505. package/src/spec/assistant-source.ts +0 -126
  506. package/src/spec/cache-identity.ts +0 -22
  507. package/src/spec/deepspec-rows.ts +0 -29
  508. package/src/spec/deepspec-source.ts +0 -145
  509. package/src/spec/dflash-source.ts +0 -149
  510. package/src/spec/drafter.ts +0 -304
  511. package/src/spec/dspark/ab-stats.ts +0 -136
  512. package/src/spec/dspark/calibration.ts +0 -112
  513. package/src/spec/dspark/data-dflash.ts +0 -156
  514. package/src/spec/dspark/data.ts +0 -201
  515. package/src/spec/dspark/deepspec-module.ts +0 -776
  516. package/src/spec/dspark/generate-dflash.ts +0 -245
  517. package/src/spec/dspark/generate.ts +0 -290
  518. package/src/spec/dspark/loader.ts +0 -23
  519. package/src/spec/dspark/loss.ts +0 -213
  520. package/src/spec/dspark/module-dflash.ts +0 -560
  521. package/src/spec/dspark/module.ts +0 -540
  522. package/src/spec/dspark/quantize-drafter.ts +0 -91
  523. package/src/spec/dspark/sample.ts +0 -112
  524. package/src/spec/generate.ts +0 -276
  525. package/src/spec/glm52-mtp-graph.ts +0 -29
  526. package/src/spec/glm52-mtp-rows.ts +0 -132
  527. package/src/spec/glm52-mtp-source.ts +0 -317
  528. package/src/spec/glm52-mtp-state.ts +0 -33
  529. package/src/spec/ngram-source.ts +0 -204
  530. package/src/spec/projected-draft-rows.ts +0 -73
  531. package/src/spec/qwen-mtp-module.ts +0 -171
  532. package/src/spec/qwen-mtp-rows.ts +0 -219
  533. package/src/spec/qwen-mtp-source.ts +0 -383
  534. package/src/spec/qwen-mtp-state.ts +0 -30
  535. package/src/spec/serve-loop.ts +0 -585
  536. package/src/spec/source.ts +0 -215
  537. package/src/spec/two-model-rows.ts +0 -61
  538. package/src/spec/two-model.ts +0 -113
  539. package/src/ssd-cache.ts +0 -372
  540. package/src/ssd-durability.ts +0 -211
  541. package/src/tokenizer.ts +0 -335
  542. package/src/tool-approvals.ts +0 -131
  543. package/src/tool-call.ts +0 -695
  544. package/src/train/dataset.ts +0 -484
  545. package/src/train/diffusion-lora.ts +0 -216
  546. package/src/train/export.ts +0 -32
  547. package/src/train/flash-cce.ts +0 -1234
  548. package/src/train/forward.ts +0 -266
  549. package/src/train/fuse.ts +0 -243
  550. package/src/train/index.ts +0 -46
  551. package/src/train/job.ts +0 -205
  552. package/src/train/lora-params.ts +0 -254
  553. package/src/train/loss.ts +0 -1591
  554. package/src/train/merge.ts +0 -195
  555. package/src/train/optimizer.ts +0 -183
  556. package/src/train/prefix-shared.ts +0 -490
  557. package/src/train/rank.ts +0 -137
  558. package/src/train/segmented.ts +0 -1828
  559. package/src/train/steel-qmm-header.ts +0 -1461
  560. package/src/train/trainer.ts +0 -1221
  561. package/src/train/watch.ts +0 -542
  562. package/src/vision/diffusion-vision.ts +0 -620
  563. package/src/vision/embedder.ts +0 -168
  564. package/src/vision/preprocess.ts +0 -247
  565. package/src/vision/prompt.ts +0 -373
  566. package/src/vision/qwen3vl-preprocess.ts +0 -409
  567. package/src/vision/qwen3vl-prompt.ts +0 -196
  568. package/src/vision/qwen3vl-tower.ts +0 -555
  569. package/src/vision/siglip.ts +0 -599
  570. package/src/vision/video-frames.ts +0 -148
  571. package/src/web/app.html +0 -2143
  572. package/src/web/app.js +0 -5703
  573. package/src/web/skills/memory/SKILL.md +0 -120
  574. package/src/web/skills/web-research/SKILL.md +0 -46
  575. package/src/web/skills.ts +0 -97
  576. package/src/web/src/adapters-panel.ts +0 -288
  577. package/src/web/src/assistant.ts +0 -451
  578. package/src/web/src/chat.ts +0 -1057
  579. package/src/web/src/composer.ts +0 -959
  580. package/src/web/src/dataset.ts +0 -132
  581. package/src/web/src/finetune.ts +0 -267
  582. package/src/web/src/hub.ts +0 -428
  583. package/src/web/src/main.ts +0 -98
  584. package/src/web/src/markdown.ts +0 -0
  585. package/src/web/src/memory-panel.ts +0 -572
  586. package/src/web/src/model-picker.ts +0 -159
  587. package/src/web/src/palette.ts +0 -346
  588. package/src/web/src/protocol.ts +0 -26
  589. package/src/web/src/quantize.ts +0 -167
  590. package/src/web/src/rag.ts +0 -274
  591. package/src/web/src/sessions.ts +0 -469
  592. package/src/web/src/shell.ts +0 -804
  593. package/src/web/src/ui-catalog.ts +0 -78
  594. package/src/web/vendor/README.md +0 -61
  595. package/src/web-assets.ts +0 -47
  596. package/src/web-tools.ts +0 -478
  597. package/src/weights.ts +0 -255
  598. /package/src/{serve → server}/completion-sink.ts +0 -0
  599. /package/src/web/{icon.svg → public/icon.svg} +0 -0
  600. /package/src/web/{manifest.webmanifest → public/manifest.webmanifest} +0 -0
  601. /package/src/web/{vendor → public/vendor}/hljs-LICENSE +0 -0
@@ -1,148 +0,0 @@
1
- # Handoff — segmented backward training (2026-06-16)
2
-
3
- Current-state report for the segmented-backward LoRA training work. Deep dossier
4
- (design, proofs, every measurement): [`docs/design/segmented-backward-training.md`](../design/segmented-backward-training.md)
5
- §9 (MiniCPM5) and §10 (e4b). Branch: `segmented-backward-training`,
6
- PR [#9](https://github.com/joshuarossi/mlx-bun/pull/9).
7
-
8
- ## TL;DR
9
-
10
- Long-context LoRA SFT that **streams the backward segment-by-segment** so only one
11
- segment's activations are live at a time — training fits at context lengths where
12
- the full backward spikes. Two phases, both working:
13
-
14
- - **MiniCPM5 (Phase A): done, production-ready.** Bit-exact mechanism, no memory
15
- leak, trains end-to-end. Real 300-iter chunk fine-tune → **chunk-eval 95.10/100**
16
- (beats the 91.70 non-segmented baseline; pre-tune 11.89).
17
- - **e4b / gemma-3n (Phase B): built + validated.** Forward bit-exact; grads
18
- bf16-class; trains **all 42 layers at 8K context** where `mlx_lm.lora` OOMs.
19
-
20
- **Parity:** our **non-segmented** training is **bit-exact with mlx-lm** at 2k
21
- (forward, loss, AND gradient — verified by running mlx-lm's own `default_loss` /
22
- `nn.value_and_grad`). The **segmented** path is **bf16-class (~2%)** off, a
23
- grouping-controllable bf16 non-associativity (not a logic bug).
24
-
25
- ## What was built
26
-
27
- | file | what |
28
- |---|---|
29
- | `src/train/segmented.ts` | `SegmentedBackward` (MiniCPM5) + `SegmentedBackwardGemma4` (e4b) + `planSegmentsBySize`; the per-segment vjp driver, `detachLeaf` |
30
- | `src/mlx/autograd.ts` | `Vjp` — `mlx_vjp` binding (the backward primitive; see "leak" below) |
31
- | `src/mlx/ffi.ts` | `mlx_vjp` FFI decl |
32
- | `src/mlx/array.ts` | `MlxArray.fromBytesCopy` — graph-free leaf copy (row-major) |
33
- | `src/model/minicpm5.ts` | `runLayerRange` (forwardLayers delegates) |
34
- | `src/model/gemma4.ts` | `runLayerRange` + `makeTrainingMasks` + `embedForSegmented` + `reusedDonors` (additive; forwardLayers untouched) |
35
- | `src/train/trainer.ts` | `TrainConfig.segmentSize`; gated segmented path (MiniCPM5 + Gemma4) |
36
- | `src/train/loss.ts` | exported `responseOnlyCe`, `maskedCe` |
37
-
38
- **Enable:** set `segmentSize` (layers per segment) > 0 in the train config, or
39
- `SEG=n` in `scripts/chunk-finetune.ts`. 0 = the normal full backward.
40
-
41
- How it works (B=1 SFT): forward saves a DETACHED boundary (graph-free leaf) at each
42
- segment edge → a loss-head `mlx_vjp` gives `dh` for the last boundary → reverse
43
- per-segment `mlx_vjp`s thread `dh` and the segment's LoRA params, accumulating
44
- grads. Only one segment's activations are live. e4b adds two boundary streams: the
45
- per-layer-input tensor (a pure constant) and the **KV-shared donor K/V** (a second
46
- boundary stream WITH cotangent accumulation — the intricate part; docs §10).
47
-
48
- ## What was validated (honest numbers)
49
-
50
- **Correctness**
51
- - MiniCPM5 segmented grads vs the full value_and_grad: **bit-exact under flash**
52
- (relNorm 0.0000%). Under `ops.sdpa`, ~6% — a *pre-existing* `ops.sdpa`
53
- eager-vs-autograd forward divergence, not segmentation.
54
- - e4b: forward **bit-exact** vs full; single-consumer donor reuse **bit-exact**;
55
- natural-cut donor-KV grads **~1% (bf16 non-associativity)** — single-consumer
56
- exact, flat in consumer count, tracks summand count (donor 22's 15 sharers
57
- ≈0.46% vs donor 23's 3 ≈0%), grouping-dependent for both bf16 AND fp32. fp32
58
- accumulation does NOT help (the term is mlx's within-vjp bf16 sum). **Controllable
59
- by the segment cut** (coarser sharer grouping → tighter, down to bit-exact at
60
- 1 consumer), not the dtype.
61
- - **Parity vs mlx-lm (ran their code):** forward/loss — denominator (`M` vs
62
- `ntoks`) bit-exact across 6 mask spans incl. edges; response-only CE == our
63
- full-masked CE (a pure memory optimization); loss bit-exact on 4/6 spans, 0.5
64
- float32-ulp on 2/6 (a logsumexp/reduction f32 effect, ~5e-5%, harmless).
65
- Gradient — our FULL (non-segmented) `dB` over all 42 q_proj **bit-exact** with
66
- mlx-lm; segmented `dB` ~2.3% (the bf16 donor-KV effect).
67
-
68
- **Memory leak (found + fixed).** The first cut used a surrogate-loss
69
- `value_and_grad`; it leaked ~32 MB/segment/step (mlx-level, not GC/cache/sync
70
- reclaimable). **Fixed by using `mlx_vjp`** (the natural primitive — no surrogate).
71
- End-to-end now flat (active constant across a 300-iter run). Repro:
72
- `scripts/vag-leak-test.ts` (MODE=layers leaks via value_and_grad; MODE=vjp flat).
73
-
74
- **Memory vs the real reference** (`mlx_lm.lora --grad-checkpoint`, the way a user
75
- trains — it loads the OptiQ e4b directly). mlx-lm checkpoints **per-layer**; ours
76
- groups `segmentSize` layers. Matched grouping (both per-layer = segSize 1, all 42
77
- layers, batch 1):
78
-
79
- | L | mlx-lm (per-layer) | ours (segSize=1) |
80
- |---|---|---|
81
- | 2048 | 12.84 GB | 8.76 GB |
82
- | 4096 | 20.87 GB | 10.93 GB |
83
- | 8192 | **OOM** (25.7 GB @16 layers) | 15.29 GB |
84
-
85
- Ours lower at every length AND trains all 42 layers at 8K where mlx-lm OOMs. **Two
86
- confounds, not isolated:** (1) mlx-lm materializes the full `[1,L,262k]` logits
87
- (~4 GB @4K) while we use response-only CE; (2) our full backward streaming vs
88
- mlx-lm's per-layer checkpoint. So the gap is part CE-optimization, part mechanism —
89
- not purely "segmentation beats checkpointing." (Earlier "reference crashes at 4K /
90
- ~70 GB" was WRONG — it used mlx-bun's *own* ineffective checkpoint as the baseline.)
91
-
92
- ## How to run an adapter
93
-
94
- The fine-tune saves a hot-swap adapter dir (`adapters.safetensors` +
95
- `optiq_lora_config.json` + `adapter_config.json`).
96
-
97
- **One-off generate** (verified working) — `scripts/run-adapter.ts`:
98
- ```sh
99
- ADAPTER=~/.cache/mlx-bun-finetunes/minicpm5-chunk-segmented \
100
- PROMPT="Split into chunks and return JSON: ..." \
101
- MAXTOK=256 bun scripts/run-adapter.ts
102
- # omit ADAPTER for the base model; MODEL=<dir> to change base; SYSTEM=... TEMP=...
103
- ```
104
-
105
- **Score it on the chunk task:**
106
- ```sh
107
- ADAPTER=~/.cache/mlx-bun-finetunes/minicpm5-chunk-segmented bun scripts/chunk-eval.ts
108
- ```
109
-
110
- **Serve it** (you run the server; mount via the API):
111
- ```sh
112
- # 1) start: mlx-bun serve <model-dir>
113
- # 2) mount: curl -X POST localhost:PORT/v1/adapters -d '{"id":"chunk","path":"<adapter-dir>"}'
114
- # 3) list: curl localhost:PORT/v1/adapters # unmount: DELETE /v1/adapters/chunk
115
- ```
116
- The adapter activates per request through `loraState`; in code the pattern is
117
- `new AdapterManager(model).mount(id, dir)` then `model.loraState.active = [id]`.
118
-
119
- **Train a new adapter** (segmented):
120
- ```sh
121
- # MiniCPM5, seq 4096, segments of 4 layers:
122
- MLX_BUN_PERF_KERNEL=0 MLX_BUN_FUSED_GELU=0 \
123
- SEQ=4096 ITERS=300 SEG=4 DATA=<data-dir> ADAPTER=<out-dir> \
124
- bun scripts/chunk-finetune.ts
125
- # e4b: add MODEL=<e4b-dir> and use SEG=2 (or 1) for ≥8K to keep peak down.
126
- ```
127
- Training REQUIRES `MLX_BUN_PERF_KERNEL=0 MLX_BUN_FUSED_GELU=0` (those fused kernels
128
- have no vjp). Use `MLX_BUN_TRAIN_ATTN=flash` for exact grads (slower).
129
-
130
- ## What's next / open
131
-
132
- 1. **e4b @8K toward ~10 GB** (currently 15.3 GB segSize=1): the §5 full-attention
133
- ISOLATION `planSegments` — put each O(L²) full-attn layer (5,11,17,23,29,35,41)
134
- in its own short segment. Mechanism + tuning knob are proven; this is peak-shaving.
135
- 2. **Isolate the memory confound** (optional): run ours at segSize=1 with full-logits
136
- CE to separate the response-only-CE saving from the streaming mechanism.
137
- 3. **mlx-bun's own gradient checkpoint is ineffective** (23 GB @2048 vs mlx-lm's
138
- 12.8) — orthogonal bug; segmented sidesteps it.
139
- 4. Scale knobs: `segmentSize` is the peak↔grad-fidelity knob (finer = lower peak,
140
- more donor-KV bf16 deviation).
141
-
142
- ## Diagnostic scripts (kept)
143
-
144
- `scripts/segmented-grad-test.ts` (MiniCPM5 grads + peak + leak loop),
145
- `segmented-grad-test-e4b.ts` (e4b grads + peak; RANGES/SEG_ONLY/SEG_DUMP),
146
- `parity-vs-mlxlm.ts` + `grad-parity-vs-mlxlm.ts` (mlx-lm parity; Python sides in
147
- `/tmp/mlxlm-*.py`), `vag-leak-test.ts`, `seg-debug.ts`, `gemma4-runlayerrange-test.ts`,
148
- `run-adapter.ts`, `chunk-{finetune,eval}.ts`.
@@ -1,342 +0,0 @@
1
- # Handoff: the sub-GB starter model port (publishing gate 1)
2
-
3
- *2026-06-12. Goal: a runnable sub-gigabyte model so first run is
4
- chatting in ~1 minute (PLAN Phase 16 starter item; publishing gate).
5
- This document is the complete implementation plan. Read PLAN.md's
6
- "Reference environment" + Phase 14 first. Written from live
7
- inspection of the actual model configs (HF API) and our porting
8
- infrastructure — every claim below was verified, not remembered.*
9
-
10
- ---
11
-
12
- ## 0. CRITICAL DISCOVERY — read before starting
13
-
14
- **Qwen3.5-0.8B is NOT a vanilla transformer.** Its config
15
- (`model_type: qwen3_5_text`, fetched 2026-06-12) reveals the
16
- qwen3-next hybrid lineage:
17
-
18
- - **24 layers: 18 `linear_attention` + 6 `full_attention`**
19
- (`full_attention_interval: 4`). The linear layers are **gated
20
- DeltaNet**: causal conv (kernel 4), 16 key heads × 128, 16 value
21
- heads × 128, recurrent state in **float32** (`mamba_ssm_dtype`).
22
- - Full-attention layers: 8 heads / 2 KV heads, head_dim 256,
23
- **partial rotary 0.25**, **interleaved MRoPE** (sections
24
- [11,11,10]), theta 1e7, **`attn_output_gate: true`**.
25
- - `tie_word_embeddings`, vocab 248,320 (embeddings quantized 8-bit),
26
- hidden 1024; bundled `mtp.safetensors` (1-layer MTP head) and a
27
- 201 MB `optiq_vision.safetensors` sidecar; per-tensor mixed quant
28
- (some projections 8-bit).
29
-
30
- This is a **major port**: a DeltaNet recurrence + conv-state cache is
31
- a new cache *kind*, a new prefill strategy, and new numerics
32
- (float32 state) — none of which our Gemma-shaped pipeline has.
33
-
34
- **MiniCPM5-1B-OptiQ-4bit, by contrast, is textbook `llama`**
35
- (config verified the same way): 24 layers, plain GQA 16/2 heads,
36
- head_dim 128, standard RoPE theta 5e6 with **no scaling**, SiLU MLP,
37
- RMSNorm, untied embeddings, vocab 130,560, 0.92 GB. Every mechanism
38
- it needs already exists in our gemma4 port (GQA attention, RoPE,
39
- RMSNorm, quantized linear) — minus Gemma's quirks (no sliding
40
- windows, no softcapping, no per-layer embeds, no QK-norm... verify
41
- QK-norm against the oracle, llama has none).
42
-
43
- **Recommendation: split the work.**
44
- - **Track A (the publishing gate): port MiniCPM5-1B.** Days, not
45
- weeks. Capability is respectable (52% MMLU, 30.28 OptiQ score —
46
- Josh's screenshot from the OptiQ site) and the starter's job is
47
- tour-guide + fast first impression.
48
- - **Track B (Phase 14 proper, after publishing): port Qwen3.5.**
49
- It is the MTP home and a flagship family — it deserves the real
50
- multi-week effort, not a deadline squeeze.
51
-
52
- Josh decides; both tracks are specified below. The shared recipe
53
- (§2) applies to either.
54
-
55
- > **Outcome (2026-06-17, resolved).** Both tracks proceeded as
56
- > recommended. **Track A (MiniCPM5-1B) was chosen as the publishing
57
- > gate and shipped** (open question 1 confirmed): `src/model/minicpm5.ts`
58
- > is live, parity suite green, PLAN.md updated. The starter runs
59
- > non-thinking (open question 2 confirmed). Weights are kept on disk as a
60
- > permanent fallback and tour-guide model — not deleted after the big model
61
- > lands (open question 3 confirmed). Publishing mechanics resolved
62
- > (open question 4 green-lit): the package is published as
63
- > `mlx-bun@0.0.4` on npm, installable via `bunx mlx-bun`, and a
64
- > Homebrew release pipeline (sign/notarize/tap, default tap
65
- > `joshuarossi/homebrew-tap`) is in place. First-run onboarding
66
- > (auto-download + browser open) shipped alongside. **Track B
67
- > (Qwen3.5-0.8B) is underway** as Phase 14 proper on its own clock,
68
- > with reasoning fixes already merged. All four open questions are
69
- > resolved; see §6.
70
-
71
- ---
72
-
73
- ## 1. Machine + reference environment logistics
74
-
75
- - **The oracle lives on the M4 Pro dev machine** —
76
- `/Users/joshrossi/Code/mlx-lm/.venv` (mlx 0.31.2, mlx-lm 0.31.3,
77
- mlx-optiq 0.2.1). The M1 Max cloud box (where the 2026-06-12
78
- session ran) does NOT have it: `tests/paths.ts` →
79
- `ORACLE_PYTHON` resolves there only on the M4 Pro. **Do parity
80
- work on the M4 Pro**, or replicate the venv on the M1 Max first
81
- (pip install mlx==0.31.2 mlx-lm==0.31.3 mlx-optiq==0.2.1).
82
- - Oracle source to read (M4 Pro, site-packages):
83
- - Track A: `mlx_lm/models/llama.py` (the reference llama graph).
84
- - Track B: `optiq/mlx_lm_patches/qwen3_5_text.py` (registered via
85
- optiq's MODEL_REMAPPING — see PLAN Phase 14), plus mlx-lm's
86
- `models/qwen3_next.py` for the gated-DeltaNet reference
87
- implementation, and `optiq/runtime/mtp/` (defer MTP, but its
88
- `trace_parity.py` encodes load-bearing invariants).
89
- - Downloads (sub-GB, fine to do from a session):
90
- - `mlx-bun get mlx-community/MiniCPM5-1B-OptiQ-4bit` (0.92 GB)
91
- - `mlx-bun get mlx-community/Qwen3.5-0.8B-OptiQ-4bit` (0.89 GB)
92
- - Remember `HF_HUB_DISABLE_XET=1` applies to *python* tooling only;
93
- our downloader speaks plain HTTPS already.
94
- - Goldens are **machine-specific** (`goldenOutDir()`: flat reference
95
- set on the M4 Pro, `goldens/<machine-key>/` elsewhere — logit
96
- goldens are bit-exact only on the GPU that produced them).
97
-
98
- ---
99
-
100
- ## 2. The shared porting recipe (how gemma4 was done — follow it)
101
-
102
- Every step below exists for gemma4; the port is "do the same for the
103
- new family." File references verified 2026-06-12.
104
-
105
- ### Step 2.1 — Config loading (`src/config.ts`)
106
- `loadModelConfig()` currently normalizes gemma4's config.json into
107
- `ModelConfig` (nested `text` block: layerTypes, heads, dims, rope,
108
- quant overrides). Add a per-family branch keyed on `model_type`:
109
- - llama (MiniCPM5): flat config — map hidden_size, heads/kv-heads,
110
- head_dim, intermediate, rms eps, rope theta, vocab, tie flag,
111
- num_hidden_layers, layerTypes = all "full_attention".
112
- - qwen3_5: `text_config` nesting; layer_types as shipped
113
- (linear_attention/full_attention); linear_* dims; mrope params;
114
- partial_rotary_factor; attn_output_gate; mamba dtype.
115
- - Keep `quantization` parsing (per-tensor overrides like
116
- `embed_tokens: {bits: 8}` — qwen uses them heavily; check
117
- `quantFor()` already resolves path-keyed overrides).
118
- - **`modelType` drives everything downstream** — registry already
119
- stores it (that's how the CLI's `startsWith("gemma4")` filter
120
- works).
121
-
122
- ### Step 2.2 — Model graph (`src/model/<family>.ts`)
123
- Pattern from `gemma4.ts`/`gemma4-base.ts`: the base file holds
124
- config-independent machinery (QuantizedLinear/QuantizedEmbedding
125
- loaders, KVCache/RotatingKVCache, RMSNorm, rope helpers) — REUSE it.
126
- A new family file defines Attention/MLP/Layer/Model classes that
127
- `Weights.open()` feeds by tensor path. Key contract points:
128
- - `makeCache()` returns the per-layer cache array `generate()`
129
- threads through.
130
- - `forwardLayers()` shape must match what compiled-decode segments
131
- expect — but **do NOT wire compiled-decode/fused kernels for the
132
- new family initially**: `generate()` gates them; ship the naive
133
- path first, parity gates every optimization later (that is the
134
- testing-strategy contract).
135
- - Weight path prefixes differ per family (llama:
136
- `model.layers.N....`; qwen3_5: `language_model.model.layers...` —
137
- verify against `model.safetensors.index.json`).
138
-
139
- ### Step 2.3 — Factory (`src/model/factory.ts`)
140
- `createModel()` currently returns `Gemma4Model` (generated
141
- specializations subclass it). Introduce a `Model` interface (the
142
- methods server/generate actually use: forward, makeCache, config,
143
- weightsBytes, dispose...) and dispatch on `config.modelType`. The
144
- generated-specialization map stays gemma-only.
145
-
146
- ### Step 2.4 — Tokenizer + chat template
147
- - `src/tokenizer.ts` uses @huggingface/tokenizers over
148
- `tokenizer.json` — both models ship one (qwen's is 20 MB; load
149
- time worth checking). Verify BOS/EOS handling: qwen3_5
150
- eos 248044; MiniCPM5 bos 0 / eos in generation_config.
151
- - `src/chat-template.ts` renders `chat_template.jinja` via
152
- @huggingface/jinja — qwen ships chat_template.jinja (7.8 KB;
153
- includes `enable_thinking`-style hybrid switches — render with
154
- thinking OFF for the starter; MiniCPM5's template TBD from its
155
- tokenizer_config).
156
- - Tool-call grammar: gemma's `parseToolCalls` markers are
157
- family-specific (`src/tool-call.ts`). Qwen uses hermes-style
158
- `<tool_call>` JSON; MiniCPM5 TBD. Starter can ship text-only chat
159
- first; the pi session needs tool calls to be USEFUL, so budget it.
160
-
161
- ### Step 2.5 — Parity harness (the correctness contract)
162
- Mirror `scripts/regen-parity-goldens.ts` + `tests/parity.test.ts`
163
- for the new family (paths in `tests/paths.ts` — add SNAPSHOT_<fam>):
164
- - **Tier a (bit-exact ids)**: oracle generates 100 greedy tokens +
165
- per-step argmax + full last-position logits for the first N steps
166
- (f32 .bin). Our side must match token-for-token, logits within
167
- the established tolerance, on the same GPU.
168
- - Oracle command shape: the venv python with mlx-lm generate (Track
169
- A) or optiq's patched loader (Track B — needs
170
- `optiq.mlx_lm_patches` import side effects; read how their CLI
171
- registers MODEL_REMAPPING and replicate in the regen script).
172
- - Then the e2e suite: prefill masks (L>1), decode loop, KV-quant
173
- tiers (Track A can reuse kv-quant goldens pattern; Track B's
174
- linear layers have NO KV — see §4.3).
175
- - Suite must stay green throughout: `bun test` (157+ tests).
176
-
177
- ### Step 2.6 — Integration sweep (easy to forget — grep targets)
178
- All the places hardcoding the gemma4 family, verified present today:
179
- 1. `src/cli.ts` — THREE `modelType.startsWith("gemma4")` filters
180
- (resolveModelAuto ×2 paths + ls capability column) → a shared
181
- `SUPPORTED_FAMILIES` predicate in one place.
182
- 2. `src/cli.ts` starter constant: `starterRepo =
183
- ".../gemma-4-e4b-it-OptiQ-4bit"` → the new sub-GB repo.
184
- 3. `src/fit.ts` `recommendedRepoId()` — tiers stay Gemma (the
185
- starter is not the recommendation), but the starter download in
186
- resolveModelAuto switches.
187
- 4. **`src/fit.ts` `kvGeometry()` assumes gemma layer types**
188
- (`sliding_attention` / full): llama = all-full (works via the
189
- full branch — verify window handling degrades correctly);
190
- qwen3_5 `linear_attention` layers have constant-size state, not
191
- token-proportional KV — fit's KV-growth math needs a family
192
- branch or the 0.8B's max-safe-context will be nonsense.
193
- 5. `src/server.ts` /stats KV accounting + /library `supported`
194
- flag + the registry `paramCount` parse (works off safetensors
195
- headers — verify for the new index layout).
196
- 6. Status page + README copy that says "Gemma".
197
- 7. Vision sidecar guard: qwen's `optiq_vision.safetensors` must NOT
198
- be loaded (registry already separates sidecarBytes; confirm the
199
- loader skips non-gemma sidecars rather than erroring).
200
-
201
- ### Step 2.7 — Starter-flow wiring + docs-grounded tour guide
202
- - Swap `starterRepo` (§2.6.2) and keep the background-download of
203
- the recommended Gemma.
204
- - The "tour guide" system prompt (PRODUCT_ROADMAP first-run UX):
205
- preload README/server-api/pi docs into the starter's system
206
- prompt so a ~1B model answers mlx-bun questions grounded instead
207
- of hallucinating. Suggested: a `docs/tour-guide.md` baked via
208
- text import, used as default system prompt ONLY for the starter
209
- model + surfaced in the chat UI's system field.
210
- - E2E: fresh-machine simulation (`HOME=$(mktemp -d)` breaks
211
- keychain/HF paths — instead point `cacheDir`/registry at a temp
212
- hub via env or test flags; the downloadModel `cacheDir` option
213
- already exists).
214
-
215
- ---
216
-
217
- ## 3. Track A step-by-step: MiniCPM5-1B (`llama`) — the gate
218
-
219
- Estimated: 2–4 focused sessions. Order matters; each step has a gate.
220
-
221
- 1. **Download + inspect** (30 min): `mlx-bun get
222
- mlx-community/MiniCPM5-1B-OptiQ-4bit`; dump
223
- `model.safetensors.index.json` tensor names; diff against
224
- mlx-lm `llama.py` expectations; note quant per-tensor overrides
225
- in config. Gate: full tensor-name → module mapping written down.
226
- 2. **Oracle goldens first** (1–2 h, M4 Pro): extend
227
- regen-parity-goldens with `--model` + plain mlx-lm loader; run
228
- against MiniCPM5; commit goldens. Doing this FIRST means every
229
- subsequent step has a target. Gate: oracle generates coherent
230
- text (also validates the artifact itself).
231
- 3. **Config branch** (§2.1) + **weights mapping**: llama branch in
232
- loadModelConfig; confirm `Weights.open` mmaps the single 650 MB
233
- shard fine. Gate: registry `scan` shows correct params/quant.
234
- 4. **Model graph** (`src/model/llama.ts`): embed → N×(RMSNorm →
235
- GQA attn (RoPE theta from config) → residual → RMSNorm → SiLU
236
- MLP → residual) → final norm → lm_head (untied). Reuse
237
- QuantizedLinear/KVCache/rope from gemma4-base — llama needs the
238
- non-Gemma variants (no embed scaling, no softcap, no QK-norm,
239
- no pre/post-feedforward norms — READ the oracle line by line;
240
- Gemma habits are the bug farm here). Gate: tier-a parity, 100/100
241
- greedy ids + logit tolerance.
242
- 5. **Factory interface** (§2.3) + integration sweep (§2.6). Gate:
243
- full suite green; `mlx-bun serve minicpm` chats coherently;
244
- `/chat` works; fit/library/status pages sane.
245
- 6. **Tool calls + template** (§2.4): render template with tools,
246
- implement the family's tool-call markers in tool-call.ts, e2e
247
- via the existing server-tools test pattern. Gate: pi session
248
- round-trips one read/bash tool call on the starter.
249
- 7. **Starter wiring** (§2.7) + benchmark rows (`mlx-bun benchmark
250
- minicpm`) + fresh-machine e2e. Gate: cold start → chatting
251
- under ~2 min on decent broadband, big model streaming behind.
252
- 8. **Ship gate**: PLAN updated, suite green, both testers' machines
253
- happy → publish.
254
-
255
- ---
256
-
257
- ## 4. Track B step-by-step: Qwen3.5-0.8B (`qwen3_5`) — Phase 14 proper
258
-
259
- Estimated: 2+ weeks calibrated against the gemma port. The order
260
- isolates the novel machinery so parity bisects cleanly.
261
-
262
- 1. **Read the oracle deeply** (M4 Pro): optiq's `qwen3_5_text.py` +
263
- mlx-lm `qwen3_next.py`. Write a NOTES file mapping every module:
264
- in_proj_qkv/in_proj_ba, causal conv1d, gated delta rule
265
- (decay a, beta b, state S update S = a·S + v·kᵀ, out = S·q —
266
- verify exact form from source, do NOT trust this sketch),
267
- norm-then-gate output path, full-attn blocks with partial
268
- rotary + interleaved MRoPE + output gate, shared input/output
269
- embeddings.
270
- 2. **Oracle goldens + per-layer fixtures**: beyond tier-a ids,
271
- dump PER-LAYER activations from the oracle for one short prompt
272
- (the gemma port's most valuable debugging tool — bisects which
273
- layer diverges). The optiq loader must be driven through their
274
- MODEL_REMAPPING registration.
275
- 3. **Config branch** (§2.1): text_config nesting, linear_* dims,
276
- mrope_section/interleaved, partial_rotary_factor 0.25,
277
- attn_output_gate, full_attention_interval, mamba_ssm_dtype.
278
- 4. **New cache kind** (`src/kv-store.ts` + model file): linear-attn
279
- layers carry `(conv_state[K=4 window], S[float32 16×128×128])`
280
- per layer — constant size, no growth, no quantization, must
281
- survive `generate()`'s dispose/trim/cache-reuse contract
282
- (PromptCache stores caches by token prefix — linear state is
283
- prefix-dependent, so prefix reuse REMAINS VALID only on exact
284
- prefix; trimming is NOT possible → mark these caches
285
- non-trimmable and let PromptCache fall back to full re-prefill
286
- when a partial-prefix hit would require trim).
287
- 5. **DeltaNet prefill**: reference implements chunked scan in pure
288
- mlx ops — port that first (correctness), no custom kernels.
289
- float32 state in a bf16 graph: respect mamba_ssm_dtype or
290
- parity will drift.
291
- 6. **Full-attention blocks**: GQA 8/2 with head_dim 256, partial
292
- rotary (first 64 dims of 256), interleaved MRoPE sections
293
- [11,11,10] (text-only collapses to standard positions — verify
294
- how the oracle treats pure-text), attn_output_gate (sigmoid gate
295
- on attn output — read source), theta 1e7.
296
- 7. **Graph assembly + tier-a parity** (the long haul): per-layer
297
- fixture bisection. Numeric hot spots from the gemma experience:
298
- norm epsilon placement, residual dtype, rope sign/interleave,
299
- quantized-embedding dequant scaling.
300
- 8. **KV-quant for the 6 full layers** (kv_config.json ships in the
301
- repo), fit.ts geometry branch (linear state = constant bytes).
302
- 9. **Tokenizer/template/tools** (§2.4) — template has hybrid
303
- thinking switches; starter runs non-thinking
304
- (chat_template kwargs equivalent: `enable_thinking: false`).
305
- 10. **MTP (`mtp.safetensors`) — DEFER** to its own phase per PLAN
306
- 14(b): start at optiq `runtime/mtp/trace_parity.py`. Greedy-MTP
307
- must be token-identical to greedy non-MTP by construction.
308
- 11. **Vision sidecar — DEFER** (Phase 12 bucket, third vision arch).
309
- 12. Integration sweep (§2.6), benchmark, starter wiring if Track B
310
- ends up being the starter after all.
311
-
312
- ---
313
-
314
- ## 5. Exit criteria (both tracks)
315
-
316
- - Tier-a parity: 100 greedy ids bit-exact vs oracle + logit deltas
317
- within the established tolerance, committed goldens + regen
318
- script, runs in CI suite behind `snapshotAvailable()` guards.
319
- - Full existing suite stays green at every commit (house rule).
320
- - `mlx-bun benchmark <model>` rows recorded (decode + prefill +
321
- peak) on at least the M4 Pro and M1 Max.
322
- - Fresh-machine first-run e2e: starter chatting, recommended model
323
- background-streaming, status page sane, pi tool round-trip.
324
- - PLAN.md updated with findings (negative results included — e.g.
325
- any oracle deviations discovered, like the Phase 11 ones).
326
-
327
- ## 6. Resolved questions
328
-
329
- All four questions were resolved by 2026-06-17 (see outcome box above).
330
-
331
- 1. **Track A vs B for the gate** — **Track A (MiniCPM5-1B) chosen.**
332
- `src/model/minicpm5.ts` shipped as the publishing gate; Track B
333
- (Qwen3.5-0.8B) is underway as Phase 14 proper on its own clock.
334
- 2. **Thinking mode for the starter** — **Non-thinking confirmed.**
335
- The starter runs with thinking disabled; no `<think>` tokens in the
336
- first-run flow.
337
- 3. **Keep weights on disk?** — **Yes, kept as permanent fallback + tour
338
- guide.** The ~1 GB artifact is not deleted once the big model lands.
339
- 4. **Publishing mechanics green-lit?** — **Yes, shipped.**
340
- Package published as `mlx-bun@0.0.4` on npm; installable via
341
- `bunx mlx-bun`; Homebrew release pipeline (sign/notarize/tap,
342
- default tap `joshuarossi/homebrew-tap`) is in place.