docs: document JAX backend for DragonNet#919
Merged
Merged
Conversation
Follow-up to uber#918 addressing the two documentation gaps flagged by @jeongyoonlee: - docs/examples.rst: add 'examples/dragonnet_jax_vs_tf' to the toctree so Sphinx renders the JAX vs TF benchmark notebook (previously omitted). - docs/installation.rst: document the 'jax' extra alongside 'tf'/'torch' (PyPI, uv, install-from-source) and mention 'inference.jax' in the intro; add '--runjax' to the Running Tests section. - docs/examples/dragonnet_jax_vs_tf.ipynb: rename the '## Installation' markdown heading to '## Setup' to avoid an autosectionlabel collision with installation.rst that the new toctree entry surfaces. Verified with a local Sphinx build (nbsphinx_execute=never): no new warnings introduced (870 vs 872 baseline) and the notebook renders correctly.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Follow-up to #918 addressing the two documentation gaps flagged by @jeongyoonlee during review of the JAX/flax.nnx DragonNet backend.
Types of changes
Checklist
Changes
docs/examples.rst: addexamples/dragonnet_jax_vs_tfto the toctree so Sphinx renders the JAX vs TF benchmark notebook (previously omitted, as noted by @jeongyoonlee).docs/installation.rst: document thejaxextra alongsidetf/torch:inference.jaxpip install causalml[jax](PyPI)uv add "causalml[jax]"(uv)pip install -e ".[jax]"(Install from source)--runjaxadded to the Running Tests sectiondocs/examples/dragonnet_jax_vs_tf.ipynb: rename the## Installationmarkdown heading to## Setupto avoid anautosectionlabelcollision withinstallation.rstthat the new toctree entry surfaces (the labelinstallationwas duplicated).Tests
No code changes (
.rst+.ipynbmarkdown only), so no new tests are required. Verified the documentation build locally:Result: build succeeds (exit 0). No new warnings introduced (870 vs 872 baseline warnings — the reduction comes from the heading rename removing a duplicate-label collision). The
dragonnet_jax_vs_tfnotebook now renders and is linked from the Examples page.Dependencies
None. No new dependencies are added; the
jaxextra already exists inpyproject.tomlfrom #918.References
pip install causalml[jax]).