[mahdi-shafiei]

Summary

-**The training plumbing a JAX/Flax NNX project otherwise writes for itself, written once:
-configure the JAX process, find the devices and lay arrays out across them, save and restore
-state, decide when to stop, log the run, and send it to a GPU.**
+**Training, testing and CI infrastructure for JAX/Flax NNX, so a project does not write its
+own.** It configures the JAX process, lays arrays out across devices, builds optimizers, saves and
+restores state, decides when to stop, logs the run and sends it to a GPU. In tests it runs code in
+fresh interpreters, counts compiles and checks gradients. Its CI gates, composite actions and
+pre-commit hooks can be reused from any repository.

The same description in pyproject.toml (the PyPI summary, published with the next release) and mkdocs.yml (site_description). The docs index includes the README summary, so it follows. The README's next paragraph, on the Avitai packages built on substrax and substrax importing none of them, is unchanged.

Evidence

• What the old headline left out, each on main (c553f45): substrax.testing (run_python and report, TraceCounter, compiles, counted_calls, gradients, the pytest plugin), substrax.optim and substrax.rng, substrax.compute (local, modal, skypilot), and the reusable CI parts: .github/actions/already-tested, audit-lock and main-moved, the python-gates.yml reusable workflow, and the no-dependabot-config hook. Thirteen repositories use the actions on their main.
• No copy of the old wording is left: git grep -i 'training plumbing' finds 3 lines on main (README, mkdocs.yml, pyproject.toml) and 0 on this branch.
• Checked locally: pre-commit run, uv lock --check, tests/ci (170 passed), scripts/derive_status.py --check. The strict docs build is left to Gates / Docs.

Merge Danger

Door: two-way

Blast Radius: text

Wording only. The PyPI summary changes when the next release is published.

[read-the-docs-community]

Documentation build overview

📚 substrax | 🛠️ Build #35531852 | 📁 Comparing e51af4e against latest (c553f45)

  🔍 Preview build  

1 file changed

± index.html