75 Commits

Author SHA1 Message Date
Jake VanderPlas
72b2321750 DOC: update JAX quick description 2024-02-26 14:14:11 -08:00
Jake VanderPlas
76f1c95c4e DOC: mention a few recommended tools 2024-02-26 10:02:02 -08:00
Peter Hawkins
8cbd58a9f0 Improve installation instructions.
Simplify the common case installation instructions on the JAX readme.

Move less-commonly used or more complicated options to the installation page of the JAX docs.
2023-09-22 17:13:47 -04:00
Ravin Kumar
473fa7d670 Add building on JAX 2023-05-22 10:05:39 -07:00
Skye Wanderman-Milne
b917a31f56 Update TPU install on main docs page 2023-04-19 17:52:16 +00:00
Jake VanderPlas
912d646076 DOC: remove jax 0.4.1 banner from index page 2023-03-17 13:17:47 -07:00
Jake VanderPlas
55d9c06267 DOC: update sphinx & sphinx-autodoc-typehints 2023-03-01 11:03:20 -08:00
Matthew Johnson
141996ec11 add remat tutorial docs 2023-02-23 14:37:52 -08:00
Jake VanderPlas
e5f0103895 Reorganization among notes, user guides, advanced guides 2023-01-19 09:52:43 -08:00
Jake VanderPlas
703dd462d3 DOC: make grid placement responsive for smaller screens 2023-01-18 11:21:27 -08:00
Jake VanderPlas
5ebd1e79ff DOC: add GPU & TPU installation tabs on index page 2023-01-17 16:19:57 -08:00
Ravin Kumar
2257e2075d 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 12:45:28 -08:00
Sean Lee
afc96a13cf Convert the notebook to a plain MD file 2022-12-14 23:38:47 -08:00
Sean Lee
550eac45c6 Instructions to create custom operation for GPUs 2022-12-13 12:14:30 -08:00
yashkatariya
008a6918e0 Remove experimental endpoints and update to point to 0.4.1 2022-12-13 11:53:56 -08:00
Matthew Johnson
1185c895ca in jax.Array notebook, polish beginning and tweak title and some wording 2022-12-10 22:16:54 -08:00
Jake VanderPlas
df02d7035e DOC: add example of pure_callback with custom_jvp 2022-12-09 12:43:04 -08:00
yashkatariya
a2870a182e Add jax.Array to the index page 2022-12-01 15:44:51 -08:00
Skye Wanderman-Milne
51db1cfd0e [docs] Rename "JAX in Parallelism" files so the URL matches the title. 2022-12-01 19:53:31 +00:00
yashkatariya
aca7e4ade2 jax.Array tutorial 2022-11-15 16:49:17 -08:00
Yash Katariya
e6c4d4a30e Add docstrings for Sharding classes. Right now I am only documenting Sharding, XLACompatibleSharding, MeshPspecSharding and SingleDeviceSharding.
Also moving jax_array_migration guide to reference documentation.

PiperOrigin-RevId: 488489503
2022-11-14 15:47:46 -08:00
jax authors
71f92a7cd5 Merge pull request #13182 from canyon289:docs_update
PiperOrigin-RevId: 487808462
2022-11-11 06:44:29 -08:00
Yash Katariya
b49a1bda15 Add jax.Array migration doc to OSS
PiperOrigin-RevId: 487673643
2022-11-10 16:46:30 -08:00
Ravin Kumar
cb3762e5dd Consolidate links in JAX documentation
Move notes down
2022-11-09 15:44:52 -08:00
8bitmp3
636cac882c
Increase visibility in index Multi-Host Multi-Process Envs Guide 2022-11-04 19:22:39 +00:00
Roy Frostig
bb68fbeefa write in-process AOT walkthrough doc 2022-09-02 13:02:25 -07:00
Roy Frostig
c6ab3a6a60 convert custom VJP update guide to a retroactive JEP 2022-08-10 13:45:57 -07:00
Peter Hawkins
71b29b1cc6 Create JAX Enhancement Proposals (JEPs).
Migrate existing design documents to JEPs.
2022-08-08 16:13:58 -04:00
Sharad Vikram
4386a0f909 Add debugging tools under jax.debug and documentation
Co-authored-by: Matthew Johnson <mattjj@google.com>
Co-authored-by: Lena Martens <lenamartens@google.com>
2022-07-28 20:07:26 -07:00
Hyeontaek Lim
4f8881539d Make the transfer guard documentation easier to find
Move the main documentation of the transfer guard from "Notes" to "Reference documentation" section for better visibility.

Add a link to the main documentation to the docstring of jax.transfer_guard(), which currently shows up as the top result when searching for "jax transfer_guard".
2022-06-09 18:13:03 +00:00
Jake VanderPlas
47ca71d502 DOC: link to install instructions in HTML docs 2022-04-22 12:35:31 -07:00
Hyeontaek Lim
87671f4d85 Add a documentation for the JAX transfer guard 2022-03-25 19:50:12 +00:00
Peter Hawkins
2b51ab5bc1 Add an API compatibility policy. 2022-03-01 14:28:22 -05:00
Peter Hawkins
df55ea5204 Move design notes into docs/, and render them as part of the documentation. 2022-02-02 14:29:03 -05:00
Peter Hawkins
58199b4b9a Delete the XLA in Python notebook.
Its tests are failing, and it describes a non-public API that we are phasing out.
2021-11-18 09:45:06 -05:00
Roy Frostig
e659c54977 docs: remove application tutorials 2021-09-10 18:52:47 -07:00
George Necula
117d0d23ab Attempt to fix RTD build
It seems that the failure is for transformations.md
2021-07-18 19:35:14 +03:00
Skye Wanderman-Milne
40cc1ec230 Add multi-process guide to docs.
This is the first section of the internal doc I drafted. I still need
to add the "Common multi-process idioms" and "Multi-host workflows"
sections.
2021-05-20 18:38:41 -07:00
Jake VanderPlas
ba83ab5d3b Add expanded contributing documentation 2021-04-27 15:00:21 -07:00
Peter Hawkins
aafe8870ae Document that JAX follows the NEP-29 deprecation policy.
Remove the "experimental" disclaimer from the concurrency documentation.
2021-04-21 11:12:41 -04:00
Adam Paszke
40253f471d Make xmap tutorial public
Note that xmap is still experimental, so treat this more as a preview
than as documentation.
2021-04-08 15:56:58 +00:00
Jake VanderPlas
749ad95514 DOC: add transformations doc to HTML & reorganize contents 2021-03-08 16:25:04 -08:00
Roy Frostig
9c420653c3 move changelog to top level 2021-03-08 10:44:52 -08:00
Jake VanderPlas
12c84e7a50 Add jax.errors submodule & error troubleshooting docs 2021-03-03 12:39:12 -08:00
Jake VanderPlas
8f5038d4b9 DOC: add initial JAX glossary 2021-03-01 17:56:43 -08:00
Jake VanderPlas
5396f04c65 DOC: add first JAX-101 notebook 2021-02-26 09:22:34 -08:00
Tom Hennigan
090dd2117d Add autodidax to dev docs toctree and ignore md file to silence warning.
Fixes CI failure from google/jax#5827.
2021-02-25 10:50:10 +00:00
Jake VanderPlas
4c83723d11 DOC: link to RTD version of neural network notebook 2021-02-22 09:19:41 -08:00
Jake VanderPlas
236ba14585 move convolutions from common gotchas to its own file 2021-02-16 17:21:56 -08:00
Jake VanderPlas
d85d204897 DOC: change build from nbsphinx to myst 2021-02-16 10:28:39 -08:00