mirrors/rocm_jax
1
0
Fork 0
mirror of https://github.com/ROCm/jax.git synced 2025-04-16 11:56:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
rocm_jax/docs/index.rst

66 lines
1.4 KiB
ReStructuredText
Raw Normal View History

Add Sphinx-generated reference documentation for JAX.
2019-01-15 20:14:19 -05:00
JAX reference documentation
===============================
Composable transformations of Python+NumPy programs: differentiate, vectorize,
Add documentation on asynchronous dispatch.
2019-06-04 10:09:43 -04:00
JIT to GPU/TPU, and more.
Add Sphinx-generated reference documentation for JAX.
2019-01-15 20:14:19 -05:00
For an introduction to JAX, start at the
`JAX GitHub page <https://github.com/google/jax>`_.
Notebooks on RTD (#1121)
2019-09-30 11:00:02 -07:00
.. toctree::
:maxdepth: 1
:caption: Tutorials
notebooks/quickstart
notebooks/autodiff_cookbook
Moved all notebooks to docs/notebooks. (#1493) * Moved all notebooks to docs/notebooks. Now all notebooks are in the same place, thus all are subject to auto-doc generation at readthedocs.io and to automated testing with travis. Some notebooks are too slow, exclude them at docs/conf.py:exclude_patterns. Cleanup a bit the section headings in notebooks so that they show up well in readtehdocs.io. * Increase the cell timeout for executing notebooks * Exclude also the neural network notebook from auto-generation (timing out) * Disable the score_matching notebook from auto-doc (travis does not have sklearn)
2019-10-17 08:58:25 +02:00
Training a Simple Neural Network, with PyTorch Data Loading <https://github.com/google/jax/blob/master/docs/notebooks/Neural_Network_and_Data_Loading.ipynb>
Addressed comments for the Colab. * Cleaned up use of section levels * Renamed ma to multiply_add and sq_add to square_add * Other minor clarifications * Separated the Colabs into Tutorials and Advanced Tutorials
2019-10-03 11:20:04 +02:00
.. toctree::
:maxdepth: 1
Moved all notebooks to docs/notebooks. (#1493) * Moved all notebooks to docs/notebooks. Now all notebooks are in the same place, thus all are subject to auto-doc generation at readthedocs.io and to automated testing with travis. Some notebooks are too slow, exclude them at docs/conf.py:exclude_patterns. Cleanup a bit the section headings in notebooks so that they show up well in readtehdocs.io. * Increase the cell timeout for executing notebooks * Exclude also the neural network notebook from auto-generation (timing out) * Disable the score_matching notebook from auto-doc (travis does not have sklearn)
2019-10-17 08:58:25 +02:00
:caption: Advanced JAX Tutorials
Addressed comments for the Colab. * Cleaned up use of section levels * Renamed ma to multiply_add and sq_add to square_add * Other minor clarifications * Separated the Colabs into Tutorials and Advanced Tutorials
2019-10-03 11:20:04 +02:00
Notebooks on RTD (#1121)
2019-09-30 11:00:02 -07:00
notebooks/Common_Gotchas_in_JAX
Moved all notebooks to docs/notebooks. (#1493) * Moved all notebooks to docs/notebooks. Now all notebooks are in the same place, thus all are subject to auto-doc generation at readthedocs.io and to automated testing with travis. Some notebooks are too slow, exclude them at docs/conf.py:exclude_patterns. Cleanup a bit the section headings in notebooks so that they show up well in readtehdocs.io. * Increase the cell timeout for executing notebooks * Exclude also the neural network notebook from auto-generation (timing out) * Disable the score_matching notebook from auto-doc (travis does not have sklearn)
2019-10-17 08:58:25 +02:00
notebooks/XLA_in_Python
Added JAX pytrees notebook Also added docstrings to the tree_util module.
2019-10-27 10:29:33 +01:00
notebooks/JAX_pytrees
Added How_JAX_primitives_work colab
2019-10-02 14:41:28 +02:00
notebooks/How_JAX_primitives_work
Add custom interpreter notebook
2019-10-28 12:54:04 -07:00
notebooks/Writing_custom_interpreters_in_Jax.ipynb
Moved all notebooks to docs/notebooks. (#1493) * Moved all notebooks to docs/notebooks. Now all notebooks are in the same place, thus all are subject to auto-doc generation at readthedocs.io and to automated testing with travis. Some notebooks are too slow, exclude them at docs/conf.py:exclude_patterns. Cleanup a bit the section headings in notebooks so that they show up well in readtehdocs.io. * Increase the cell timeout for executing notebooks * Exclude also the neural network notebook from auto-generation (timing out) * Disable the score_matching notebook from auto-doc (travis does not have sklearn)
2019-10-17 08:58:25 +02:00
Training a Simple Neural Network, with Tensorflow Datasets Data Loading <https://github.com/google/jax/blob/master/docs/notebooks/neural_network_with_tfds_data.ipynb>
notebooks/maml
Add sklearn to Travis, for documentation building. (#1547) * Add sklearn to Travis, for documentation building. * Add score_matching to auto-built notebooks
2019-10-21 23:24:16 +02:00
notebooks/score_matching
Moved all notebooks to docs/notebooks. (#1493) * Moved all notebooks to docs/notebooks. Now all notebooks are in the same place, thus all are subject to auto-doc generation at readthedocs.io and to automated testing with travis. Some notebooks are too slow, exclude them at docs/conf.py:exclude_patterns. Cleanup a bit the section headings in notebooks so that they show up well in readtehdocs.io. * Increase the cell timeout for executing notebooks * Exclude also the neural network notebook from auto-generation (timing out) * Disable the score_matching notebook from auto-doc (travis does not have sklearn)
2019-10-17 08:58:25 +02:00
notebooks/vmapped_log_probs
Notebooks on RTD (#1121)
2019-09-30 11:00:02 -07:00
Add documentation on asynchronous dispatch.
2019-06-04 10:09:43 -04:00
.. toctree::
:maxdepth: 1
:caption: Notes
Moved CHANGELOG to docs (#2252) * Moved CHANGELOG to docs This puts the documentation also on RTD, with TOC. Also changed its format to .rst, for consistency. Added GitHub links to the change log. * Actually add the CHANGELOG.rst * Added reminder comments to the CHANGELOG.rst
2020-02-23 19:18:06 +01:00
CHANGELOG
Added the first draft of the Jaxpr documentation. This replaces the previous Google Doc version, and is now updated with the latest changes in Jaxpr.
2020-02-10 11:40:05 +01:00
jaxpr
Add documentation on asynchronous dispatch.
2019-06-04 10:09:43 -04:00
async_dispatch
Make JAX tracer state thread-local. Allows performing traces in separate threads. Using threading within a traced context still won't work, but that is perhaps less important than the ability to call JIT-ted computations from separate threads. (Revives https://github.com/google/jax/pull/734.)
2019-07-23 09:53:27 -04:00
concurrency
Add docs on GPU memory allocation.
2019-07-29 12:24:58 -07:00
gpu_memory_allocation
Add some brief documentation about how to profile/trace JAX programs.
2019-08-08 21:02:41 -04:00
profiling
improve rank promotion warning, add doc page
2019-08-25 14:28:53 -07:00
rank_promotion_warning
Change JAX type promotion to prefer inexact types. (#1815) Change the JAX type promotion table to prefer inexact types during type promotion. NumPy's type promotion rules tend to promote aggressively to float64, which isn't a very accelerator-friendly behavior when not all accelerators (e.g., TPUs) support 64-bit floating point types. Even on accelerators that support 64-bit floating point types (e.g., GPUs), promotion to a 64-bit type comes with a significant performance cost. This change makes JAX type promotion between inexact and exact types closer to PyTorch's promotion semantics, which are a better fit for modern accelerators: e.g., ``` import numpy as onp from jax import numpy as np In [1]: onp.promote_types(onp.float32, onp.int32) Out[1]: dtype('float64') In [2]: onp.promote_types(onp.float16, onp.int64) Out[2]: dtype('float64') In [3]: np.promote_types(onp.float32, onp.int32) Out[3]: dtype('float32') In [4]: np.promote_types(onp.float16, onp.int64) Out[4]: dtype('float16') ``` This change is in preparation for enabling x64 mode by default on all platforms.
2019-12-05 10:57:23 -05:00
type_promotion
Add documentation on asynchronous dispatch.
2019-06-04 10:09:43 -04:00
Create developer documentation. * Moved out of README.md some developer-only stuff to docs/developer.rst. * Added documentation about building the documentation
2019-10-03 11:56:57 +02:00
.. toctree::
:maxdepth: 2
:caption: Developer documentation
developer
Added the first draft of the Jaxpr documentation. This replaces the previous Google Doc version, and is now updated with the latest changes in Jaxpr.
2020-02-10 11:40:05 +01:00
jax_internal_api
Create developer documentation. * Moved out of README.md some developer-only stuff to docs/developer.rst. * Added documentation about building the documentation
2019-10-03 11:56:57 +02:00
Add Sphinx-generated reference documentation for JAX.
2019-01-15 20:14:19 -05:00
.. toctree::
:maxdepth: 3
Notebooks on RTD (#1121)
2019-09-30 11:00:02 -07:00
:caption: API documentation
Add Sphinx-generated reference documentation for JAX.
2019-01-15 20:14:19 -05:00
jax
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Reference in New Issue Copy Permalink