Skip to content

docs: fix false 'JAX will also be installed' claim; document [jax] extra#642

Merged
Jammy2211 merged 2 commits into
mainfrom
docs/jax-install-and-version-sync
Jul 23, 2026
Merged

docs: fix false 'JAX will also be installed' claim; document [jax] extra#642
Jammy2211 merged 2 commits into
mainfrom
docs/jax-install-and-version-sync

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

The bug

docs/installation/pip.md and conda.md both stated:

"When you install PyAutoLens (see instructions below), JAX will also be installed."

This is false. pip install autolens does not install JAX — it is an optional extra:

autolens[jax] -> autogalaxy[jax] -> autonerves[jax] -> jax + jaxlib + jaxnnls

A user following the docs exactly gets no JAX and no indication why. Reported from a real install of 2026.7.22.1.

Changes

  • Replace the false claim with an explicit pip install autolens[jax] instruction in both pip and conda docs.
  • Note that plain pip install autolens is a valid, working NumPy-only install.
  • Clarify the [jax] extra installs CPU-only JAX; GPU still needs the JAX guide first.
  • Show autolens[jax] as the recommended install command, with the JAX-free variant alongside.
  • Sync __version__ to 2026.7.22.1.

Not changed: 2026.4.5.3 (historical — the release that dropped Python 3.9–3.11) and 2025.10.6.1 (legacy pin example).

Jammy2211 and others added 2 commits July 22, 2026 13:23
@Jammy2211
Jammy2211 merged commit 2a9f1b8 into main Jul 23, 2026
5 checks passed
@Jammy2211
Jammy2211 deleted the docs/jax-install-and-version-sync branch July 23, 2026 21:31
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