diff --git a/docs/tutorial/advanced-autodiff.md b/docs/tutorial/advanced-autodiff.md new file mode 100644 index 000000000000..7faa8abbcec2 --- /dev/null +++ b/docs/tutorial/advanced-autodiff.md @@ -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`. +``` \ No newline at end of file diff --git a/docs/tutorial/advanced-compilation.md b/docs/tutorial/advanced-compilation.md new file mode 100644 index 000000000000..5be9a7163bda --- /dev/null +++ b/docs/tutorial/advanced-compilation.md @@ -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` +``` \ No newline at end of file diff --git a/docs/tutorial/automatic-differentiation.md b/docs/tutorial/automatic-differentiation.md new file mode 100644 index 000000000000..69dcbd2db518 --- /dev/null +++ b/docs/tutorial/automatic-differentiation.md @@ -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` +``` \ No newline at end of file diff --git a/docs/tutorial/debugging.md b/docs/tutorial/debugging.md new file mode 100644 index 000000000000..c2f5465305b4 --- /dev/null +++ b/docs/tutorial/debugging.md @@ -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` +``` diff --git a/docs/tutorial/external-callbacks.md b/docs/tutorial/external-callbacks.md new file mode 100644 index 000000000000..fa3227ecc37c --- /dev/null +++ b/docs/tutorial/external-callbacks.md @@ -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` +``` diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst new file mode 100644 index 000000000000..2b65ecfd9f17 --- /dev/null +++ b/docs/tutorial/index.rst @@ -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 diff --git a/docs/tutorial/installation.md b/docs/tutorial/installation.md new file mode 100644 index 000000000000..4b629850a3d7 --- /dev/null +++ b/docs/tutorial/installation.md @@ -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` +``` \ No newline at end of file diff --git a/docs/tutorial/jax-as-accelerated-numpy.md b/docs/tutorial/jax-as-accelerated-numpy.md new file mode 100644 index 000000000000..95eddbbc1e3e --- /dev/null +++ b/docs/tutorial/jax-as-accelerated-numpy.md @@ -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` +``` diff --git a/docs/tutorial/jax-internals.md b/docs/tutorial/jax-internals.md new file mode 100644 index 000000000000..5cf85c4dcd95 --- /dev/null +++ b/docs/tutorial/jax-internals.md @@ -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` +``` diff --git a/docs/tutorial/jit-compilation.md b/docs/tutorial/jit-compilation.md new file mode 100644 index 000000000000..7a7dcb11f569 --- /dev/null +++ b/docs/tutorial/jit-compilation.md @@ -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` +``` \ No newline at end of file diff --git a/docs/tutorial/parallelism.md b/docs/tutorial/parallelism.md new file mode 100644 index 000000000000..47a8c646bb37 --- /dev/null +++ b/docs/tutorial/parallelism.md @@ -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` +``` diff --git a/docs/tutorial/profiling-and-performance.md b/docs/tutorial/profiling-and-performance.md new file mode 100644 index 000000000000..7928b1cfed60 --- /dev/null +++ b/docs/tutorial/profiling-and-performance.md @@ -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` +``` diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md new file mode 100644 index 000000000000..1c3a51bdf984 --- /dev/null +++ b/docs/tutorial/quickstart.md @@ -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` +``` diff --git a/docs/tutorial/random-numbers.md b/docs/tutorial/random-numbers.md new file mode 100644 index 000000000000..9cef1681305e --- /dev/null +++ b/docs/tutorial/random-numbers.md @@ -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` +``` \ No newline at end of file diff --git a/docs/tutorial/simple-neural-network.md b/docs/tutorial/simple-neural-network.md new file mode 100644 index 000000000000..5c8f6335f037 --- /dev/null +++ b/docs/tutorial/simple-neural-network.md @@ -0,0 +1,5 @@ +# Example: Writing a simple neural network + +```{note} +This is a placeholder for a section in the new {ref}`jax-tutorials`. +``` diff --git a/docs/tutorial/single-host-sharding.md b/docs/tutorial/single-host-sharding.md new file mode 100644 index 000000000000..9d918907ad59 --- /dev/null +++ b/docs/tutorial/single-host-sharding.md @@ -0,0 +1,5 @@ +# Sharded data on a single host + +```{note} +This is a placeholder for a section in the new {ref}`jax-tutorials`. +``` diff --git a/docs/tutorial/stateful-computations.md b/docs/tutorial/stateful-computations.md new file mode 100644 index 000000000000..318d4c4c6c05 --- /dev/null +++ b/docs/tutorial/stateful-computations.md @@ -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` +``` diff --git a/docs/tutorial/working-with-pytrees.md b/docs/tutorial/working-with-pytrees.md new file mode 100644 index 000000000000..49fd54659957 --- /dev/null +++ b/docs/tutorial/working-with-pytrees.md @@ -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` +```