rocm_jax/docs/user_guides.rst

.. _user-guides:

User guides
===========

User guides are deeper dives into particular topics within JAX
that become relevant as your JAX project matures into larger
or deployed codebases.

.. toctree::
   :maxdepth: 1
   :caption: Debugging and performance

   notebooks/thinking_in_jax
   profiling
   device_memory_profiling
   debugging/index
   gpu_performance_tips
   persistent_compilation_cache

.. toctree::
   :maxdepth: 1
   :caption: Interfaces

   pytrees
   errors
   aot
   export/index
   type_promotion
   transfer_guard

.. toctree::
   :maxdepth: 1
   :caption: Custom operations

   notebooks/external_callbacks
   pallas/index
   ffi

.. toctree::
   :caption: Example applications
   :maxdepth: 1

   notebooks/neural_network_with_tfds_data
   notebooks/Neural_Network_and_Data_Loading
   notebooks/vmapped_log_probs
Update doc landing page Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com> Co-authored-by: Jake VanderPlas <jakevdp@google.com> 2023-01-13 09:59:40 -08:00			`.. _user-guides:`

docs: sentence case index and sub-index headings We currently use both forms, so for consistency (and easier reading), pick this one. 2024-08-11 17:48:19 -07:00			`User guides`
DOC: fix headings in user_guides 2023-03-30 14:39:25 -07:00			`===========`

Add notes and headeers to user guides 2023-02-10 14:17:15 -08:00			`User guides are deeper dives into particular topics within JAX`
Update user_guides.rst Fix minor typo 2023-03-26 17:21:35 -07:00			`that become relevant as your JAX project matures into larger`
Add notes and headeers to user guides 2023-02-10 14:17:15 -08:00			`or deployed codebases.`
Update doc landing page Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com> Co-authored-by: Jake VanderPlas <jakevdp@google.com> 2023-01-13 09:59:40 -08:00
			`.. toctree::`
			`:maxdepth: 1`
docs: sentence case index and sub-index headings We currently use both forms, so for consistency (and easier reading), pick this one. 2024-08-11 17:48:19 -07:00			`:caption: Debugging and performance`
Update doc landing page Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com> Co-authored-by: Jake VanderPlas <jakevdp@google.com> 2023-01-13 09:59:40 -08:00
DOC: replace old tutorials with new content 2024-04-18 13:11:25 -07:00			`notebooks/thinking_in_jax`
Make JAX Debugging and Profiling guides more visible, move Profiling to User Guides from Notes 2023-01-19 23:05:24 +00:00			`profiling`
			`device_memory_profiling`
Add notes and headeers to user guides 2023-02-10 14:17:15 -08:00			`debugging/index`
draft docs on gpu performance tuning Co-authored-by: Tao Wang <wangtao@google.com> 2023-10-17 13:29:17 -07:00			`gpu_performance_tips`
Jax persistent compilation cache user guide. This user guide covers using the cache on local filesystems and Google Cloud. PiperOrigin-RevId: 623236335 2024-04-09 11:47:22 -07:00			`persistent_compilation_cache`
Add notes and headeers to user guides 2023-02-10 14:17:15 -08:00
			`.. toctree::`
			`:maxdepth: 1`
docs: reorganize sections * Create "extension guides" section * Sort developer notes into subsections * Move examples from advanced section into user guides * Reorder some listings, adjust some titles 2024-08-13 13:16:50 -07:00			`:caption: Interfaces`
Add notes and headeers to user guides 2023-02-10 14:17:15 -08:00
			`pytrees`
docs: reorganize sections * Create "extension guides" section * Sort developer notes into subsections * Move examples from advanced section into user guides * Reorder some listings, adjust some titles 2024-08-13 13:16:50 -07:00			`errors`
Add notes and headeers to user guides 2023-02-10 14:17:15 -08:00			`aot`
[export] Add documentation for jax.export 2024-05-31 15:14:09 +03:00			`export/index`
docs: reorganize sections * Create "extension guides" section * Sort developer notes into subsections * Move examples from advanced section into user guides * Reorder some listings, adjust some titles 2024-08-13 13:16:50 -07:00			`type_promotion`
Update user_guides.rst Fix minor typo 2023-03-26 17:21:35 -07:00			`transfer_guard`
Add initial documentation for Pallas 2023-08-02 18:11:48 -07:00
[Pallas TPU] Add Pipelining and BlockSpecs documentation for Pallas TPU 2024-02-27 14:19:35 -08:00			`.. toctree::`
			`:maxdepth: 1`
docs: sentence case index and sub-index headings We currently use both forms, so for consistency (and easier reading), pick this one. 2024-08-11 17:48:19 -07:00			`:caption: Custom operations`
[Pallas TPU] Add Pipelining and BlockSpecs documentation for Pallas TPU 2024-02-27 14:19:35 -08:00
docs: reorganize sections * Create "extension guides" section * Sort developer notes into subsections * Move examples from advanced section into user guides * Reorder some listings, adjust some titles 2024-08-13 13:16:50 -07:00			`notebooks/external_callbacks`
draft docs on gpu performance tuning Co-authored-by: Tao Wang <wangtao@google.com> 2023-10-17 13:29:17 -07:00			`pallas/index`
Add ffi_call tutorial Building on #21925, this tutorial demonstrates the use of the FFI using `ffi_call` with a simple example. I don't think this should cover all of the most advanced use cases, but it should be sufficient for the most common examples. I think it would be useful to eventually replace the existing CUDA tutorial, but I'm not sure that it'll get there in the first draft. As an added benefit, this also runs a simple test (akin to `docs/cuda_custom_call`) which actually executes using a tool chain that open source users would use in practice. 2024-06-25 14:08:49 -04:00			`ffi`
docs: reorganize sections * Create "extension guides" section * Sort developer notes into subsections * Move examples from advanced section into user guides * Reorder some listings, adjust some titles 2024-08-13 13:16:50 -07:00
			`.. toctree::`
			`:caption: Example applications`
			`:maxdepth: 1`

			`notebooks/neural_network_with_tfds_data`
			`notebooks/Neural_Network_and_Data_Loading`
			`notebooks/vmapped_log_probs`