Skip to content

Commit

Permalink
Documentation: add stub files for new tutorial structure
Browse files Browse the repository at this point in the history
  • Loading branch information
jakevdp committed Oct 30, 2023
1 parent 7eddc76 commit 344e42b
Show file tree
Hide file tree
Showing 18 changed files with 195 additions and 0 deletions.
11 changes: 11 additions & 0 deletions 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`.
```
10 changes: 10 additions & 0 deletions 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`
```
8 changes: 8 additions & 0 deletions 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`
```
9 changes: 9 additions & 0 deletions 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`
```
8 changes: 8 additions & 0 deletions 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`
```
52 changes: 52 additions & 0 deletions 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
8 changes: 8 additions & 0 deletions 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`
```
8 changes: 8 additions & 0 deletions 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`
```
11 changes: 11 additions & 0 deletions 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`
```
8 changes: 8 additions & 0 deletions 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`
```
9 changes: 9 additions & 0 deletions 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`
```
10 changes: 10 additions & 0 deletions 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`
```
8 changes: 8 additions & 0 deletions 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`
```
8 changes: 8 additions & 0 deletions 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`
```
5 changes: 5 additions & 0 deletions 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`.
```
5 changes: 5 additions & 0 deletions 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`.
```
8 changes: 8 additions & 0 deletions 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`
```
9 changes: 9 additions & 0 deletions 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`
```

0 comments on commit 344e42b

Please sign in to comment.