mlx-bun 0.5.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 (640) hide show
  1. package/README.md +1449 -109
  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 +7 -5
  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 +10 -10
  78. package/src/{serve → server}/chat-stage.ts +14 -14
  79. package/src/{client.ts → server/client.ts} +28 -2
  80. package/src/{serve → server}/completion-executor.ts +33 -41
  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 +25 -82
  85. package/src/{serve → server}/http.ts +25 -13
  86. package/src/{serve → server}/inference-request.ts +5 -5
  87. package/src/server/job-routes.ts +20 -0
  88. package/src/server/media-prompt.ts +63 -0
  89. package/src/server/memory-completion-client.ts +46 -0
  90. package/src/server/model-routes.ts +192 -0
  91. package/src/{serve → server}/openai-wire.ts +3 -2
  92. package/src/{serve → server}/pipeline.ts +1 -1
  93. package/src/server/prompt-builder.ts +13 -0
  94. package/src/server/prompt-contracts.ts +17 -0
  95. package/src/server/proxy-routes.ts +187 -0
  96. package/src/server/publishing-routes.ts +41 -0
  97. package/src/{serve → server}/request-plan.ts +6 -8
  98. package/src/{serve → server}/request-prep.ts +47 -50
  99. package/src/{serve → server}/responses-client.ts +30 -13
  100. package/src/{responses.ts → server/responses.ts} +12 -93
  101. package/src/server/routes.ts +205 -0
  102. package/src/server/start.ts +72 -0
  103. package/src/server/status-routes.ts +108 -0
  104. package/src/{serve → server}/text-completion-stage.ts +25 -4
  105. package/src/server/text-prompt.ts +12 -0
  106. package/src/{serve → server}/token-streams.ts +36 -38
  107. package/src/server/worker-routes.ts +311 -0
  108. package/src/storage/paths.ts +61 -0
  109. package/src/web/assets.ts +37 -0
  110. package/src/web/{src → browser}/api.ts +5 -23
  111. package/src/web/browser/chat-host.ts +17 -0
  112. package/src/web/browser/installed-panels.ts +6 -0
  113. package/src/web/browser/main.ts +55 -0
  114. package/src/web/browser/markdown.ts +279 -0
  115. package/src/web/browser/memory-panel.ts +9 -0
  116. package/src/web/browser/palette.ts +64 -0
  117. package/src/web/browser/protocol.ts +13 -0
  118. package/src/web/browser/shell.ts +467 -0
  119. package/src/web/{src → browser}/status.ts +32 -36
  120. package/src/web/build.ts +51 -0
  121. package/src/web/public/app.html +1054 -0
  122. package/src/web/{sw.js → public/sw.js} +4 -3
  123. package/src/web/{vendor → public/vendor}/hljs-theme.css +2 -2
  124. package/src/web/{vendor → public/vendor}/hljs.js +2 -2
  125. package/THIRD_PARTY_LICENSES.md +0 -51
  126. package/docs/README.md +0 -107
  127. package/docs/archive/hlg-sampling.md +0 -350
  128. package/docs/archive/investigations/audio-input-plan.md +0 -356
  129. package/docs/archive/investigations/benchmark-ledger-through-v0.4.0.md +0 -3617
  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/release-notes-v0.4.0.md +0 -45
  174. package/docs/archive/planning/release-notes-v0.5.0.md +0 -37
  175. package/docs/archive/planning/web-ui-pass-plan.md +0 -213
  176. package/docs/archive/planning/website-readme-pass-plan.md +0 -224
  177. package/docs/design/batching.md +0 -2054
  178. package/docs/design/decode-speed-program.md +0 -2404
  179. package/docs/design/dreaming-nightly-pipeline.md +0 -684
  180. package/docs/design/generic-model-support.md +0 -821
  181. package/docs/design/kv-cache.md +0 -993
  182. package/docs/design/orpo-training.md +0 -680
  183. package/docs/design/speculative-decoding.md +0 -2129
  184. package/docs/design/turboquant.md +0 -2225
  185. package/docs/design/unified-engine-frontier-plan.md +0 -1987
  186. package/docs/design/web-chat-redesign.md +0 -695
  187. package/docs/planning/PRODUCT_ROADMAP.md +0 -593
  188. package/docs/planning/ResearchTopics.md +0 -119
  189. package/docs/planning/public-readiness-handoff.md +0 -244
  190. package/docs/planning/public-readiness.md +0 -149
  191. package/docs/planning/video-series.md +0 -421
  192. package/docs/reference/benchmarks.md +0 -3587
  193. package/docs/reference/cli.md +0 -646
  194. package/docs/reference/distribution.md +0 -380
  195. package/docs/reference/environment.md +0 -494
  196. package/docs/reference/glossary.md +0 -39
  197. package/docs/reference/library-api.md +0 -688
  198. package/docs/reference/memory.md +0 -260
  199. package/docs/reference/models.md +0 -346
  200. package/docs/reference/server-api.md +0 -1945
  201. package/docs/reference/server-config.md +0 -973
  202. package/docs/reference/training.md +0 -462
  203. package/docs/reference/troubleshooting.md +0 -158
  204. package/src/admission-plan.ts +0 -18
  205. package/src/audio/audiotoolbox.ts +0 -112
  206. package/src/audio/conformer.ts +0 -655
  207. package/src/audio/decode.ts +0 -133
  208. package/src/audio/features.ts +0 -202
  209. package/src/audio/mic-capture.ts +0 -98
  210. package/src/audio/silero-vad.ts +0 -379
  211. package/src/audio/transcode.ts +0 -67
  212. package/src/audio/whisper-decode.ts +0 -774
  213. package/src/audio/whisper-fast.ts +0 -732
  214. package/src/audio/whisper-format.ts +0 -73
  215. package/src/audio/whisper-mel.ts +0 -185
  216. package/src/audio/whisper-timing.ts +0 -274
  217. package/src/audio/whisper-tokenizer.ts +0 -239
  218. package/src/audio/whisper-transcribe.ts +0 -410
  219. package/src/backends/mlx/assistant-target.ts +0 -46
  220. package/src/backends/mlx/autoregressive-draft-rows.ts +0 -120
  221. package/src/backends/mlx/autoregressive.ts +0 -129
  222. package/src/backends/mlx/batch-group.ts +0 -1874
  223. package/src/backends/mlx/cache-attachment.ts +0 -67
  224. package/src/backends/mlx/cache-layout.ts +0 -31
  225. package/src/backends/mlx/checkpoint-state.ts +0 -53
  226. package/src/backends/mlx/continuation-persistence.ts +0 -107
  227. package/src/backends/mlx/continuation-request.ts +0 -43
  228. package/src/backends/mlx/continuation.ts +0 -77
  229. package/src/backends/mlx/diffusion.ts +0 -39
  230. package/src/backends/mlx/draft-target.ts +0 -32
  231. package/src/backends/mlx/encoder-cache.ts +0 -25
  232. package/src/backends/mlx/evaluation.ts +0 -105
  233. package/src/backends/mlx/fill-append.ts +0 -58
  234. package/src/backends/mlx/fill-group.ts +0 -497
  235. package/src/backends/mlx/full-kv-row-append.ts +0 -32
  236. package/src/backends/mlx/full-kv-row-donor.ts +0 -54
  237. package/src/backends/mlx/full-transitioning-kv-rows.ts +0 -65
  238. package/src/backends/mlx/gateway-binding.ts +0 -174
  239. package/src/backends/mlx/graph.ts +0 -38
  240. package/src/backends/mlx/kv-codec.ts +0 -9
  241. package/src/backends/mlx/kv-maintenance.ts +0 -161
  242. package/src/backends/mlx/kv-tensor-rows.ts +0 -212
  243. package/src/backends/mlx/memory-client.ts +0 -189
  244. package/src/backends/mlx/methods.ts +0 -90
  245. package/src/backends/mlx/mixed-iteration.ts +0 -62
  246. package/src/backends/mlx/model-prompt.ts +0 -178
  247. package/src/backends/mlx/model-serving.ts +0 -80
  248. package/src/backends/mlx/paged-cache-codec.ts +0 -27
  249. package/src/backends/mlx/prefill-cohort.ts +0 -100
  250. package/src/backends/mlx/prefill-policy.ts +0 -26
  251. package/src/backends/mlx/prefill-rows.ts +0 -244
  252. package/src/backends/mlx/prefill.ts +0 -33
  253. package/src/backends/mlx/projected-context-rows.ts +0 -72
  254. package/src/backends/mlx/prompt-input.ts +0 -29
  255. package/src/backends/mlx/qwen-prompt-input.ts +0 -40
  256. package/src/backends/mlx/request-policy.ts +0 -20
  257. package/src/backends/mlx/request-state-policy.ts +0 -54
  258. package/src/backends/mlx/rollback.ts +0 -92
  259. package/src/backends/mlx/row-sampling.ts +0 -49
  260. package/src/backends/mlx/serial-executor.ts +0 -251
  261. package/src/backends/mlx/speculative-group.ts +0 -438
  262. package/src/backends/mlx/speculative-round.ts +0 -161
  263. package/src/backends/mlx/speculative.ts +0 -131
  264. package/src/backends/mlx/state-rows.ts +0 -104
  265. package/src/backends/mlx/state-views.ts +0 -46
  266. package/src/backends/mlx/target-layout-capability.ts +0 -35
  267. package/src/backends/mlx/text-engine.ts +0 -73
  268. package/src/backends/mlx/transitioning-kv-rows.ts +0 -173
  269. package/src/chat-template.ts +0 -382
  270. package/src/cli.ts +0 -3490
  271. package/src/config.ts +0 -399
  272. package/src/contracts/completion.ts +0 -16
  273. package/src/contracts/execution.ts +0 -70
  274. package/src/contracts/generation.ts +0 -103
  275. package/src/contracts/host.ts +0 -7
  276. package/src/contracts/object-cache.ts +0 -8
  277. package/src/contracts/pi-provider.ts +0 -30
  278. package/src/contracts/pi.ts +0 -261
  279. package/src/contracts/prefix-cache.ts +0 -33
  280. package/src/contracts/resources.ts +0 -25
  281. package/src/contracts/sampling.ts +0 -23
  282. package/src/contracts/scheduling.ts +0 -54
  283. package/src/contracts/tsconfig.json +0 -14
  284. package/src/dataset/generators.ts +0 -1087
  285. package/src/dataset/index.ts +0 -12
  286. package/src/dataset/job.ts +0 -81
  287. package/src/dataset/llm.ts +0 -71
  288. package/src/dataset/registry.ts +0 -528
  289. package/src/diffusion/diffusion-generate.ts +0 -507
  290. package/src/download.ts +0 -505
  291. package/src/embed.ts +0 -77
  292. package/src/engine/admission.ts +0 -59
  293. package/src/engine/cancellation.ts +0 -38
  294. package/src/engine/engine.ts +0 -56
  295. package/src/engine/execution-coordinator.ts +0 -70
  296. package/src/engine/execution-plan.ts +0 -64
  297. package/src/engine/execution-tasks.ts +0 -44
  298. package/src/engine/namespaced-cache.ts +0 -13
  299. package/src/engine/resources.ts +0 -53
  300. package/src/engine/scheduler.ts +0 -92
  301. package/src/engine/session.ts +0 -247
  302. package/src/eval/README.md +0 -130
  303. package/src/eval/ifeval.ts +0 -81
  304. package/src/eval/kl-prompts.ts +0 -29
  305. package/src/eval/kl.ts +0 -590
  306. package/src/eval/perplexity.ts +0 -164
  307. package/src/eval/quality-db.ts +0 -92
  308. package/src/eval/reference-logits.ts +0 -207
  309. package/src/eval/runner.ts +0 -124
  310. package/src/eval/score.ts +0 -49
  311. package/src/eval/tasks/bfcl.ts +0 -535
  312. package/src/eval/tasks/gsm8k.ts +0 -98
  313. package/src/eval/tasks/hashhop.ts +0 -139
  314. package/src/eval/tasks/humaneval.ts +0 -275
  315. package/src/eval/tasks/ifeval.ts +0 -525
  316. package/src/eval/tasks/mmlu.ts +0 -157
  317. package/src/eval/ultrafeedback.ts +0 -60
  318. package/src/evaldb.ts +0 -199
  319. package/src/expert-io.ts +0 -393
  320. package/src/expert-offload-build.ts +0 -77
  321. package/src/expert-offload.ts +0 -76
  322. package/src/expert-residency.ts +0 -1134
  323. package/src/expert-usage.ts +0 -415
  324. package/src/fill/echo-index.ts +0 -188
  325. package/src/fill/fill-session.ts +0 -463
  326. package/src/fill/proposal.ts +0 -68
  327. package/src/fill/schema-rows.ts +0 -506
  328. package/src/fill/tool-boundary.ts +0 -103
  329. package/src/fit.ts +0 -249
  330. package/src/generate.ts +0 -1352
  331. package/src/grammar.ts +0 -604
  332. package/src/harness-pi.ts +0 -184
  333. package/src/hf-push.ts +0 -628
  334. package/src/hub-rest.ts +0 -242
  335. package/src/index.ts +0 -63
  336. package/src/inference/denoising.ts +0 -17
  337. package/src/inference/draft-acceptance.ts +0 -41
  338. package/src/inference/draft-output.ts +0 -49
  339. package/src/inference/graph.ts +0 -33
  340. package/src/inference/prefill.ts +0 -45
  341. package/src/inference/rollback.ts +0 -7
  342. package/src/jobs/index.ts +0 -31
  343. package/src/jobs/job-entry.ts +0 -107
  344. package/src/jobs/task-client.ts +0 -19
  345. package/src/jobs/types.ts +0 -2
  346. package/src/kv-scheme.ts +0 -279
  347. package/src/kv-store.ts +0 -1135
  348. package/src/lab/README.md +0 -22
  349. package/src/lab/curve/curve-designer.html +0 -303
  350. package/src/lab/curve/curve-sampler.ts +0 -122
  351. package/src/lab/expert-trace/expert-trace.ts +0 -69
  352. package/src/lab/paged-kv/paged-attention.ts +0 -117
  353. package/src/lab/paged-kv/paged-kv-rows.ts +0 -111
  354. package/src/lab/paged-kv/paged-kv.ts +0 -336
  355. package/src/library.ts +0 -40
  356. package/src/lora.ts +0 -408
  357. package/src/md-modules.d.ts +0 -54
  358. package/src/media-fetch.ts +0 -442
  359. package/src/memory/article.ts +0 -558
  360. package/src/memory/chunk-validation.ts +0 -150
  361. package/src/memory/chunk.ts +0 -318
  362. package/src/memory/cluster.ts +0 -351
  363. package/src/memory/coverage.ts +0 -134
  364. package/src/memory/crosslink.ts +0 -0
  365. package/src/memory/db.ts +0 -253
  366. package/src/memory/entity.ts +0 -203
  367. package/src/memory/gate.ts +0 -187
  368. package/src/memory/history.ts +0 -152
  369. package/src/memory/ingest.ts +0 -335
  370. package/src/memory/model.ts +0 -183
  371. package/src/memory/normalize.ts +0 -671
  372. package/src/memory/parse.ts +0 -22
  373. package/src/memory/pipeline.ts +0 -275
  374. package/src/memory/prompts.ts +0 -65
  375. package/src/memory/query.ts +0 -334
  376. package/src/memory/reconcile.ts +0 -734
  377. package/src/memory/redirect.ts +0 -108
  378. package/src/memory/reindex.ts +0 -325
  379. package/src/memory/resolve.ts +0 -307
  380. package/src/memory/rest.ts +0 -245
  381. package/src/memory/route.ts +0 -272
  382. package/src/memory/schedule.ts +0 -165
  383. package/src/memory/stages.ts +0 -777
  384. package/src/memory/synthesize.ts +0 -1638
  385. package/src/memory/tools.ts +0 -749
  386. package/src/memory/vault.ts +0 -1194
  387. package/src/memory/wikify.ts +0 -1064
  388. package/src/mlx/array.ts +0 -425
  389. package/src/mlx/autograd.ts +0 -304
  390. package/src/mlx/checkpoint.ts +0 -149
  391. package/src/mlx/compile.ts +0 -168
  392. package/src/mlx/custom-vjp.ts +0 -188
  393. package/src/mlx/ffi.ts +0 -531
  394. package/src/mlx/materialize.ts +0 -23
  395. package/src/mlx/metal-kernel.ts +0 -159
  396. package/src/mlx/normalized-argmax.ts +0 -116
  397. package/src/mlx/ops.ts +0 -1108
  398. package/src/mlx/quantized-rows.ts +0 -36
  399. package/src/mlx/token-bitmask.ts +0 -52
  400. package/src/mlx/turboquant-kv-decode.ts +0 -82
  401. package/src/mlx/turboquant-kv-inverse.ts +0 -122
  402. package/src/mlx/turboquant-ops.ts +0 -861
  403. package/src/mlx/turboquant-tables.ts +0 -237
  404. package/src/mmap.ts +0 -90
  405. package/src/model/artifact-identity.ts +0 -73
  406. package/src/model/batched-kv.ts +0 -235
  407. package/src/model/batched-mask.ts +0 -279
  408. package/src/model/batched-quant.ts +0 -212
  409. package/src/model/batched-quantized-kv.ts +0 -144
  410. package/src/model/batched-rotating-quant.ts +0 -353
  411. package/src/model/batched-rotating-state.ts +0 -149
  412. package/src/model/batched-rotating.ts +0 -338
  413. package/src/model/batched-row-storage.ts +0 -179
  414. package/src/model/batched-ssm.ts +0 -52
  415. package/src/model/batched-turboquant-kv.ts +0 -94
  416. package/src/model/compiled-decode.ts +0 -712
  417. package/src/model/decoded-kv-donor.ts +0 -12
  418. package/src/model/delayed-quantized-kv.ts +0 -72
  419. package/src/model/delayed-rotating-quantized-kv.ts +0 -93
  420. package/src/model/delayed-turboquant-kv.ts +0 -57
  421. package/src/model/diffusion-gemma.ts +0 -1026
  422. package/src/model/factory.ts +0 -215
  423. package/src/model/fingerprint.ts +0 -45
  424. package/src/model/flash-attention.ts +0 -694
  425. package/src/model/full-prefill-padding.ts +0 -56
  426. package/src/model/full-prefill-row.ts +0 -105
  427. package/src/model/gemma4-base.ts +0 -2370
  428. package/src/model/gemma4.ts +0 -1395
  429. package/src/model/generated/gemma4-12b.ts +0 -429
  430. package/src/model/generated/gemma4-26b.ts +0 -448
  431. package/src/model/generated/gemma4-e4b.ts +0 -717
  432. package/src/model/generated/index.ts +0 -18
  433. package/src/model/glm52-atlas.ts +0 -511
  434. package/src/model/glm52-cache.ts +0 -792
  435. package/src/model/glm52-config.ts +0 -262
  436. package/src/model/glm52-container.ts +0 -305
  437. package/src/model/glm52-coupling.ts +0 -388
  438. package/src/model/glm52-dsa.ts +0 -606
  439. package/src/model/glm52-expert-layout.ts +0 -253
  440. package/src/model/glm52-layout.ts +0 -152
  441. package/src/model/glm52-memory.ts +0 -500
  442. package/src/model/glm52-mla.ts +0 -792
  443. package/src/model/glm52-moe.ts +0 -223
  444. package/src/model/glm52-pilot.ts +0 -537
  445. package/src/model/glm52-reference.ts +0 -445
  446. package/src/model/glm52-residency.ts +0 -557
  447. package/src/model/glm52-resident-weights.ts +0 -135
  448. package/src/model/glm52-streamed-experts.ts +0 -453
  449. package/src/model/glm52-streamed-metal.ts +0 -610
  450. package/src/model/glm52-weights.ts +0 -503
  451. package/src/model/glm52.ts +0 -1132
  452. package/src/model/implementation.ts +0 -69
  453. package/src/model/kv-attention-view.ts +0 -70
  454. package/src/model/minicpm5.ts +0 -376
  455. package/src/model/profile.ts +0 -468
  456. package/src/model/quantized-append-attention.ts +0 -31
  457. package/src/model/qwen-append.ts +0 -12
  458. package/src/model/qwen-conv.ts +0 -52
  459. package/src/model/qwen3-delta-state.ts +0 -74
  460. package/src/model/qwen3-delta.ts +0 -451
  461. package/src/model/qwen3-moe.ts +0 -404
  462. package/src/model/qwen3-mrope.ts +0 -250
  463. package/src/model/qwen3.ts +0 -277
  464. package/src/model/qwen3_5-checkpoint.ts +0 -164
  465. package/src/model/qwen3_5.ts +0 -881
  466. package/src/model/rotating-kv-donor.ts +0 -35
  467. package/src/model/rotating-kv-layout.ts +0 -262
  468. package/src/model/rotating-row-transaction.ts +0 -35
  469. package/src/model/speculative-rotating-kv.ts +0 -101
  470. package/src/model/ssm-prefill-padding.ts +0 -39
  471. package/src/model/support.ts +0 -110
  472. package/src/model/token-groups.ts +0 -66
  473. package/src/model/trellis-balanced-scatter.ts +0 -51
  474. package/src/model/trellis-linear.ts +0 -672
  475. package/src/model/trellis-shared-m.ts +0 -151
  476. package/src/model/trellis-shared-scatter.ts +0 -144
  477. package/src/model/trellis-splitk-prefill.ts +0 -158
  478. package/src/model/trellis-tiled-prefill.ts +0 -136
  479. package/src/model/trellis-vector-expand.ts +0 -62
  480. package/src/model/trellis-wide-prefill.ts +0 -94
  481. package/src/model/turboquant-codec.ts +0 -89
  482. package/src/model/universal/archs.ts +0 -332
  483. package/src/model/universal/dense.ts +0 -612
  484. package/src/model/universal/modules.ts +0 -170
  485. package/src/model/universal/rope.ts +0 -381
  486. package/src/model/whisper.ts +0 -435
  487. package/src/native/expert_io.c +0 -523
  488. package/src/native/frame_extract.swift +0 -140
  489. package/src/native/mic_capture.swift +0 -92
  490. package/src/native-pack.ts +0 -163
  491. package/src/pi-provider.ts +0 -53
  492. package/src/pi-session.ts +0 -81
  493. package/src/pi-terminal.ts +0 -274
  494. package/src/pi-web.ts +0 -1940
  495. package/src/preflight.ts +0 -158
  496. package/src/prompt-cache.ts +0 -682
  497. package/src/quantize/allocator.ts +0 -627
  498. package/src/quantize/atomic-output.ts +0 -38
  499. package/src/quantize/calibration.ts +0 -181
  500. package/src/quantize/config-writer.ts +0 -145
  501. package/src/quantize/index.ts +0 -84
  502. package/src/quantize/job.ts +0 -162
  503. package/src/quantize/quantizer.ts +0 -666
  504. package/src/quantize/rotate.ts +0 -603
  505. package/src/quantize/safetensors-writer.ts +0 -249
  506. package/src/quantize/sensitivity.ts +0 -216
  507. package/src/quantize/trellis.ts +0 -586
  508. package/src/quantize/weight-transform.ts +0 -292
  509. package/src/registry.ts +0 -602
  510. package/src/runtime-config.ts +0 -77
  511. package/src/safetensors.ts +0 -165
  512. package/src/sampler.ts +0 -1012
  513. package/src/serve/admin-routes.ts +0 -184
  514. package/src/serve/assets/curve-terrain.html +0 -105
  515. package/src/serve/assets/training-inference-map.html +0 -575
  516. package/src/serve/audio-routes.ts +0 -323
  517. package/src/serve/aux-routes.ts +0 -132
  518. package/src/serve/batch-scheduler.ts +0 -8
  519. package/src/serve/checkpoint-identity.ts +0 -64
  520. package/src/serve/generation-gateway.ts +0 -537
  521. package/src/serve/isolate.ts +0 -609
  522. package/src/serve/kv-budget.ts +0 -14
  523. package/src/serve/lab-routes.ts +0 -341
  524. package/src/serve/lane-registry.ts +0 -45
  525. package/src/serve/model-admin-routes.ts +0 -155
  526. package/src/serve/model-binding.ts +0 -49
  527. package/src/serve/model-host.ts +0 -511
  528. package/src/serve/parent-application.ts +0 -56
  529. package/src/serve/prompt-response-trace.ts +0 -161
  530. package/src/serve/response-lease.ts +0 -24
  531. package/src/serve/session-search.ts +0 -326
  532. package/src/serve/static-routes.ts +0 -101
  533. package/src/serve/transcription-server.ts +0 -64
  534. package/src/serve/transcription-service.ts +0 -502
  535. package/src/server.ts +0 -1282
  536. package/src/spec/assistant-rows.ts +0 -93
  537. package/src/spec/assistant-source.ts +0 -126
  538. package/src/spec/cache-identity.ts +0 -22
  539. package/src/spec/deepspec-rows.ts +0 -29
  540. package/src/spec/deepspec-source.ts +0 -145
  541. package/src/spec/dflash-source.ts +0 -149
  542. package/src/spec/drafter.ts +0 -304
  543. package/src/spec/dspark/ab-stats.ts +0 -136
  544. package/src/spec/dspark/calibration.ts +0 -112
  545. package/src/spec/dspark/data-dflash.ts +0 -156
  546. package/src/spec/dspark/data.ts +0 -201
  547. package/src/spec/dspark/deepspec-module.ts +0 -776
  548. package/src/spec/dspark/generate-dflash.ts +0 -245
  549. package/src/spec/dspark/generate.ts +0 -290
  550. package/src/spec/dspark/loader.ts +0 -23
  551. package/src/spec/dspark/loss.ts +0 -213
  552. package/src/spec/dspark/module-dflash.ts +0 -560
  553. package/src/spec/dspark/module.ts +0 -540
  554. package/src/spec/dspark/quantize-drafter.ts +0 -91
  555. package/src/spec/dspark/sample.ts +0 -112
  556. package/src/spec/generate.ts +0 -276
  557. package/src/spec/glm52-mtp-graph.ts +0 -29
  558. package/src/spec/glm52-mtp-rows.ts +0 -132
  559. package/src/spec/glm52-mtp-source.ts +0 -318
  560. package/src/spec/glm52-mtp-state.ts +0 -33
  561. package/src/spec/ngram-source.ts +0 -226
  562. package/src/spec/projected-draft-rows.ts +0 -73
  563. package/src/spec/qwen-mtp-module.ts +0 -171
  564. package/src/spec/qwen-mtp-rows.ts +0 -230
  565. package/src/spec/qwen-mtp-source.ts +0 -386
  566. package/src/spec/qwen-mtp-state.ts +0 -30
  567. package/src/spec/serve-loop.ts +0 -587
  568. package/src/spec/source.ts +0 -228
  569. package/src/spec/two-model-rows.ts +0 -62
  570. package/src/spec/two-model.ts +0 -113
  571. package/src/ssd-cache.ts +0 -431
  572. package/src/ssd-durability.ts +0 -209
  573. package/src/storage/host-buffer.ts +0 -24
  574. package/src/storage/kv-writer.ts +0 -83
  575. package/src/storage/kv-writer.worker.js +0 -264
  576. package/src/storage/retention-policy.ts +0 -37
  577. package/src/tiered-prompt-cache.ts +0 -45
  578. package/src/tokenizer.ts +0 -335
  579. package/src/tool-approvals.ts +0 -131
  580. package/src/tool-call.ts +0 -695
  581. package/src/train/dataset.ts +0 -484
  582. package/src/train/diffusion-lora.ts +0 -216
  583. package/src/train/export.ts +0 -32
  584. package/src/train/flash-cce.ts +0 -1234
  585. package/src/train/forward.ts +0 -266
  586. package/src/train/fuse.ts +0 -243
  587. package/src/train/index.ts +0 -46
  588. package/src/train/job.ts +0 -205
  589. package/src/train/lora-params.ts +0 -254
  590. package/src/train/loss.ts +0 -1591
  591. package/src/train/merge.ts +0 -195
  592. package/src/train/optimizer.ts +0 -183
  593. package/src/train/prefix-shared.ts +0 -490
  594. package/src/train/rank.ts +0 -137
  595. package/src/train/segmented.ts +0 -1828
  596. package/src/train/steel-qmm-header.ts +0 -1461
  597. package/src/train/trainer.ts +0 -1221
  598. package/src/train/watch.ts +0 -542
  599. package/src/vision/diffusion-vision.ts +0 -620
  600. package/src/vision/embedder.ts +0 -176
  601. package/src/vision/preprocess.ts +0 -247
  602. package/src/vision/prompt.ts +0 -409
  603. package/src/vision/qwen3vl-preprocess.ts +0 -409
  604. package/src/vision/qwen3vl-prompt.ts +0 -233
  605. package/src/vision/qwen3vl-tower.ts +0 -566
  606. package/src/vision/siglip.ts +0 -607
  607. package/src/vision/video-frames.ts +0 -148
  608. package/src/web/app.html +0 -2155
  609. package/src/web/app.js +0 -5863
  610. package/src/web/skills/memory/SKILL.md +0 -120
  611. package/src/web/skills/web-research/SKILL.md +0 -46
  612. package/src/web/skills.ts +0 -97
  613. package/src/web/src/adapters-panel.ts +0 -288
  614. package/src/web/src/assistant.ts +0 -451
  615. package/src/web/src/chat.ts +0 -1060
  616. package/src/web/src/composer.ts +0 -962
  617. package/src/web/src/dataset.ts +0 -132
  618. package/src/web/src/finetune.ts +0 -267
  619. package/src/web/src/hub.ts +0 -428
  620. package/src/web/src/main.ts +0 -98
  621. package/src/web/src/markdown.ts +0 -0
  622. package/src/web/src/memory-panel.ts +0 -572
  623. package/src/web/src/model-picker.ts +0 -159
  624. package/src/web/src/palette.ts +0 -346
  625. package/src/web/src/protocol.ts +0 -26
  626. package/src/web/src/quantize.ts +0 -167
  627. package/src/web/src/rag.ts +0 -274
  628. package/src/web/src/sessions.ts +0 -469
  629. package/src/web/src/shell.ts +0 -804
  630. package/src/web/src/ui-catalog.ts +0 -78
  631. package/src/web/src/voice.ts +0 -141
  632. package/src/web/vendor/README.md +0 -61
  633. package/src/web-assets.ts +0 -47
  634. package/src/web-tools.ts +0 -478
  635. package/src/weights.ts +0 -255
  636. /package/src/{serve → server}/completion-sink.ts +0 -0
  637. /package/src/{serve → server}/generated-token-history.ts +0 -0
  638. /package/src/web/{icon.svg → public/icon.svg} +0 -0
  639. /package/src/web/{manifest.webmanifest → public/manifest.webmanifest} +0 -0
  640. /package/src/web/{vendor → public/vendor}/hljs-LICENSE +0 -0
