diff --git a/docs/advanced_guide.rst b/docs/advanced_guide.rst index 867423138..cb987bd6e 100644 --- a/docs/advanced_guide.rst +++ b/docs/advanced_guide.rst @@ -1,8 +1,11 @@ .. _advanced_guide: -Advanced tutorials -================== -This section contains examples and tutorials on more advanced topics, such as Multi Core computation, Custom operations, and more in depth applications +Advanced guides +=============== + +This section contains examples and tutorials on more advanced topics, +such as multi-core computation, custom operations, and more in-depth +applications. .. toctree:: :caption: Examples diff --git a/docs/debugging/index.md b/docs/debugging/index.md index b00fcc13d..724827f83 100644 --- a/docs/debugging/index.md +++ b/docs/debugging/index.md @@ -1,4 +1,4 @@ -# Runtime value debugging in JAX +# Debugging runtime values diff --git a/docs/device_memory_profiling.md b/docs/device_memory_profiling.md index a906c54d5..a2fd3f687 100644 --- a/docs/device_memory_profiling.md +++ b/docs/device_memory_profiling.md @@ -1,4 +1,4 @@ -# Device memory profiling +# Profiling device memory diff --git a/docs/errors.rst b/docs/errors.rst index 23dbaf29c..96e14ed8d 100644 --- a/docs/errors.rst +++ b/docs/errors.rst @@ -1,7 +1,8 @@ .. _jax-errors: -JAX Errors -========== +Errors +====== + This page lists a few of the errors you might encounter when using JAX, along with representative examples of how one might fix them. diff --git a/docs/faq.rst b/docs/faq.rst index 92868dc5d..3ac7d89fb 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,5 +1,5 @@ -JAX frequently asked questions (FAQ) -==================================== +Frequently asked questions (FAQ) +================================ .. comment RST primer for Sphinx: https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html .. comment Some links referenced here. Use `JAX - The Sharp Bits`_ (underscore at the end) to reference diff --git a/docs/ffi.ipynb b/docs/ffi.ipynb index 9dc49a74e..12a2781f7 100644 --- a/docs/ffi.ipynb +++ b/docs/ffi.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# JAX's foreign function interface\n", + "# Foreign function interface (FFI)\n", "\n", "_This tutorial requires JAX v0.4.31 or newer._\n", "\n", diff --git a/docs/ffi.md b/docs/ffi.md index aa861d9a0..4568b670e 100644 --- a/docs/ffi.md +++ b/docs/ffi.md @@ -12,7 +12,7 @@ kernelspec: name: python3 --- -# JAX's foreign function interface +# Foreign function interface (FFI) _This tutorial requires JAX v0.4.31 or newer._ diff --git a/docs/glossary.rst b/docs/glossary.rst index a7668e9a0..4bb9fa156 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -1,5 +1,5 @@ -JAX glossary of terms -===================== +Glossary of terms +================= .. glossary:: diff --git a/docs/index.rst b/docs/index.rst index ef59f87dd..476de62bd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,4 @@ -JAX: High-Performance Array Computing +JAX: High performance array computing ===================================== JAX is a Python library for accelerator-oriented array computation and program transformation, @@ -75,7 +75,7 @@ For an end-to-end transformer library built on JAX, see MaxText_. .. toctree:: :hidden: :maxdepth: 2 - :caption: Further resources + :caption: Resources user_guides advanced_guide diff --git a/docs/installation.md b/docs/installation.md index 20ffe436f..bd0473d89 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,5 @@ (installation)= -# Installing JAX +# Installation diff --git a/docs/key-concepts.md b/docs/key-concepts.md index 4b114c857..c6cfb176e 100644 --- a/docs/key-concepts.md +++ b/docs/key-concepts.md @@ -13,7 +13,7 @@ kernelspec: --- (key-concepts)= -# Key Concepts +# Key concepts diff --git a/docs/notebooks/external_callbacks.ipynb b/docs/notebooks/external_callbacks.ipynb index 050a641a7..25c551c98 100644 --- a/docs/notebooks/external_callbacks.ipynb +++ b/docs/notebooks/external_callbacks.ipynb @@ -6,7 +6,7 @@ "id": "7XNMxdTwURqI" }, "source": [ - "# External callbacks in JAX\n", + "# External callbacks\n", "\n", "" ] diff --git a/docs/notebooks/external_callbacks.md b/docs/notebooks/external_callbacks.md index ab0a2fcd3..c93139e16 100644 --- a/docs/notebooks/external_callbacks.md +++ b/docs/notebooks/external_callbacks.md @@ -13,7 +13,7 @@ kernelspec: +++ {"id": "7XNMxdTwURqI"} -# External callbacks in JAX +# External callbacks diff --git a/docs/notebooks/vmapped_log_probs.ipynb b/docs/notebooks/vmapped_log_probs.ipynb index 96b334296..a355959ba 100644 --- a/docs/notebooks/vmapped_log_probs.ipynb +++ b/docs/notebooks/vmapped_log_probs.ipynb @@ -6,7 +6,7 @@ "id": "6umP1IKf4Dg6" }, "source": [ - "# Autobatching for Bayesian Inference\n", + "# Autobatching for Bayesian inference\n", "\n", "\n", "\n", diff --git a/docs/notebooks/vmapped_log_probs.md b/docs/notebooks/vmapped_log_probs.md index ea8b4fce2..9ecbd9d23 100644 --- a/docs/notebooks/vmapped_log_probs.md +++ b/docs/notebooks/vmapped_log_probs.md @@ -14,7 +14,7 @@ kernelspec: +++ {"id": "6umP1IKf4Dg6"} -# Autobatching for Bayesian Inference +# Autobatching for Bayesian inference diff --git a/docs/profiling.md b/docs/profiling.md index 6eceec8f5..91f4d61b2 100644 --- a/docs/profiling.md +++ b/docs/profiling.md @@ -1,4 +1,4 @@ -# Profiling JAX programs +# Profiling computation diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 2f90e4226..be70c6d41 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -1,7 +1,7 @@ .. _jax-tutorials: -JAX tutorials -============= +Tutorials +========= .. toctree:: :maxdepth: 1