Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation: add stub files for new tutorial structure
- Loading branch information
Showing
18 changed files
with
195 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Advanced automatic differentiation | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../jax-101/04-advanced-autodiff` | ||
- {doc}`../notebooks/autodiff_cookbook` | ||
- {doc}`../notebooks/autodiff_remat` | ||
- {doc}`../notebooks/Custom_derivative_rules_for_Python_code`. | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Advanced compilation | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../aot` | ||
- {doc}`../Custom_Operation_for_GPUs` | ||
- {doc}`../pallas/index` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Automatic differentiation | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../jax-101/04-advanced-autodiff` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Debugging | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../debugging/index` | ||
- {doc}`../errors` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# External callbacks | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../notebooks/external_callbacks` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
:orphan: | ||
|
||
.. _jax-tutorials: | ||
|
||
JAX tutorials | ||
============= | ||
|
||
.. note:: | ||
|
||
The tutorials below are a work in progress; for the time being, please refer | ||
to the older tutorial content at :ref:`Jax-101`, :ref:`beginner-guide` and | ||
:ref:`user-guides`. | ||
|
||
JAX 101 | ||
------- | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
installation | ||
quickstart | ||
jax-as-accelerated-numpy | ||
automatic-differentiation | ||
jit-compilation | ||
random-numbers | ||
working-with-pytrees | ||
single-host-sharding | ||
stateful-computations | ||
external-callbacks | ||
simple-neural-network | ||
|
||
|
||
JAX 201 | ||
------- | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
parallelism | ||
advanced-autodiff | ||
debugging | ||
profiling-and-performance | ||
|
||
|
||
JAX 301 | ||
------- | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
jax-internals | ||
advanced-compilation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Installation | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../installation` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# JAX as accelerated NumPy | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../jax-101/01-jax-basics` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# JAX internals | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../notebooks/How_JAX_primitives_work` | ||
- {doc}`../jaxpr` | ||
- {doc}`../notebooks/Writing_custom_interpreters_in_Jax` | ||
- {doc}`../type_promotion` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Just-in-time compilation | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../jax-101/02-jitting` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Parallel computation | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../multi_process` | ||
- {doc}`../notebooks/Distributed_arrays_and_automatic_parallelization` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Profiling and performance | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../profiling` | ||
- {doc}`../device_memory_profiling` | ||
- {doc}`../transfer_guard` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Quickstart | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../notebooks/quickstart` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Pseudorandom numbers | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../jax-101/05-random-numbers` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Example: Writing a simple neural network | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Sharded data on a single host | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Stateful computations | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../jax-101/07-state` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Working with PyTrees | ||
|
||
```{note} | ||
This is a placeholder for a section in the new {ref}`jax-tutorials`. | ||
For the time being, you may find some related content in the old documentation: | ||
- {doc}`../jax-101/05.1-pytrees` | ||
- {doc}`../pytrees` | ||
``` |