diff --git a/docs/source/_images/mnist_imgs/mnist_cpu_bar.png b/docs/source/_images/mnist_imgs/mnist_cpu_bar.png new file mode 100644 index 00000000..fa896ea7 Binary files /dev/null and b/docs/source/_images/mnist_imgs/mnist_cpu_bar.png differ diff --git a/docs/source/_images/mnist_imgs/mnist_gpu.png b/docs/source/_images/mnist_imgs/mnist_gpu.png new file mode 100644 index 00000000..75021cee Binary files /dev/null and b/docs/source/_images/mnist_imgs/mnist_gpu.png differ diff --git a/docs/source/_images/mnist_imgs/mnist_tb.png b/docs/source/_images/mnist_imgs/mnist_tb.png new file mode 100644 index 00000000..a8cf719d Binary files /dev/null and b/docs/source/_images/mnist_imgs/mnist_tb.png differ diff --git a/docs/source/_images/mnist_imgs/pt_to_pl.jpg b/docs/source/_images/mnist_imgs/pt_to_pl.jpg new file mode 100644 index 00000000..65c13b4b Binary files /dev/null and b/docs/source/_images/mnist_imgs/pt_to_pl.jpg differ diff --git a/docs/source/_images/mnist_imgs/restart_runtime.png b/docs/source/_images/mnist_imgs/restart_runtime.png new file mode 100644 index 00000000..84ccae46 Binary files /dev/null and b/docs/source/_images/mnist_imgs/restart_runtime.png differ diff --git a/docs/source/_images/mnist_imgs/runtime_tpu.png b/docs/source/_images/mnist_imgs/runtime_tpu.png new file mode 100644 index 00000000..9dc069a3 Binary files /dev/null and b/docs/source/_images/mnist_imgs/runtime_tpu.png differ diff --git a/docs/source/_images/mnist_imgs/tpu_fast.png b/docs/source/_images/mnist_imgs/tpu_fast.png new file mode 100644 index 00000000..08d9f9ac Binary files /dev/null and b/docs/source/_images/mnist_imgs/tpu_fast.png differ diff --git a/docs/source/_images/mnist_imgs/tpu_start.png b/docs/source/_images/mnist_imgs/tpu_start.png new file mode 100644 index 00000000..3474f68c Binary files /dev/null and b/docs/source/_images/mnist_imgs/tpu_start.png differ diff --git a/docs/source/tutorial_mnist.rst b/docs/source/tutorial_mnist.rst index 8619aad0..c74c1b27 100644 --- a/docs/source/tutorial_mnist.rst +++ b/docs/source/tutorial_mnist.rst @@ -5,8 +5,8 @@ you've organized it into a LightningModule, it automates most of the training fo To illustrate, here's the typical PyTorch project structure organized in a LightningModule. -.. figure:: /img/mnist/pt_to_pl.jpg - :alt: mnist CPU bar +.. figure:: /_images/mnist_imgs/pt_to_pl.jpg + :alt: Convert from PyTorch to Lightning As your project grows in complexity with things like 16-bit precision, distributed training, etc... the part in blue quickly becomes onerous and starts distracting from the core research code. @@ -304,7 +304,7 @@ by the LightningModule. This organization now lets us train this model You should see the following weights summary and progress bar -.. figure:: /img/mnist/mnist_cpu_bar.png +.. figure:: /_images/mnist_imgs/mnist_cpu_bar.png :alt: mnist CPU bar When we added the `log` key in the return dictionary it went into the built in tensorboard logger. @@ -319,7 +319,7 @@ But you could have also logged by calling: Which will generate automatic tensorboard logs. -.. figure:: /img/mnist/mnist_tb.png +.. figure:: /_images/mnist_imgs/mnist_tb.png :alt: mnist CPU bar @@ -332,7 +332,7 @@ But the beauty is all the magic you can do with the trainer flags. For instance, trainer.fit(model) -.. figure:: /img/mnist/mnist_gpu.png +.. figure:: /_images/mnist_imgs/mnist_gpu.png :alt: mnist GPU bar Or you can also train on multiple GPUs (not on colab though) @@ -356,10 +356,10 @@ And even TPUs. Let's do it on the colab! First, change the runtime to TPU (and reinstall lightning). -.. figure:: /img/mnist/runtime_tpu.png +.. figure:: /_images/mnist_imgs/runtime_tpu.png :alt: mnist GPU bar -.. figure:: /img/mnist/restart_runtime.png +.. figure:: /_images/mnist_imgs/restart_runtime.png :alt: mnist GPU bar Next, install the required xla library (adds support for PyTorch on TPUs) @@ -439,12 +439,12 @@ Now we can train the LightningModule on a TPU wihout doing anything else! You'll now see the TPU cores booting up. -.. figure:: /img/mnist/tpu_start.png +.. figure:: /_images/mnist_imgs/tpu_start.png :alt: TPU start Notice the epoch is MUCH faster! -.. figure:: /img/mnist/tpu_fast.png +.. figure:: /_images/mnist_imgs/tpu_fast.png :alt: TPU speed Validation loop