@@ -1,119 +0,0 @@
1
- # Research Topics
2
-
3
- Speculative, exploratory directions for mlx-bun — theses worth prototyping, not
4
- committed work. Each entry carries enough detail to pick up cold. PLAN.md is for
5
- work in flight; this is for ideas waiting their turn.
6
-
7
- ---
8
-
9
- ## 1. Tonal Grading for Token Distributions ("HDR Sampling")
10
-
11
- > Replace the global scalar sampling knobs (temperature, top-k, top-p) with a
12
- > region-aware **transfer function** applied to logits before softmax — the
13
- > color-grading move, ported to token distributions.
14
-
15
- **Framing — the Wes Anderson point.** A film's symmetrical pastel look isn't a
16
- colorist failing to neutralize; it's a *target*. Grade Marvel that way and it's
17
- "wrong" only against Marvel's acceptance function, not against any absolute.
18
- Different films, different targets — and you have a lot of films. The
19
- Lucien-synthesis agent and the test-writing agent want different *looks*, and
20
- "temperature + a system-prompt vibe word" is the crude contrast slider standing
21
- in for a real grade.
22
-
23
- **Core thesis.** Current LLM sampling is "SDR": the available controls
24
- (temperature, top-k, top-p) are crude *global* knobs — the equivalent of a single
25
- contrast slider. Color grading abandoned "just turn the contrast knob" long ago
26
- in favor of transfer functions with region-specific behavior. The same move is
27
- available for sampling: replace global scalar knobs with a region-aware transfer
28
- function applied to the logits before softmax.
29
-
30
- **The reframe that makes it work.** Signal vs. noise is defined by *intent*, not
31
- by magnitude — exactly as on a camera sensor, where the noise floor is "noise"
32
- because it doesn't represent what's wanted, not because it's small. The full
33
- logit vector is the model's signal, but it is not the signal *I* care about. My
34
- acceptance criterion defines which part is signal. The low-logit tail is
35
- therefore legitimately treatable as a noise floor to roll off.
36
-
37
- **The three regions** — one curve, three treatments. This is precisely what
38
- temperature *cannot* do, since it scales everywhere uniformly:
39
-
40
- - **Shoulder** (head / confident tokens): soft rolloff instead of hard
41
- truncation. Top-k/top-p slam into the ceiling and clip; a shoulder eases the
42
- top tokens toward co-equality while *preserving their ordering* — it tames
43
- single-token dominance without destroying the relationships among the spared
44
- tokens.
45
- - **Midtones** (the plausible-but-distinct band): steepen for local contrast.
46
- Push apart the tokens that matter so detail comes out sharp. This has no name
47
- in current sampling because sampling has no concept of distributional
48
- midtones — and it's the most novel piece.
49
- - **Toe** (tail / unwanted tokens): roll into the floor. Defines them as noise
50
- relative to intent.
51
-
52
- **Curve vocabulary, ported from grading:**
53
-
54
- - **Pivot/cut** placed *relative* to the distribution (by rank or percentile),
55
- recomputed every step — never an absolute logit value, because logits are only
56
- meaningful up to an additive constant (softmax shift-invariance). HLG's
57
- relative / scene-referred design is the right philosophical match; LogC3 is
58
- more absolute / exposure-locked.
59
- - **Slope-matched splices** between regions (C1 continuity — no kink in how
60
- adjacent-ranked tokens get treated).
61
- - **Curve family:** signed / `log1p`-style forms to stay finite on negative
62
- logits. An HLG-style architecture (gamma toe + log shoulder, slope-matched) is
63
- the leading candidate because its two-regime structure happens to match the
64
- two-regime structure of a real logit distribution — temperature-style shaping
65
- on the uncertain tail, log-style compression on the overconfident head.
66
-
67
- **Why it's not overclaiming.** I am *not* claiming buried capability that a curve
68
- "unclips" — the logits aren't a compressed encoding of something richer. The
69
- honest claim: there is an acceptable manifold the model can't articulate and the
70
- default transform doesn't reliably land on; the curve encodes my
71
- *observer-relative acceptance function* onto a distribution that has no opinion
72
- of its own. This is why sampling knobs exist at all — "friendly / neutral /
73
- professional" are crude gestures at exactly this, and a grade is the
74
- high-resolution version.
75
-
76
- **The per-agent-target insight (the payoff).** "Correctly transformed to display"
77
- is not universally acceptable — it's unacceptable for an Oscar-buzz feature and
78
- fine for a sports broadcast, because they have different acceptance functions.
79
- Grading Marvel like Wes Anderson isn't incompetence; it's the wrong *target*. My
80
- agents are different films:
81
-
82
- - A **conversation→article synthesis** agent wants range, texture, and
83
- surprising-but-apt word choices — "cinematic."
84
- - An **acceptance-criteria→tests** agent wants tight, predictable, low-variance
85
- determinism — "broadcast neutral."
86
-
87
- They want different *grades*, not different *temperatures*. Per-task tonal
88
- curves, not per-task scalar knobs.
89
-
90
- **Open engineering question — build this first.** The colorist works in a tight
91
- perceptual loop against a calibrated reference monitor; a sampler's curve is
92
- chosen *upstream* of seeing output, with a slower, noisier judgment loop. So the
93
- gating question isn't "is the curve good" — it's **"what is the monitor?"** What
94
- readout tells me the midtones got crisper and the highlights rolled off well, per
95
- target? Candidates: held-out preference, diversity-at-fixed-quality, task-specific
96
- pass rates (for the test agent) vs. human preference (for the synthesis agent).
97
- Define the per-target reference monitor first; the curve design follows from it
98
- the way a grade follows from a trustworthy display.
99
-
100
- **Implementation.** A pure elementwise function on the logits tensor inside
101
- mlx-bun's per-step logits-processor hook: sort once for the rank-relative pivot,
102
- apply the slope-matched toe/mid/shoulder curve, renormalize, sample. The hook
103
- already exists — logits processors run at
104
- [`generate.ts:236`](../../src/generate.ts:236)
105
- (`for (const p of processors) logits = disposing(logits, p(history, logits))`),
106
- built by `makeLogitsProcessors` in [`src/sampler.ts`](../../src/sampler.ts) as pure
107
- `(history, logits) => logits` functions applied before `toLogprobs` and the
108
- sampler — so the curve drops in as one more processor in that loop.
109
-
110
- Given dispatch dominates decode wall time (~90–96%), the curve's arithmetic cost
111
- rides inside work already dispatched — wall-time-negligible. Parameterize: pivot
112
- rank, toe exponent, midtone slope, shoulder compression. A/B against plain
113
- temperature **at matched effective entropy**, judged on the per-target monitor —
114
- looking for outputs that land in the target region *unreachably* by
115
- temperature-plus-top-p at any setting, not merely "different."
116
-
117
- *Relation to current code:* the `--temperature` / `--top-p` / `--top-k` server
118
- defaults (and `generation_config.json`) are the SDR knobs this topic proposes to
119
- supersede — useful as the A/B baseline, not the destination.
@@ -1,244 +0,0 @@
1
- # Public readiness — handoff (2026-09-11)
2
-
3
- Task list and verified context for the outreach thread. The scope and
4
- acceptance criteria for each milestone live in
5
- [public-readiness.md](public-readiness.md); milestone state lives in
6
- [PLAN.md](../../PLAN.md#public-readiness). This document says what was
7
- verified today, what that changes, and what to do next, in order.
8
-
9
- ## Update after handoff
10
-
11
- The GPTQ report is filed as [mlx-lm #1878](https://github.com/ml-explore/mlx-lm/issues/1878).
12
- The issue contains the complete runnable reproduction and proposed fix; the
13
- local reproduction files have been removed. Independent-reference regression
14
- coverage and upstream follow-up remain open. Presentation changes and GitHub
15
- metadata are also complete on this branch. The sections below preserve the
16
- review handoff as written; their original state labels predate this update.
17
-
18
- ## What was verified today
19
-
20
- **The listing target is stalled.** The mlx-framework.org "community" section
21
- is a single link to [discussion #654](https://github.com/ml-explore/mlx/discussions/654);
22
- there is no separate curated page. The pinned list in #654 was last edited
23
- 2025-10-17. Every comment since March 2026 (at least 20, including two
24
- projects named `mlx-serve`, `mlx-node`, `atlas`, `squish`, `mlx-chronos`,
25
- `mlx-tsfm`) has no maintainer reply and none were added. Only `awni` or an
26
- ml-explore member with write access can edit that post.
27
-
28
- **Awni Hannun no longer maintains MLX.** He left Apple in February 2026 (last
29
- `ml-explore/mlx` commit 2026-02-24) and is at Anthropic. He still comments on
30
- mlx-lm issues occasionally (last seen 2026-08-24) but is not the person who
31
- will act on a listing request. Named successors: Angelos Katharopoulos
32
- (`angeloskath`), Cheng Zhao (`zcbenz`), Jagrit Digani (`jagrit06`),
33
- Anastasiia Filippova (`nastya236`), Ronan Collobert. Recent mlx-lm committers:
34
- `michalk8`, `zcbenz`, `angeloskath`.
35
-
36
- **The GPTQ bug is live upstream and unreported.** `mlx_lm/quant/gptq.py`
37
- on `main` (1b3594b, 2026-09-09) still contains both defects at lines 126–127:
38
- the `k : k + j` window that propagates past the block edge, and
39
- `err[..., k : k + 1]` indexing a group-local buffer with a global column
40
- index (a silent no-op for every block after the first). Issue search for
41
- `gptq` in ml-explore/mlx-lm returns only perf/memory reports (#1094, #1098,
42
- #1122). The reproduction is included in [mlx-lm #1878](https://github.com/ml-explore/mlx-lm/issues/1878).
43
-
44
- **The category is crowded.** Already in the #654 thread: `mlx-serve`
45
- (ddalcu, Zig, no Python, Gemma 4 + Qwen 3.x, MTP, TurboQuant KV, OpenAI +
46
- Anthropic APIs), `mlx-serve` (raspoli), `mlx-node` (Node.js inference and
47
- training APIs), `mlx-omni-server`, `squish`. "No Python OpenAI-compatible
48
- server" is not a differentiator. "TypeScript library" needs a comparison
49
- with `mlx-node` before it is claimed as one.
50
-
51
- **Other places a project actually gets listed.** `raullenchai/awesome-mlx`
52
- (466 stars, last push 2026-04-11) accepts PRs. `igurss/mlx-chronos` (last
53
- push 2026-08-22) is a benchmark suite and leaderboard for MLX inference
54
- engines with reproducible JSON submissions.
55
-
56
- ## What this changes
57
-
58
- - A #654 comment is the last step and should be expected to sit. The
59
- outcomes that are actually reachable, in order of value: a merged or
60
- acknowledged upstream fix; a Show-and-tell post that a current maintainer
61
- replies to; an `awesome-mlx` PR; an `mlx-chronos` submission; and, if any
62
- of those produce a conversation with a maintainer, the listing ask goes in
63
- that thread rather than into the #654 pile.
64
- - Outreach copy should not be written for Awni. It should be written for
65
- `angeloskath`/`zcbenz`-style readers: correctness first, measured numbers
66
- with machine labels, an upstream contribution in hand, no digs at mlx-lm.
67
- - The first-impression fixes matter more, not less: a maintainer visit will
68
- be rare and there is one chance at it.
69
-
70
- ## State of the work (working tree, this branch)
71
-
72
- Done or in flight in the uncommitted diff on `chore/public-readiness`:
73
-
74
- - `docs/planning/public-readiness.md` rewritten as P0–P5; PLAN block updated.
75
- - `docs/reference/benchmarks.md` restructured: parity table first, latest
76
- h2h second; campaign ledger moved to
77
- `docs/archive/investigations/benchmark-ledger-through-v0.4.0.md`.
78
- - README lead paragraph narrowed to library + server; STATUS/PLAN link
79
- removed from the README table.
80
- - `lab/repro/mlx-lm-gptq-block-indexing/repro.py` written (CPU-only, no
81
- weights; asserts the installed source matches, runs original vs corrected).
82
- - `docs/reference/models.md` edited (roster/evidence reconciliation, partial).
83
-
84
- Not started: oracle setup script and lock (P2), package ownership map (P3),
85
- tarball/first-run/library-consumer verification and GitHub metadata (P4),
86
- every outreach draft (P5).
87
-
88
- ## Tasks, in order
89
-
90
- Each task names its owner: **agent** (can be done in a session), **Josh**
91
- (needs approval, an account, a server, or a download). Session rules apply:
92
- no long-running servers or multi-GB downloads from a session.
93
-
94
- ### T1 — Upstream GPTQ report (P0) — agent drafts, Josh submits
95
-
96
- Filed 2026-09-11 as [mlx-lm #1878](https://github.com/ml-explore/mlx-lm/issues/1878)
97
- (both defects, CPU-only fixture, observed result on 0.31.3 and upstream
98
- `e5962529`, proposed two-line patch). Recorded in
99
- [turboquant.md](../design/turboquant.md) and `scripts/turboquant/tq-gptq.py`.
100
-
101
- Fix open as [mlx-lm PR #1880](https://github.com/ml-explore/mlx-lm/pull/1880)
102
- from `joshuarossi/mlx-lm:fix-gptq-block-indexing` (`d4d38d9`): the two-line
103
- change in `mlx_lm/quant/gptq.py` plus `tests/test_gptq.py`, which compares
104
- `gptq_quantize` against a column-by-column reference (paper form, no lazy
105
- block update) over four groups, with a single-group control. On upstream
106
- `e596252` the multi-group test fails (max abs dequantized diff 0.38) and the
107
- control passes; on the branch both pass. black 25.1.0 / isort 6.0.0 / ruff
108
- 0.16.6 clean. The issue body was rewritten in Josh's words and the PR
109
- description discloses AI-drafted code, per mlx-lm's CONTRIBUTING.md.
110
-
111
- Remaining: **follow up.** Check the PR for maintainer questions every few
112
- days; answer with test output, not prose (Josh writes the replies; the
113
- policy covers comments too). Record the outcome (merged, changed,
114
- declined) in turboquant.md.
115
-
116
- Acceptance: any maintainer question answered; outcome recorded.
117
-
118
- ### T2 — Finish the internal-voice scrub (P1) — agent
119
-
120
- Current counts in public entry points (`rg -c "Josh"`): STATUS.md 4,
121
- `docs/reference/environment.md` 3. `benchmarks.md` is clean after the
122
- restructure; check the archive ledger is linked, not rendered by the site.
123
- Also grep the website source and every `docs/reference/*.md` for
124
- `authorized`, `diagnostic mode`, `machine policy`, `Josh requested`,
125
- `per Josh` and rewrite as technical conditions (keep the CPU/swap/memory
126
- facts, drop the approval framing). Do not touch `PLAN.md`/design docs for
127
- this; they are internal by design and no longer linked from the README.
128
-
129
- Acceptance: the greps return zero in README, STATUS, CONTRIBUTING,
130
- `docs/reference/*`, `website/src/**`; `bun scripts/check-hygiene.ts` passes.
131
-
132
- ### T3 — Fix the site claims (P1) — agent
133
-
134
- `website/src/content/docs/index.mdx` "Why it's different" and the numbers
135
- table:
136
-
137
- - "Fastest to first token … of any stack tested" → "vs `mlx_lm.server` and
138
- optiq serve" and state that it is server overhead at warm cache, not
139
- model speed.
140
- - Remove "no segfaults on exit".
141
- - "bit-exact to the Python reference" → "bit-exact logits vs mlx-lm on the
142
- validated configurations (link to the parity table)".
143
- - Reduce the eight feature cards to library, server/API, correctness,
144
- measured performance; fold memory/curves/training/diffusion into one
145
- "also in the box" line.
146
- - First-run model: the site shows `MiniCPM5-1B` (index.mdx:24,
147
- quickstart.md:16, installation.mdx:81); `DEFAULT_REPO_ID` in `src/fit.ts:88`
148
- is the 7 GB e4b. Pick one and make code, README and site agree.
149
-
150
- Acceptance: `bun run --cwd website build` passes; a narrow-viewport check
151
- of the landing page; `tests/docs-surface.test.ts` passes.
152
-
153
- ### T4 — Roster vs parity evidence (P1) — agent
154
-
155
- `models.md` labels Qwen3.5-4B, Qwen3.8-27B and eleven Tier-0 archs L1;
156
- the parity table in `benchmarks.md` lists four Gemma/MiniCPM rows. For each
157
- L1 row, either add the artifact + test file to the parity table (the Qwen
158
- oracle cases and universal goldens exist under `tests/parity/` and
159
- `scripts/oracle/gen-universal-golden.py`) or mark the row "family-supported,
160
- artifact-unvalidated" in the roster. No row may claim L1 without a named
161
- test.
162
-
163
- Acceptance: every L1 in `models.md` resolves to a row in `benchmarks.md §1`.
164
-
165
- ### T5 — Reproducible oracle (P2) — agent builds, Josh runs the clean check
166
-
167
- 1. Add a new `setup.sh` under `scripts/oracle/` (plus a committed lock, pip
168
- freeze or `uv` lock) that recreates the pinned venv anywhere and prints
169
- the `MLX_BUN_ORACLE_VENV=` line. Until the file exists, do not write its
170
- full path into a live doc: hygiene check 7 fails on script paths that do
171
- not exist, and `public-readiness.md` P2 currently trips it. Pins come from
172
- [environment.md](../reference/environment.md) (mlx 0.32.2, mlx-metal
173
- 0.32.2, mlx-lm 0.31.3, Python 3.13.5).
174
- 2. Document one command chain that ends in a real pass, not a skip:
175
- setup → `mlx-bun get MiniCPM5` (sub-GB) → regen the MiniCPM goldens with
176
- `scripts/regen/minicpm5.ts` → `bun test tests/parity/minicpm5-parity.test.ts`.
177
- Make the test fail loudly when goldens or venv are missing.
178
- 3. Explain, in that section, machine-layered goldens and the fast-SDPA
179
- dispatch boundary (L ≥ 16) so a reader on another Mac knows why their
180
- binary goldens differ from the tracked manifest.
181
- 4. Josh: run the chain on the other dev box from a clean checkout and record
182
- wall time. Do not print a duration in docs until this run supports it.
183
-
184
- Acceptance: the chain passes on a machine that never had Josh's venv path.
185
-
186
- ### T6 — Package ownership map (P3) — agent
187
-
188
- Produce the dependency map the milestone asks for
189
- (`reports/public-readiness/` already has source-import and dry-run
190
- reports): which `src/` roots the `mlx-bun`, `mlx-bun/engine`, `mlx-bun/client`
191
- exports reach, which runtime deps and native assets each needs, and what
192
- the CLI/server/app layers add. Recommend keep-as-is or extract, with the
193
- reason. Compare against `mlx-node`'s packaging while doing it, since that is
194
- the closest JS-side comparison and the pitch depends on the difference.
195
-
196
- Acceptance: the map and decision recorded in engine architecture §12.15;
197
- no code move unless justified in that record.
198
-
199
- ### T7 — Candidate, tarball, metadata (P4) — agent prepares, Josh verifies
200
-
201
- - `bun pm pack --dry-run` and inspect: no `reports/`, `runs/`, goldens
202
- blobs, or research output; `bin`, `src`, `docs` present.
203
- - GitHub repo settings (currently empty): description, homepage
204
- `https://mlx-bun.dev`, topics `mlx apple-silicon bun llm metal
205
- openai-compatible`. `gh repo edit joshuarossi/mlx-bun --description ...
206
- --homepage ... --add-topic ...`.
207
- - Josh, on a clean user account or fresh machine: `curl … | sh`, first
208
- `mlx-bun serve`, browser chat, one streaming request, one `openai` SDK
209
- call, one library consumer importing `mlx-bun/engine`. Record what broke.
210
-
211
- Acceptance: as written in public-readiness.md P4.
212
-
213
- ### T8 — Outreach drafts (P5) — agent drafts, Josh posts
214
-
215
- Write all four before posting any, so they agree:
216
-
217
- 1. **Discord intro** (MLX Community, verify channel first): three
218
- sentences, the parity command from T5, one ask ("does the TypeScript
219
- integration make sense to you; what would you want from the library
220
- API"). No numbers without a machine label.
221
- 2. **Show and tell** post on ml-explore/mlx: what it is, how to reproduce
222
- the parity claim, the h2h table with losses, the upstream GPTQ PR link,
223
- known limits, the model roster. This is the artifact a maintainer might
224
- actually read.
225
- 3. **awesome-mlx PR** and an **mlx-chronos** submission (check the
226
- submission format in that repo; our `bench-serve.ts` output may map to
227
- it).
228
- 4. **#654 comment**: the one-line sentence already drafted in
229
- public-readiness.md P5.
230
-
231
- Post order: T1's upstream PR → Discord → Show and tell → awesome-mlx /
232
- chronos → #654. If a maintainer replies anywhere, ask for the #654 add in
233
- that reply.
234
-
235
- ## Do not
236
-
237
- - Do not write copy aimed at Awni or predict Apple's reaction.
238
- - Do not compare against mlx-lm without the machine, artifact and settings
239
- on the same line as the number.
240
- - Do not claim family-wide bit-exactness; claim it per validated artifact.
241
- - Do not start servers or multi-GB downloads from a session for T5/T7.
242
- - Do not touch `PLAN.md`, `public-readiness.md`, `benchmarks.md`, `README.md`
243
- or `models.md` in this tree without checking `git status` first; another
244
- session was editing them on 2026-09-11.
@@ -1,149 +0,0 @@
1
- # Preparing mlx-bun for the MLX community
2
-
3
- Success means that a curious developer can understand the project, reproduce
4
- its numerical claims, and build something with it. The listing is a discovery
5
- link; the repository and working examples have to earn further attention.
6
-
7
- The public pitch is MLX inference as a TypeScript/Bun library, with a signed
8
- executable serving OpenAI/Anthropic-compatible APIs. Correctness claims name
9
- the tested artifact and configuration. Specialized kernels, quantization,
10
- and reusable cache state support that product; ancillary applications do not
11
- need equal space in the introduction.
12
-
13
- Open milestones live in [PLAN.md](../../PLAN.md#public-readiness).
14
- Numbers belong in [benchmarks.md](../reference/benchmarks.md), with historical
15
- experiments in its linked ledger. Package decisions belong in the
16
- [engine architecture](../design/unified-engine-frontier-plan.md#1215-package-boundaries-before-community-outreach).
17
-
18
- ## P0. Contribute the GPTQ finding upstream
19
-
20
- Check the reported indexing errors against a pinned upstream revision and
21
- search existing issues and pull requests before filing. Produce a minimal
22
- CPU-only reproduction that needs no model download. Demonstrate both the
23
- out-of-block update window and the global index into a block-local error
24
- buffer; a one-line fix is not enough. Keep the report about the numerical bug,
25
- with a proposed patch and a useful regression test.
26
-
27
- Acceptance: the reproduction runs against the cited revision, a reviewed
28
- issue or pull request is submitted when authorized, and the discussion is
29
- followed up. Upstream acceptance is not required to proceed with community
30
- feedback. Submitted as [mlx-lm #1878](https://github.com/ml-explore/mlx-lm/issues/1878) with the complete CPU-only
31
- reproduction, observed results and proposed two-line correction. Follow-up
32
- and an independent-reference regression test remain open.
33
-
34
- ## P1. Make the first visit clear and credible
35
-
36
- Remove session-specific instructions, personal approvals, and handoff prose
37
- from README, STATUS, model/configuration references, benchmarks, and pages
38
- rendered by the website. Preserve observed CPU, swap, memory, artifact, and
39
- sampling conditions as technical facts. Do not turn diagnostic measurements
40
- into controlled experiments by removing their qualifications.
41
-
42
- The benchmark reference should open with its parity summary, then the latest
43
- standard head-to-head with wins and losses, then reproduction instructions.
44
- Move historical campaign details into a linked ledger and preserve old
45
- section links. Map every roster row claiming L1 to a concrete artifact and
46
- test, or explicitly describe the remaining evidence gap. Family support does
47
- not establish parity for every checkpoint or modality.
48
-
49
- Lead the README and site with the library and server. Link to contribution
50
- instructions instead of internal work tracking from the main README. Keep
51
- secondary applications in a short, separate line. Distinguish the first-run
52
- starter from the preferred model used once suitable weights are available.
53
-
54
- Acceptance: the public wording agrees with the implementation; no personal
55
- approval language remains in these public entry points; local links and the
56
- website build pass; desktop and narrow-screen presentation are reviewed.
57
- The claims about numerical agreement remain bounded by recorded evidence.
58
-
59
- ## P2. Make correctness independently reproducible
60
-
61
- Implemented: [pinned setup and MiniCPM comparison](../reference/environment.md#reproduce-the-minicpm5-logit-comparison).
62
- A clean source export, new oracle environment and empty model cache pass on
63
- M1 Max with 100 exact vectors and tokens. Missing inputs fail explicitly.
64
- Complete per-roster artifact/run provenance remains open.
65
-
66
- Provide `setup.sh` under `scripts/oracle/` and a committed dependency lock for the
67
- reference environment. Select it through `MLX_BUN_ORACLE_VENV`; no contributor
68
- should need the maintainer's directory layout. Pin the native MLX/Metal build,
69
- Python dependencies, model revision, tokenizer/template inputs, and oracle
70
- fixture-generation command. Explain the machine-specific fixtures and the
71
- attention-dispatch boundary that makes another Mac's binary goldens unsuitable.
72
-
73
- Publish a small-model recipe ending in the MiniCPM parity test. It must create
74
- fixtures from the Python oracle and fail clearly on missing inputs, rather
75
- than reporting skipped tests as success. Measure the setup and test duration;
76
- do not promise ten minutes until a clean-machine run supports it. Explain
77
- what is compared before sampling and which execution shapes are tested.
78
-
79
- Acceptance: a clean checkout can install the pinned reference, obtain the
80
- specified artifact, regenerate its own oracle fixtures, and run a documented
81
- logit comparison. Publish enough provenance for each summary table row to be
82
- traceable. Existing accepted checks do not need wholesale reruns; this work
83
- checks whether an outsider can reproduce them.
84
-
85
- ## P3. Settle package ownership
86
-
87
- Map imports, public APIs, dependencies, native assets, builds, tests and
88
- release packaging. Distinguish the reusable engine from HTTP/CLI assembly
89
- and applications. Decide whether workspaces improve independent installation
90
- and development enough to introduce them before outreach.
91
-
92
- Keep `mlx-bun`, `mlx-bun/engine`, and `mlx-bun/client` imports compatible.
93
- Preserve in-process execution, specialized kernels, tensor ownership and the
94
- self-contained executable. Interfaces do not each need their own package.
95
- No package extraction should add transport hops or copies in the decode path.
96
-
97
- Acceptance: record and implement justified pre-outreach moves, or document
98
- which internal moves can safely follow later. Test an installed consumer and
99
- bundled assets when extraction changes them. Postponing the decision without
100
- a dependency map does not complete this milestone.
101
-
102
- ## P4. Verify the candidate and its presentation
103
-
104
- Inspect the npm tarball and release bundle. Keep runtime assets complete and
105
- exclude accidental research output. Check first-run chat, streaming, model
106
- selection, a small library consumer, and actionable errors against the
107
- candidate artifact. Reuse release and benchmark evidence where code and
108
- configuration have not changed. Default memory guidance remains advisory.
109
-
110
- Prepare a short demonstration and evidence bundle. Set an accurate GitHub
111
- repository description, homepage and topics: `mlx`, `apple-silicon`, `bun`,
112
- `llm`, `metal`. Verify that the intended release is easy to find; use the
113
- available GitHub release/highlight controls without promising a nonexistent
114
- pinning feature. Include straightforward issue reporting and contributor setup.
115
-
116
- Acceptance: the installed candidate and demo work as documented, repository
117
- metadata matches the pitch, and every public performance claim points to its
118
- machine and workload. Persistent servers and large downloads follow the
119
- repository's existing session rules.
120
-
121
- ## P5. Engage, then request the listing
122
-
123
- Order: upstream GPTQ report, Discord introduction, GitHub Show and tell,
124
- then the community-project comment. Verify current venue instructions before
125
- posting. The [MLX Community Discord invite](https://discord.gg/wXk8tEqAcG)
126
- is a starting point to verify, not evidence about audience size or reception.
127
-
128
- Ask for feedback on the library integration and reproducible correctness
129
- comparison. Credit MLX, mlx-c, mlx-lm and mlx-optiq accurately. Treat rotation
130
- and trellis findings as a separate technical discussion with their quality
131
- tradeoffs; do not imply that all quantization methods preserve L1 numerics.
132
-
133
- The [Show and tell category](https://github.com/ml-explore/mlx/discussions/categories/show-and-tell)
134
- provides a durable, searchable introduction containing the example,
135
- reproduction steps, known limits and upstream contribution. Incorporate
136
- Discord feedback before preparing that post. Then follow the instructions in
137
- [community-project discussion #654](https://github.com/ml-explore/mlx/discussions/654).
138
-
139
- Draft listing sentence, for review:
140
-
141
- > [mlx-bun](https://github.com/joshuarossi/mlx-bun) brings MLX inference to TypeScript/Bun applications and ships a signed executable serving OpenAI/Anthropic-compatible APIs on Apple Silicon, with bit-exact logit tests against mlx-lm for validated configurations.
142
-
143
- The listing sentence deliberately omits an unqualified family-wide parity
144
- claim. Add the reproducible example and coverage link to the Show-and-tell
145
- post, where readers can inspect the precise scope.
146
-
147
- Acceptance: review the concrete drafts, post when authorized, triage feedback,
148
- and submit the listing comment. Website placement and maintainer enthusiasm
149
- are external outcomes, not completion promises. Hacker News comes later.