diff --git a/docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md b/docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md new file mode 100644 index 00000000..3ba93627 --- /dev/null +++ b/docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md @@ -0,0 +1,40 @@ +--- +title: Pytorch Lightning +--- + +The [pytorch-lightning](https://github.com/allegroai/clearml/blob/master/examples/frameworks/pytorch-lightning/pytorch_lightning_example.py) +script demonstrates the integration of ClearML into code that uses [PyTorch Lightning](https://www.pytorchlightning.ai/). + +The example script does the following: +* Trains a simple deep neural network on the PyTorch built-in MNIST dataset +* Defines Argparse command line options, which are automatically captured by ClearML +* Creates an experiment named `pytorch lightning mnist example`, which is associated with the `examples` project. + +## Scalars + +The test loss and validation loss plots appear in the experiment's page in the ClearML web UI under **RESULTS > SCALARS**. +Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab. All of these +plots are automatically captured by ClearML. + +![PyTorch Lightning console](../../../img/examples_pytorch_lightning_scalars.png) + + +## Hyperparameters + +ClearML automatically logs command line options defined with argparse and TensorFlow Definitions, which appear in +**CONFIGURATIONS > HYPER PARAMETERS > Args** and **TF_DEFINE** respectively. + +![PyTorch Lightning parameters](../../../img/examples_pytorch_lightning_params.png) + +## Artifacts + +Model artifacts associated with the experiment appear in the info panel of the **EXPERIMENTS** tab and in the info panel of the **MODELS** tab. + +![PyTorch Lightning model](../../../img/examples_pytorch_lightning_model.png) + +## Console + +All other console output appears in **RESULTS > CONSOLE**. + +![PyTorch Lightning console](../../../img/examples_pytorch_lightning_console.png) + diff --git a/docs/guides/frameworks/tensorflow/tensorflow_mnist.md b/docs/guides/frameworks/tensorflow/tensorflow_mnist.md index 10184f43..afebf687 100644 --- a/docs/guides/frameworks/tensorflow/tensorflow_mnist.md +++ b/docs/guides/frameworks/tensorflow/tensorflow_mnist.md @@ -18,7 +18,7 @@ When the script runs, it creates an experiment named `Tensorflow v2 mnist with s ## Scalars The loss and accuracy metric scalar plots appear in the experiment's page in the **ClearML web UI** under **RESULTS** -**>** **SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the *SCALARS** tab. +**>** **SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab. ![image](../../../img/examples_tensorflow_mnist_06.png) diff --git a/docs/img/examples_pytorch_lightning_console.png b/docs/img/examples_pytorch_lightning_console.png new file mode 100644 index 00000000..80f59f96 Binary files /dev/null and b/docs/img/examples_pytorch_lightning_console.png differ diff --git a/docs/img/examples_pytorch_lightning_model.png b/docs/img/examples_pytorch_lightning_model.png new file mode 100644 index 00000000..3f0d2058 Binary files /dev/null and b/docs/img/examples_pytorch_lightning_model.png differ diff --git a/docs/img/examples_pytorch_lightning_params.png b/docs/img/examples_pytorch_lightning_params.png new file mode 100644 index 00000000..ef411073 Binary files /dev/null and b/docs/img/examples_pytorch_lightning_params.png differ diff --git a/docs/img/examples_pytorch_lightning_scalars.png b/docs/img/examples_pytorch_lightning_scalars.png new file mode 100644 index 00000000..31ceefb4 Binary files /dev/null and b/docs/img/examples_pytorch_lightning_scalars.png differ diff --git a/sidebars.js b/sidebars.js index 4783dd03..1fce8ba8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -76,6 +76,7 @@ module.exports = { 'guides/frameworks/pytorch/tensorboard_toy_pytorch'] }, {'Pytorch Ignite': ['guides/frameworks/pytorch ignite/integration_pytorch_ignite']}, + {'Pytorch Lightning': ['guides/frameworks/pytorch_lightning/pytorch_lightning_example']}, { 'Pytorch Notebooks': [ {'Audio': ['guides/frameworks/pytorch/notebooks/audio/audio_classification_UrbanSound8K', 'guides/frameworks/pytorch/notebooks/audio/audio_preprocessing_example']},