Skip to content

Surface MLX feature parity in user-facing docs - #321

Merged
neuromechanist merged 2 commits into
devfrom
docs/mlx-parity-visibility
Sep 1, 2026
Merged

Surface MLX feature parity in user-facing docs#321
neuromechanist merged 2 commits into
devfrom
docs/mlx-parity-visibility

Conversation

@neuromechanist

Copy link
Copy Markdown
Member

Discoverability follow-up to epic #278 (the epic updated every doc it touched; these are the four spots it did not):

  • AGENTS.md architecture map: the mlx_impl annotation still claimed GG-only, stale since Phase 4: port non-GG pdf families to the MLX backend #275; now states all five families and the full torch-equivalent surface.
  • docs/guides/eeglab.md: adds the MLX export path (an Apple-Silicon fit writes amicaout directly, no torch round trip) -- the guide previously never mentioned MLX, though MLX users' downstream is EEGLAB.
  • docs/guides/backends.md: the MLX table row notes the full feature surface with a link to the backend matrix in the differences page.
  • README: the Apple-Silicon bullet now states the backend is feature-complete, not just fastest.

Docs only; claims cross-checked against the epic's landed surface (write_amica_output byte-comparison tests, the differences-page backend table).

Post-epic-#278 discoverability pass: the AGENTS.md map annotation
still said GG-only; the EEGLAB guide never mentioned the MLX export
path; the backends table row and README undersold the now-complete
MLX surface. Docs only.
The export-validation claim now states float32 precision rather than
byte comparison (only comp_list is exact), and the test that seeded
the overclaim is renamed to match its actual assertion; the backends
table row returns to terse form with the parity statement moved to
prose that names the wrapper-only from_params_file caveat (#313);
MIR is spelled out on first use in the README; the stale GG-only
class one-liner in mlx core is corrected. Export suite 12 passed.
@neuromechanist
neuromechanist merged commit b7f98ec into dev Sep 1, 2026
8 checks passed
@neuromechanist
neuromechanist deleted the docs/mlx-parity-visibility branch September 1, 2026 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant