rocm_jax/docs/index.rst

105 lines
2.2 KiB
ReStructuredText

JAX reference documentation
===========================
JAX is Autograd_ and XLA_, brought together for high-performance numerical computing and machine learning research.
It provides composable transformations of Python+NumPy programs: differentiate, vectorize,
parallelize, Just-In-Time compile to GPU/TPU, and more.
.. note::
JAX 0.4.0 introduces new parallelism APIs, including breaking changes to :func:`jax.experimental.pjit` and a new unified ``jax.Array`` type.
Please see `Distributed arrays and automatic parallelization <https://jax.readthedocs.io/en/latest/notebooks/Distributed_arrays_and_automatic_parallelization.html>`_ tutorial and the :ref:`jax-array-migration`
guide for more information.
.. toctree::
:maxdepth: 1
:caption: Getting Started
installation
notebooks/quickstart
notebooks/thinking_in_jax
notebooks/Common_Gotchas_in_JAX
.. toctree::
:maxdepth: 1
jax-101/index
.. toctree::
:maxdepth: 2
debugging/index
.. toctree::
:maxdepth: 1
:caption: Reference Documentation
faq
async_dispatch
aot
jaxpr
notebooks/convolutions
pytrees
jax_array_migration
type_promotion
errors
transfer_guard
glossary
changelog
.. toctree::
:maxdepth: 1
:caption: Advanced JAX Tutorials
notebooks/autodiff_cookbook
multi_process
notebooks/Distributed_arrays_and_automatic_parallelization
notebooks/vmapped_log_probs
notebooks/neural_network_with_tfds_data
notebooks/Custom_derivative_rules_for_Python_code
notebooks/How_JAX_primitives_work
notebooks/Writing_custom_interpreters_in_Jax
notebooks/Neural_Network_and_Data_Loading
notebooks/xmap_tutorial
notebooks/external_callbacks
.. toctree::
:maxdepth: 1
:caption: Developer documentation
contributing
developer
jax_internal_api
autodidax
jep/index
.. toctree::
:maxdepth: 1
:caption: API documentation
jax
.. toctree::
:maxdepth: 1
:caption: Notes
api_compatibility
deprecation
concurrency
gpu_memory_allocation
profiling
device_memory_profiling
rank_promotion_warning
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _Autograd: https://github.com/hips/autograd
.. _XLA: https://www.tensorflow.org/xla