Example: Debug training runs

.github/workflows/test-notebooks.yml

@@ -20,6 +20,7 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
         notebooks: # Add in alphabetical order
+          - how-to-guides/debug-model-training-runs/notebooks/debug_training_runs.ipynb
           - how-to-guides/hpo/notebooks/Neptune_HPO.ipynb
           - how-to-guides/quickstart/notebooks/neptune_quickstart.ipynb
         os: ["${{ inputs.os }}"]

.github/workflows/test-scripts.yml

@@ -20,6 +20,7 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
         scripts: # Add in alphabetical order
+          - how-to-guides/debug-model-training-runs/scripts
           - how-to-guides/hpo/scripts
           - how-to-guides/quickstart/scripts
         os: ["${{ inputs.os }}"]

README.md

@@ -14,13 +14,14 @@ With Neptune, you can monitor thousands of per-layer metrics—losses, gradients
 
 This repo contains tutorials and examples of how to use Neptune.
 
-| | Docs | Neptune | GitHub | Colab |
-| -- | :--: | :--: | :--: | :--: |
-| Quickstart | [![docs-icon]][quickstart] | [![neptune-icon]][quickstart-example] | [![github-icon]][qs-notebook] | [![colab-icon]][qs-colab] |
-| Log different types of metadata | [![docs-icon]][log-metadata] | [![neptune-icon]][log-metadata-example] | | |
-| Organize and filter runs | [![docs-icon]][runs-table] | [![neptune-icon]][runs-table-example] | | |
-| Resume run or other object | [![docs-icon]][resume-run] | | | |
-| Use Neptune in HPO jobs | [![docs-icon]][hpo] | [![neptune-icon]][hpo-example] | [![github-icon]][hpo-notebook] | [![colab-icon]][hpo-colab] |
+|                                 | Docs                         | Neptune                                 | GitHub                         | Colab                      |
+| ------------------------------- | ---------------------------- | --------------------------------------- | ------------------------------ | -------------------------- |
+| Quickstart                      | [![docs-icon]][quickstart]   | [![neptune-icon]][quickstart-example]   | [![github-icon]][qs-notebook]  | [![colab-icon]][qs-colab]  |
+| Log different types of metadata | [![docs-icon]][log-metadata] | [![neptune-icon]][log-metadata-example] |                                |                            |
+| Organize and filter runs        | [![docs-icon]][runs-table]   | [![neptune-icon]][runs-table-example]   |                                |                            |
+| Resume run or other object      | [![docs-icon]][resume-run]   |                                         |                                |                            |
+| Use Neptune in HPO jobs         | [![docs-icon]][hpo]          | [![neptune-icon]][hpo-example]          | [![github-icon]][hpo-notebook] | [![colab-icon]][hpo-colab] |
+| Debug training runs             | [![docs-icon]][debug]        | [![neptune-icon]][debug-example]        | [![github-icon]][debug-notebook] | [![colab-icon]][debug-colab] |
 
 ### Migration tools
 
@@ -48,6 +49,8 @@ This repo contains tutorials and examples of how to use Neptune.
 [hpo-colab]: https://colab.research.google.com/github/neptune-ai/scale-examples/blob/master/how-to-guides/hpo/notebooks/Neptune_HPO.ipynb
 [qs-notebook]: how-to-guides/quickstart/notebooks/neptune_quickstart.ipynb
 [qs-colab]: https://colab.research.google.com/github/neptune-ai/scale-examples/blob/master/how-to-guides/quickstart/notebooks/neptune_quickstart.ipynb
+[debug-notebook]: how-to-guides/debug-model-training-runs/debug_training_runs.ipynb
+[debug-colab]: https://colab.research.google.com/github/neptune-ai/scale-examples/blob/master/how-to-guides/debug-model-training-runs/notebooks/debug_training_runs.ipynb
 
 <!-- External -->
 [blog]: https://neptune.ai/blog
@@ -66,6 +69,8 @@ This repo contains tutorials and examples of how to use Neptune.
 [resume-run]: https://docs.neptune.ai/resume_run
 [runs-table]: https://docs.neptune.ai/runs_table
 [runs-table-example]: https://scale.neptune.ai/o/examples/org/LLM-Pretraining/runs/table?viewId=9e746462-f045-4ff2-9ac4-e41fa349b04d&detailsTab=dashboard&dash=table&type=run&compare=auto-5
+[debug]: https://docs.neptune.ai/debug_runs_tutorial
+[debug-example]: https://scale.neptune.ai/o/examples/org/debug-training-metrics/runs/table?viewId=standard-view&dash=table&compareChartsFilter-compound=udzSoRe3VmlvolZ8TbuB_zvfcAcgJmla8UuNku1rGWdg
 
 <!-- Clickable icons -->
 [docs-icon]: https://neptune.ai/wp-content/uploads/2023/06/file_icon.svg "Read the documentation"