ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-22 07:15:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge bc103ee6ac into 32350fef87

Browse Source
This commit is contained in:
pollfly 2025-04-14 08:15:45 +03:00 committed by GitHub
commit e32e5e90ae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
98 changed files with 96 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/guides/frameworks/lightgbm/lightgbm_example.md
View File

@ -15,25 +15,29 @@ The example script does the following:
The scalars logged in the task can be visualized in a plot, which appears in the ClearML web UI, in the task's **SCALARS** tab. The scalars logged in the task can be visualized in a plot, which appears in the ClearML web UI, in the task's **SCALARS** tab.
![LightGBM scalars](../../../img/examples_lightgbm_scalars.png) ![LightGBM scalars](../../../img/examples_lightgbm_scalars.png#light-mode-only)
![LightGBM scalars](../../../img/examples_lightgbm_scalars_dark.png#dark-mode-only)
## Hyperparameters ## Hyperparameters
ClearML automatically logs the configurations applied to LightGBM. They appear in **CONFIGURATIONS > HYPERPARAMETERS > GENERAL**. ClearML automatically logs the configurations applied to LightGBM. They appear in **CONFIGURATIONS > HYPERPARAMETERS > GENERAL**.
![LightGBM hyperparameters](../../../img/examples_lightgbm_config.png) ![LightGBM hyperparameters](../../../img/examples_lightgbm_config.png#light-mode-only)
![LightGBM hyperparameters](../../../img/examples_lightgbm_config_dark.png#dark-mode-only)
## Artifacts ## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
models and any snapshots created using LightGBM. models and any snapshots created using LightGBM.
![LightGBM model](../../../img/examples_lightgbm_model.png) ![LightGBM model](../../../img/examples_lightgbm_model.png#light-mode-only)
![LightGBM model](../../../img/examples_lightgbm_model_dark.png#dark-mode-only)
## Console ## Console
All other console output appears in **CONSOLE**. All other console output appears in **CONSOLE**.
![LightGBM console](../../../img/examples_lightgbm_console.png) ![LightGBM console](../../../img/examples_lightgbm_console.png#light-mode-only)
![LightGBM console](../../../img/examples_lightgbm_console_dark.png#dark-mode-only)

15
docs/guides/frameworks/matplotlib/matplotlib_example.md
View File

@ -22,18 +22,23 @@ in the `examples` project (in script) or the `Colab notebooks` project (in Jupyt
The scatter plots appear in the **ClearML Web UI**, in **PLOTS**. The scatter plots appear in the **ClearML Web UI**, in **PLOTS**.
![Matplotlib plot 1](../../../img/examples_matplotlib_example_01.png) ![Matplotlib plot 1](../../../img/examples_matplotlib_example_01.png#light-mode-only)
![Matplotlib plot 1](../../../img/examples_matplotlib_example_01_dark.png#dark-mode-only)
![Matplotlib plot 2](../../../img/examples_matplotlib_example_02.png) ![Matplotlib plot 2](../../../img/examples_matplotlib_example_02.png#light-mode-only)
![Matplotlib plot 2](../../../img/examples_matplotlib_example_02_dark.png#dark-mode-only)
![Matplotlib plot 3](../../../img/examples_matplotlib_example_03.png) ![Matplotlib plot 3](../../../img/examples_matplotlib_example_03.png#light-mode-only)
![Matplotlib plot 3](../../../img/examples_matplotlib_example_03_dark.png#dark-mode-only)
## Debug Samples ## Debug Samples
The images appear in **DEBUG SAMPLES**. Each debug sample image is associated with a metric. The images appear in **DEBUG SAMPLES**. Each debug sample image is associated with a metric.
![Matplotlib image plot](../../../img/examples_matplotlib_example_04.png) ![Matplotlib image plot](../../../img/examples_matplotlib_example_04.png#light-mode-only)
![Matplotlib image plot](../../../img/examples_matplotlib_example_04_dark.png#dark-mode-only)
View the debug sample in the image viewer. View the debug sample in the image viewer.
![Image viewer](../../../img/examples_matplotlib_example_05.png) ![Image viewer](../../../img/examples_matplotlib_example_05.png#light-mode-only)
![Image viewer](../../../img/examples_matplotlib_example_05_dark.png#dark-mode-only)

15
docs/guides/frameworks/megengine/megengine_mnist.md
View File

@ -17,7 +17,8 @@ The example script does the following:
ClearML automatically logs command line options defined with `argparse`. They appear in the task's **CONFIGURATION** ClearML automatically logs command line options defined with `argparse`. They appear in the task's **CONFIGURATION**
tab under **HYPERPARAMETERS** **>** **Args**. tab under **HYPERPARAMETERS** **>** **Args**.
![Configuration tab](../../../img/examples_megengine_mnist_config.png) ![Configuration tab](../../../img/examples_megengine_mnist_config.png#light-mode-only)
![Configuration tab](../../../img/examples_megengine_mnist_config_dark.png#dark-mode-only)
## Scalars ## Scalars
@ -28,7 +29,8 @@ These scalars can be visualized in plots, which appear in the ClearML [WebApp](.
task's **SCALARS** tab. task's **SCALARS** tab.
![Scalars tab](../../../img/examples_megengine_mnist_scalars.png) ![Scalars tab](../../../img/examples_megengine_mnist_scalars.png#light-mode-only)
![Scalars tab](../../../img/examples_megengine_mnist_scalars_dark.png#dark-mode-only)
## Models ## Models
@ -36,7 +38,8 @@ ClearML automatically captures the model logged using the `megengine.save` metho
View saved snapshots in the task's **ARTIFACTS** tab. View saved snapshots in the task's **ARTIFACTS** tab.
![Artifacts tab](../../../img/examples_megengine_models_1.png) ![Artifacts tab](../../../img/examples_megengine_models_1.png#light-mode-only)
![Artifacts tab](../../../img/examples_megengine_models_1_dark.png#dark-mode-only)
To view the model details, click the model name in the **ARTIFACTS** page, which will open the model's info tab. Alternatively, download the model. To view the model details, click the model name in the **ARTIFACTS** page, which will open the model's info tab. Alternatively, download the model.
@ -45,11 +48,13 @@ The model info panel contains the model details, including:
* Framework * Framework
* Snapshot locations. * Snapshot locations.
![Model info panel](../../../img/examples_megengine_models_2.png) ![Model info panel](../../../img/examples_megengine_models_2.png#light-mode-only)
![Model info panel](../../../img/examples_megengine_models_2_dark.png#dark-mode-only)
## Console ## Console
All console output during the script's execution appears in the task's **CONSOLE** page. All console output during the script's execution appears in the task's **CONSOLE** page.
![Console tab](../../../img/examples_megengine_console.png) ![Console tab](../../../img/examples_megengine_console.png#light-mode-only)
![Console tab](../../../img/examples_megengine_console_dark.png#dark-mode-only)

15
docs/guides/frameworks/pytorch_ignite/integration_pytorch_ignite.md
View File

@ -24,7 +24,8 @@ params = task.connect(params) # enabling configuration override by clearml
``` ```
The hyperparameter configurations can be viewed in the WebApp in the task's **CONFIGURATION** tab. The hyperparameter configurations can be viewed in the WebApp in the task's **CONFIGURATION** tab.
![image](../../../img/examples_integration_pytorch_ignite_config.png) ![Hyperparameters](../../../img/examples_integration_pytorch_ignite_config.png#light-mode-only)
![Hyperparameters](../../../img/examples_integration_pytorch_ignite_config_dark.png#dark-mode-only)
## Ignite TensorboardLogger ## Ignite TensorboardLogger
@ -37,7 +38,8 @@ ClearML automatically captures scalars logged through `TensorboardLogger`.
View the scalars in the task's page in the **ClearML Web UI**, in **SCALARS**. View the scalars in the task's page in the **ClearML Web UI**, in **SCALARS**.
![Task scalars](../../../img/examples_cifar_scalars.png) ![Task scalars](../../../img/examples_cifar_scalars.png#light-mode-only)
![Task scalars](../../../img/examples_cifar_scalars_dark.png#dark-mode-only)
## Model Snapshots ## Model Snapshots
@ -46,18 +48,21 @@ ClearML automatically captures the model logged with Torch, and saves it as an a
View saved snapshots in the task's **ARTIFACTS** tab. View saved snapshots in the task's **ARTIFACTS** tab.
![Task models](../../../img/examples_cifar_artifacts.png) ![Task models](../../../img/examples_cifar_artifacts.png#light-mode-only)
![Task models](../../../img/examples_cifar_artifacts_dark.png#dark-mode-only)
To view the model, in the **ARTIFACTS** tab, click the model name (or download it). To view the model, in the **ARTIFACTS** tab, click the model name (or download it).
![Model details](../../../img/examples_cifar_model.png) ![Model details](../../../img/examples_cifar_model.png#light-mode-only)
![Model details](../../../img/examples_cifar_model_dark.png#dark-mode-only)
## Debug Samples ## Debug Samples
ClearML automatically tracks images logged to TensorboardLogger. They appear in **DEBUG SAMPLES**. ClearML automatically tracks images logged to TensorboardLogger. They appear in **DEBUG SAMPLES**.
![image](../../../img/examples_integration_pytorch_ignite_debug.png) ![Debug Samples](../../../img/examples_integration_pytorch_ignite_debug.png#light-mode-only)
![Debug Samples](../../../img/examples_integration_pytorch_ignite_debug_dark.png#dark-mode-only)
## Ignite ClearMLLogger ## Ignite ClearMLLogger

9
docs/guides/frameworks/pytorch_ignite/pytorch_ignite_mnist.md
View File

@ -161,15 +161,18 @@ When the code runs, the task results can be viewed in the [ClearML Web UI](../..
View the scalars, including training and validation metrics, in the task's page in the ClearML Web UI, under View the scalars, including training and validation metrics, in the task's page in the ClearML Web UI, under
**SCALARS**. **SCALARS**.
![Task scalars](../../../img/ignite_training.png) ![Task scalars](../../../img/ignite_training.png#light-mode-only)
![Task scalars](../../../img/ignite_training_dark.png#dark-mode-only)
### Model Snapshots ### Model Snapshots
View saved snapshots in the **ARTIFACTS** tab. View saved snapshots in the **ARTIFACTS** tab.
![image](../../../img/ignite_artifact.png) ![Task Artifacts](../../../img/ignite_artifact.png#light-mode-only)
![Task Artifacts](../../../img/ignite_artifact_dark.png#dark-mode-only)
To view model details, in the **ARTIFACTS** tab, click the model name (or download it). To view model details, in the **ARTIFACTS** tab, click the model name (or download it).
![image](../../../img/ignite_model.png) ![Model details](../../../img/ignite_model.png#light-mode-only)
![Model details](../../../img/ignite_model_dark.png#dark-mode-only)

12
docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md
View File

@ -16,7 +16,8 @@ The test loss and validation loss plots appear in the task's page in the ClearML
Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab. All of these Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab. All of these
plots are automatically captured by ClearML. plots are automatically captured by ClearML.
![PyTorch Lightning scalars](../../../img/examples_pytorch_lightning_scalars.png) ![PyTorch Lightning scalars](../../../img/examples_pytorch_lightning_scalars.png#light-mode-only)
![PyTorch Lightning scalars](../../../img/examples_pytorch_lightning_scalars_dark.png#dark-mode-only)
## Hyperparameters ## Hyperparameters
@ -24,13 +25,15 @@ plots are automatically captured by ClearML.
ClearML automatically logs command line options defined with argparse and TensorFlow Definitions, which appear in ClearML automatically logs command line options defined with argparse and TensorFlow Definitions, which appear in
**CONFIGURATIONS > HYPERPARAMETERS > Args** and **TF_DEFINE** respectively. **CONFIGURATIONS > HYPERPARAMETERS > Args** and **TF_DEFINE** respectively.
![PyTorch Lightning parameters](../../../img/examples_pytorch_lightning_params.png) ![PyTorch Lightning parameters](../../../img/examples_pytorch_lightning_params.png#light-mode-only)
![PyTorch Lightning parameters](../../../img/examples_pytorch_lightning_params_dark.png#dark-mode-only)
## Artifacts ## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. Models created by the task appear in the task's **ARTIFACTS** tab.
![PyTorch Lightning model](../../../img/examples_pytorch_lightning_model.png) ![PyTorch Lightning model](../../../img/examples_pytorch_lightning_model.png#light-mode-only)
![PyTorch Lightning model](../../../img/examples_pytorch_lightning_model_dark.png#dark-mode-only)
Clicking on a model name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can view Clicking on a model name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can view
the model's details and access the model. the model's details and access the model.
@ -39,5 +42,6 @@ the model's details and access the model.
All other console output appears in **CONSOLE**. All other console output appears in **CONSOLE**.
![PyTorch Lightning console](../../../img/examples_pytorch_lightning_console.png) ![PyTorch Lightning console](../../../img/examples_pytorch_lightning_console.png#light-mode-only)
![PyTorch Lightning console](../../../img/examples_pytorch_lightning_console_dark.png#dark-mode-only)

3
docs/guides/frameworks/scikit-learn/sklearn_matplotlib_example.md
View File

@ -15,4 +15,5 @@ The example does the following:
The learning curve plots appear in the **ClearML web UI** under **PLOTS**. The learning curve plots appear in the **ClearML web UI** under **PLOTS**.
![image](../../../img/examples_sklearn_matplotlib_example_01.png) ![Learning Curve](../../../img/examples_sklearn_matplotlib_example_01.png#light-mode-only)
![Learning Curve](../../../img/examples_sklearn_matplotlib_example_01_dark.png#dark-mode-only)

9
docs/guides/pipeline/pipeline_controller.md
View File

@ -222,20 +222,23 @@ ClearML pipeline page: https://app.clear.ml/pipelines/462f48dba7b441ffb34bddb783
The pipeline run's page contains the pipeline's structure, the execution status of every step, as well as the run's The pipeline run's page contains the pipeline's structure, the execution status of every step, as well as the run's
configuration parameters and output. configuration parameters and output.
![Pipeline DAG](../../img/examples_pipeline_from_tasks_DAG.png) ![Pipeline DAG](../../img/examples_pipeline_from_tasks_DAG.png#light-mode-only)
![Pipeline DAG](../../img/examples_pipeline_from_tasks_DAG_dark.png#dark-mode-only)
To view a run's complete information, click **Full details** on the bottom of the **Run Info** panel, which will open To view a run's complete information, click **Full details** on the bottom of the **Run Info** panel, which will open
the pipeline's [controller task page](../../webapp/webapp_exp_track_visual.md). the pipeline's [controller task page](../../webapp/webapp_exp_track_visual.md).
Click a step to see its summary information. Click a step to see its summary information.
![Pipeline step info](../../img/examples_pipeline_from_tasks_step_info.png) ![Pipeline step info](../../img/examples_pipeline_from_tasks_step_info.png#light-mode-only)
![Pipeline step info](../../img/examples_pipeline_from_tasks_step_info_dark.png#dark-mode-only)
### Console ### Console
Click **DETAILS** to view a log of the pipeline controller's console output. Click **DETAILS** to view a log of the pipeline controller's console output.
![Pipeline console](../../img/examples_pipeline_from_tasks_console.png) ![Pipeline console](../../img/examples_pipeline_from_tasks_console.png#light-mode-only)
![Pipeline console](../../img/examples_pipeline_from_tasks_console_dark.png#dark-mode-only)
Click on a step to view its console output. Click on a step to view its console output.

12
docs/guides/pipeline/pipeline_decorator.md
View File

@ -87,22 +87,26 @@ ClearML pipeline page: https://app.clear.ml/pipelines/462f48dba7b441ffb34bddb783
The pipeline run's page contains the pipeline's structure, the execution status of every step, as well as the run's The pipeline run's page contains the pipeline's structure, the execution status of every step, as well as the run's
configuration parameters and output. configuration parameters and output.
![Pipeline DAG](../../img/examples_pipeline_from_decorator_DAG.png) ![Pipeline DAG](../../img/examples_pipeline_from_decorator_DAG.png#light-mode-only)
![Pipeline DAG](../../img/examples_pipeline_from_decorator_DAG_dark.png#dark-mode-only)
To view a run's complete information, click **Full details** on the bottom of the **Run Info** panel, which will open the To view a run's complete information, click **Full details** on the bottom of the **Run Info** panel, which will open the
pipeline's [controller task page](../../webapp/webapp_exp_track_visual.md). pipeline's [controller task page](../../webapp/webapp_exp_track_visual.md).
Click a step to see an overview of its details. Click a step to see an overview of its details.
![Pipeline step info](../../img/examples_pipeline_from_decorator_step_info.png) ![Pipeline step info](../../img/examples_pipeline_from_decorator_step_info.png#light-mode-only)
![Pipeline step info](../../img/examples_pipeline_from_decorator_step_info_dark.png#dark-mode-only)
## Console and Code ## Console and Code
Click **DETAILS** to view a log of the pipeline controller's console output. Click **DETAILS** to view a log of the pipeline controller's console output.
![Pipeline console](../../img/examples_pipeline_from_decorator_console.png) ![Pipeline console](../../img/examples_pipeline_from_decorator_console.png#light-mode-only)
![Pipeline console](../../img/examples_pipeline_from_decorator_console_dark.png#dark-mode-only)
Click on a step to view its console output. You can also view the selected step's code by clicking **CODE** Click on a step to view its console output. You can also view the selected step's code by clicking **CODE**
on top of the console log. on top of the console log.
![Pipeline step code](../../img/examples_pipeline_from_decorator_code.png) ![Pipeline step code](../../img/examples_pipeline_from_decorator_code.png#light-mode-only)
![Pipeline step code](../../img/examples_pipeline_from_decorator_code_dark.png#dark-mode-only)

14
docs/guides/pipeline/pipeline_functions.md
View File

@ -116,22 +116,26 @@ ClearML pipeline page: https://app.clear.ml/pipelines/462f48dba7b441ffb34bddb783
The pipeline run's page contains the pipeline's structure, the execution status of every step, as well as the run's The pipeline run's page contains the pipeline's structure, the execution status of every step, as well as the run's
configuration parameters and output. configuration parameters and output.
![Pipeline DAG](../../img/pipeline_from_functions_DAG.png) ![Pipeline DAG](../../img/pipeline_from_functions_DAG.png#light-mode-only)
![Pipeline DAG](../../img/pipeline_from_functions_DAG_dark.png#dark-mode-only)
To view a run's complete information, click **Full details** on the bottom of the **Run Info** panel, which will open the To view a run's complete information, click **Full details** on the bottom of the **Run Info** panel, which will open the
pipeline's [controller task page](../../webapp/webapp_exp_track_visual.md). pipeline's [controller task page](../../webapp/webapp_exp_track_visual.md).
Click a step to see an overview of its details. Click a step to see an overview of its details.
![Pipeline step info](../../img/pipeline_from_functions_step_info.png) ![Pipeline step info](../../img/pipeline_from_functions_step_info.png#light-mode-only)
![Pipeline step info](../../img/pipeline_from_functions_step_info_dark.png#dark-mode-only)
## Console and Code ### Console and Code
Click **DETAILS** to view a log of the pipeline controller's console output. Click **DETAILS** to view a log of the pipeline controller's console output.
![Pipeline console](../../img/pipeline_from_functions_console.png) ![Pipeline console](../../img/pipeline_from_functions_console.png#light-mode-only)
![Pipeline console](../../img/pipeline_from_functions_console_dark.png#dark-mode-only)
Click on a step to view its console output. You can also view the selected step's code by clicking **CODE** Click on a step to view its console output. You can also view the selected step's code by clicking **CODE**
on top of the console log. on top of the console log.
![Pipeline step code](../../img/pipeline_from_functions_code.png) ![Pipeline step code](../../img/pipeline_from_functions_code.png#light-mode-only)
![Pipeline step code](../../img/pipeline_from_functions_code_dark.png#dark-mode-only)

9
docs/guides/reporting/manual_matplotlib_reporting.md
View File

@ -10,13 +10,16 @@ example demonstrates using ClearML to log plots and images generated by Matplotl
The Matplotlib and Seaborn plots reported using [`Logger.report_matplotlib_figure()`](../../references/sdk/logger.md#report_matplotlib_figure) The Matplotlib and Seaborn plots reported using [`Logger.report_matplotlib_figure()`](../../references/sdk/logger.md#report_matplotlib_figure)
appear in the task's **PLOTS** tab. appear in the task's **PLOTS** tab.
![Task Matplotlib plots](../../img/manual_matplotlib_reporting_01.png) ![Task Matplotlib plots](../../img/manual_matplotlib_reporting_01.png#light-mode-only)
![Task Matplotlib plots](../../img/manual_matplotlib_reporting_01_dark.png#dark-mode-only)
![Task Seaborn plot](../../img/manual_matplotlib_reporting_02.png) ![Task Seaborn plot](../../img/manual_matplotlib_reporting_02.png#light-mode-only)
![Task Seaborn plot](../../img/manual_matplotlib_reporting_02_dark.png#dark-mode-only)
## Debug Samples ## Debug Samples
Matplotlib figures can be logged as images by using [`Logger.report_matplotlib_figure()`](../../references/sdk/logger.md#report_matplotlib_figure), Matplotlib figures can be logged as images by using [`Logger.report_matplotlib_figure()`](../../references/sdk/logger.md#report_matplotlib_figure),
and passing `report_image=True`. The images are displayed in the task's **DEBUG SAMPLES**. and passing `report_image=True`. The images are displayed in the task's **DEBUG SAMPLES**.
![Task debug sample](../../img/manual_matplotlib_reporting_03.png) ![Task debug sample](../../img/manual_matplotlib_reporting_03.png#light-mode-only)
![Task debug sample](../../img/manual_matplotlib_reporting_03_dark.png#dark-mode-only)

BIN
docs/img/examples_cifar_artifacts.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/img/examples_cifar_artifacts_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/img/examples_cifar_model.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

BIN
docs/img/examples_cifar_model_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 47 KiB

BIN
docs/img/examples_cifar_scalars.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 199 KiB

After

Width:  |  Height:  |  Size: 186 KiB

BIN
docs/img/examples_cifar_scalars_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 190 KiB

BIN
docs/img/examples_integration_pytorch_ignite_config.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 41 KiB

BIN
docs/img/examples_integration_pytorch_ignite_config_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

BIN
docs/img/examples_integration_pytorch_ignite_debug.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 76 KiB

BIN
docs/img/examples_integration_pytorch_ignite_debug_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 76 KiB

BIN
docs/img/examples_lightgbm_config.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 55 KiB

BIN
docs/img/examples_lightgbm_config_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 55 KiB

BIN
docs/img/examples_lightgbm_console.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 174 KiB

After

Width:  |  Height:  |  Size: 61 KiB

BIN
docs/img/examples_lightgbm_console_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB

BIN
docs/img/examples_lightgbm_model.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 35 KiB

BIN
docs/img/examples_lightgbm_model_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 35 KiB

BIN
docs/img/examples_lightgbm_scalars.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 65 KiB

BIN
docs/img/examples_lightgbm_scalars_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 67 KiB

BIN
docs/img/examples_matplotlib_example_01.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 69 KiB

BIN
docs/img/examples_matplotlib_example_01_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 69 KiB

BIN
docs/img/examples_matplotlib_example_02.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 45 KiB

BIN
docs/img/examples_matplotlib_example_02_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

BIN
docs/img/examples_matplotlib_example_03.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 118 KiB

After

Width:  |  Height:  |  Size: 121 KiB

BIN
docs/img/examples_matplotlib_example_03_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 122 KiB

BIN
docs/img/examples_matplotlib_example_04.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 41 KiB

BIN
docs/img/examples_matplotlib_example_04_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 41 KiB

BIN
docs/img/examples_matplotlib_example_05.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 294 KiB

After

Width:  |  Height:  |  Size: 286 KiB

BIN
docs/img/examples_matplotlib_example_05_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 278 KiB

BIN
docs/img/examples_megengine_console.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 186 KiB

After

Width:  |  Height:  |  Size: 106 KiB

BIN
docs/img/examples_megengine_console_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 112 KiB

BIN
docs/img/examples_megengine_mnist_config.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 34 KiB

BIN
docs/img/examples_megengine_mnist_config_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
docs/img/examples_megengine_mnist_scalars.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 68 KiB

BIN
docs/img/examples_megengine_mnist_scalars_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 66 KiB

BIN
docs/img/examples_megengine_models_1.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/img/examples_megengine_models_1_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/img/examples_megengine_models_2.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/img/examples_megengine_models_2_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/img/examples_pipeline_from_decorator_DAG.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 176 KiB

BIN
docs/img/examples_pipeline_from_decorator_DAG_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 175 KiB

BIN
docs/img/examples_pipeline_from_decorator_code.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 145 KiB

After

Width:  |  Height:  |  Size: 168 KiB

BIN
docs/img/examples_pipeline_from_decorator_code_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 171 KiB

BIN
docs/img/examples_pipeline_from_decorator_console.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 157 KiB

After

Width:  |  Height:  |  Size: 206 KiB

BIN
docs/img/examples_pipeline_from_decorator_console_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 204 KiB

BIN
docs/img/examples_pipeline_from_decorator_step_info.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 117 KiB

After

Width:  |  Height:  |  Size: 186 KiB

BIN
docs/img/examples_pipeline_from_decorator_step_info_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 185 KiB

BIN
docs/img/examples_pipeline_from_tasks_DAG.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 120 KiB

After

Width:  |  Height:  |  Size: 162 KiB

BIN
docs/img/examples_pipeline_from_tasks_DAG_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 160 KiB

BIN
docs/img/examples_pipeline_from_tasks_console.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 140 KiB

After

Width:  |  Height:  |  Size: 183 KiB

BIN
docs/img/examples_pipeline_from_tasks_console_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 181 KiB

BIN
docs/img/examples_pipeline_from_tasks_step_info.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 130 KiB

After

Width:  |  Height:  |  Size: 176 KiB

BIN
docs/img/examples_pipeline_from_tasks_step_info_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 174 KiB

BIN
docs/img/examples_pytorch_lightning_console.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 133 KiB

BIN
docs/img/examples_pytorch_lightning_console_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 137 KiB

BIN
docs/img/examples_pytorch_lightning_model.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 48 KiB

BIN
docs/img/examples_pytorch_lightning_model_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 48 KiB

BIN
docs/img/examples_pytorch_lightning_params.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 90 KiB

After

Width:  |  Height:  |  Size: 84 KiB

BIN
docs/img/examples_pytorch_lightning_params_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 87 KiB

BIN
docs/img/examples_pytorch_lightning_scalars.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 83 KiB

BIN
docs/img/examples_pytorch_lightning_scalars_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 89 KiB

BIN
docs/img/examples_sklearn_matplotlib_example_01.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 91 KiB

After

Width:  |  Height:  |  Size: 108 KiB

BIN
docs/img/examples_sklearn_matplotlib_example_01_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 108 KiB

BIN
docs/img/ignite_artifact.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 69 KiB

BIN
docs/img/ignite_artifact_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 70 KiB

BIN
docs/img/ignite_model.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 56 KiB

BIN
docs/img/ignite_model_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 56 KiB

BIN
docs/img/ignite_training.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 147 KiB

After

Width:  |  Height:  |  Size: 130 KiB

BIN
docs/img/ignite_training_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 136 KiB

BIN
docs/img/integrations_lightningcli_params.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 99 KiB

After

Width:  |  Height:  |  Size: 89 KiB

BIN
docs/img/integrations_lightningcli_params_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 92 KiB

BIN
docs/img/manual_matplotlib_reporting_01.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 84 KiB

BIN
docs/img/manual_matplotlib_reporting_01_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 83 KiB

BIN
docs/img/manual_matplotlib_reporting_02.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 124 KiB

BIN
docs/img/manual_matplotlib_reporting_02_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 125 KiB

BIN
docs/img/manual_matplotlib_reporting_03.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 52 KiB

BIN
docs/img/manual_matplotlib_reporting_03_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

BIN
docs/img/pipeline_from_functions_DAG.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 122 KiB

After

Width:  |  Height:  |  Size: 123 KiB

BIN
docs/img/pipeline_from_functions_DAG_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 123 KiB

BIN
docs/img/pipeline_from_functions_code.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 157 KiB

After

Width:  |  Height:  |  Size: 149 KiB

BIN
docs/img/pipeline_from_functions_code_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 150 KiB

BIN
docs/img/pipeline_from_functions_console.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 142 KiB

After

Width:  |  Height:  |  Size: 144 KiB

BIN
docs/img/pipeline_from_functions_console_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 144 KiB

BIN
docs/img/pipeline_from_functions_step_info.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 132 KiB

After

Width:  |  Height:  |  Size: 131 KiB

BIN
docs/img/pipeline_from_functions_step_info_dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 131 KiB

8
docs/integrations/ignite.md
View File

@ -132,13 +132,14 @@ All the task information that ClearML captures can be viewed in the [WebApp](../
View saved model snapshots in the **ARTIFACTS** tab. View saved model snapshots in the **ARTIFACTS** tab.
![Model snapshots](../img/ignite_artifact.png) ![Model snapshots](../img/ignite_artifact.png#light-mode-only)
### Scalars ### Scalars
View the scalars in the task's **SCALARS** tab. View the scalars in the task's **SCALARS** tab.
![Scalars](../img/examples_cifar_scalars.png) ![Scalars](../img/examples_cifar_scalars.png#light-mode-only)
![Scalars](../img/examples_cifar_scalars_dark.png#dark-mode-only)
### Debug Samples ### Debug Samples
@ -146,5 +147,6 @@ View the scalars in the task's **SCALARS** tab.
ClearML automatically tracks images logged to `TensorboardLogger`. They appear in the task's **DEBUG SAMPLES**. ClearML automatically tracks images logged to `TensorboardLogger`. They appear in the task's **DEBUG SAMPLES**.
![Debug Samples](../img/examples_integration_pytorch_ignite_debug.png) ![Debug Samples](../img/examples_integration_pytorch_ignite_debug.png#light-mode-only)
![Debug Samples](../img/examples_integration_pytorch_ignite_debug_dark.png#dark-mode-only)

9
docs/integrations/matplotlib.md
View File

@ -28,7 +28,8 @@ This will create a ClearML Task that captures:
View captured Matplotlib plots and images in the [WebApp](../webapp/webapp_exp_track_visual.md), View captured Matplotlib plots and images in the [WebApp](../webapp/webapp_exp_track_visual.md),
in the task's **Plots** and **Debug Samples** tabs respectively. in the task's **Plots** and **Debug Samples** tabs respectively.
![Task plots](../img/examples_matplotlib_example_01.png) ![Task plots](../img/examples_matplotlib_example_01.png#light-mode-only)
![Task plots](../img/examples_matplotlib_example_01_dark.png#dark-mode-only)
## Automatic Logging Control ## Automatic Logging Control
By default, when ClearML is integrated into your script, it captures all of your matplotlib visualizations. By default, when ClearML is integrated into your script, it captures all of your matplotlib visualizations.
@ -67,12 +68,14 @@ plt.show()
The logged figure is displayed in the task's **Plots** tab. The logged figure is displayed in the task's **Plots** tab.
![Task Matplotlib plots](../img/manual_matplotlib_reporting_01.png) ![Task Matplotlib plots](../img/manual_matplotlib_reporting_01.png#light-mode-only)
![Task Matplotlib plots](../img/manual_matplotlib_reporting_01_dark.png#dark-mode-only)
Matplotlib figures can be logged as images by passing `report_image=True` to `Logger.report_matplotlib_figure()`. Matplotlib figures can be logged as images by passing `report_image=True` to `Logger.report_matplotlib_figure()`.
View the images in the task's **DEBUG SAMPLES** tab. View the images in the task's **DEBUG SAMPLES** tab.
![Task debug sample](../img/manual_matplotlib_reporting_03.png) ![Task debug sample](../img/manual_matplotlib_reporting_03.png#light-mode-only)
![Task debug sample](../img/manual_matplotlib_reporting_03_dark.png#dark-mode-only)
See [Manual Matplotlib Reporting](../guides/reporting/manual_matplotlib_reporting.md) example. See [Manual Matplotlib Reporting](../guides/reporting/manual_matplotlib_reporting.md) example.

3
docs/integrations/pytorch_lightning.md
View File

@ -31,7 +31,8 @@ And that's it! This creates a [ClearML Task](../fundamentals/task.md) which capt
You can view all the task details in the [WebApp](../webapp/webapp_overview.md). You can view all the task details in the [WebApp](../webapp/webapp_overview.md).
![LightningCLI params](../img/integrations_lightningcli_params.png) ![LightningCLI params](../img/integrations_lightningcli_params.png#light-mode-only)
![LightningCLI params](../img/integrations_lightningcli_params_dark.png#dark-mode-only)
See an example of PyTorch Lightning and ClearML in action [here](../guides/frameworks/pytorch_lightning/pytorch_lightning_example.md). See an example of PyTorch Lightning and ClearML in action [here](../guides/frameworks/pytorch_lightning/pytorch_lightning_example.md).