ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update example images (#1073)

Browse Source
This commit is contained in:
pollfly
2025-03-05 16:38:02 +02:00
committed by GitHub
parent be7b2b04bd
commit f130d3d758
112 changed files with 115 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/guides/frameworks/catboost/catboost.md
View File

@@ -15,25 +15,30 @@ The example script does the following:
ClearML automatically captures scalars logged by CatBoost. These scalars can be visualized in plots, which appear in the
[ClearML web UI](../../../webapp/webapp_overview.md), in the task's **SCALARS** tab.
![Task scalars](../../../img/examples_catboost_scalars.png)
![Task scalars](../../../img/examples_catboost_scalars.png#light-mode-only)
![Task scalars](../../../img/examples_catboost_scalars_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs command line options defined with argparse. They appear in **CONFIGURATIONS > HYPERPARAMETERS > Args**.
![Task hyperparameters](../../../img/examples_catboost_configurations.png)
![Task hyperparameters](../../../img/examples_catboost_configurations.png#light-mode-only)
![Task hyperparameters](../../../img/examples_catboost_configurations_dark.png#dark-mode-only)
## Console
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![Task console](../../../img/examples_catboost_console.png)
![Task console](../../../img/examples_catboost_console.png#light-mode-only)
![Task console](../../../img/examples_catboost_console_dark.png#dark-mode-only)
## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
models created using CatBoost.
![Task artifacts](../../../img/examples_catboost_artifacts.png)
![Task artifacts](../../../img/examples_catboost_artifacts.png#light-mode-only)
![Task artifacts](../../../img/examples_catboost_artifacts_dark.png#dark-mode-only)
Clicking on the 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.
![Model page](../../../img/examples_catboost_model.png)
![Model page](../../../img/examples_catboost_model.png#light-mode-only)
![Model page](../../../img/examples_catboost_model_dark.png#dark-mode-only)

9
docs/guides/frameworks/fastai/fastai_with_tensorboard.md
View File

@@ -18,16 +18,19 @@ The example code does the following:
ClearML automatically logs the histogram output to TensorBoard. They appear in **PLOTS**.
![image](../../../img/examples_reporting_fastai_01.png)
![Scalars](../../../img/examples_reporting_fastai_01.png#light-mode-only)
![Scalars](../../../img/examples_reporting_fastai_01_dark.png#dark-mode-only)
## Plots
Histograms output to TensorBoard. They appear in **PLOTS**.
![image](../../../img/examples_reporting_fastai_02.png)
![Plots](../../../img/examples_reporting_fastai_02.png#light-mode-only)
![Plots](../../../img/examples_reporting_fastai_02_dark.png#dark-mode-only)
## Logs
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_reporting_fastai_03.png)
![Console](../../../img/examples_reporting_fastai_03.png#light-mode-only)
![Console](../../../img/examples_reporting_fastai_03_dark.png#dark-mode-only)

9
docs/guides/frameworks/huggingface/transformers.md
View File

@@ -36,7 +36,8 @@ ClearML captures all of the `TrainingArguments` passed to the Trainer.
View these parameters in the task's **CONFIGURATION** tab **> Hyperparameters** section.
![Transformers params](../../../img/examples_transformers_params.png)
![Transformers params](../../../img/examples_transformers_params.png#light-mode-only)
![Transformers params](../../../img/examples_transformers_params_dark.png#dark-mode-only)
### Models
@@ -47,10 +48,12 @@ variable is set to `True`.
ClearML automatically captures the model snapshots created by the Trainer, and saves them as artifacts. View the snapshots in the
task's **ARTIFACTS** tab.
![Transformers models](../../../img/examples_transformers_artifacts.png)
![Transformers models](../../../img/examples_transformers_artifacts.png#light-mode-only)
![Transformers models](../../../img/examples_transformers_artifacts_dark.png#dark-mode-only)
### Scalars
ClearML automatically captures the Trainer's scalars, which can be viewed in the task's **Scalars** tab.
![Transformers scalars](../../../img/integrations_transformers_scalars.png)
![Transformers scalars](../../../img/integrations_transformers_scalars.png#light-mode-only)
![Transformers scalars](../../../img/integrations_transformers_scalars_dark.png#dark-mode-only)

12
docs/guides/frameworks/pytorch/model_updating.md
View File

@@ -83,18 +83,22 @@ if CONDITION:
## WebApp
The model appears in the task's **ARTIFACTS** tab.
![Task artifacts](../../../img/examples_model_update_artifacts.png)
![Task artifacts](../../../img/examples_model_update_artifacts.png#light-mode-only)
![Task artifacts](../../../img/examples_model_update_artifacts_dark.png#dark-mode-only)
Clicking on the 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.
![Model page](../../../img/examples_model_update_model.png)
![Model page](../../../img/examples_model_update_model.png#light-mode-only)
![Model page](../../../img/examples_model_update_model_dark.png#dark-mode-only)
The model's **NETWORK** tab displays its configuration.
![Model network tab](../../../img/examples_model_update_network.png)
![Model network tab](../../../img/examples_model_update_network.png#light-mode-only)
![Model network tab](../../../img/examples_model_update_network_dark.png#dark-mode-only)
The model's **LABELS** tab displays its label enumeration.
![Model labels](../../../img/examples_model_update_labels.png)
![Model labels](../../../img/examples_model_update_labels.png#light-mode-only)
![Model labels](../../../img/examples_model_update_labels_dark.png#dark-mode-only)

15
docs/guides/frameworks/pytorch/pytorch_distributed_example.md
View File

@@ -35,7 +35,8 @@ Task.current_task().upload_artifact(
All of these artifacts appear in the main Task, **ARTIFACTS** **>** **OTHER**.
![image](../../../img/examples_pytorch_distributed_example_09.png)
![Artifacts](../../../img/examples_pytorch_distributed_example_09.png#light-mode-only)
![Artifacts](../../../img/examples_pytorch_distributed_example_09_dark.png#dark-mode-only)
## Scalars
@@ -54,7 +55,8 @@ Task.current_task().get_logger().report_scalar(
The single scalar plot for loss appears in **SCALARS**.
![image](../../../img/examples_pytorch_distributed_example_08.png)
![Scalars](../../../img/examples_pytorch_distributed_example_08.png#light-mode-only)
![Scalars](../../../img/examples_pytorch_distributed_example_08_dark.png#dark-mode-only)
## Hyperparameters
@@ -69,7 +71,8 @@ Task.current_task().connect(param)
Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**.
![image](../../../img/examples_pytorch_distributed_example_01.png)
![Hyperparamter Args](../../../img/examples_pytorch_distributed_example_01.png#light-mode-only)
![Hyperparamter Args](../../../img/examples_pytorch_distributed_example_01_dark.png#dark-mode-only)
Parameter dictionaries appear in the **General** section of **HYPERPARAMETERS**.
@@ -78,10 +81,12 @@ param = {'worker_{}_stuff'.format(dist.get_rank()): 'some stuff ' + str(randint(
Task.current_task().connect(param)
```
![image](../../../img/examples_pytorch_distributed_example_02.png)
![Hyperparameter General args](../../../img/examples_pytorch_distributed_example_02.png#light-mode-only)
![Hyperparameter General args](../../../img/examples_pytorch_distributed_example_02_dark.png#dark-mode-only)
## Log
Output to the console, including the text messages printed from the main Task object and each subprocess, appears in **CONSOLE**.
![image](../../../img/examples_pytorch_distributed_example_06.png)
![Console log](../../../img/examples_pytorch_distributed_example_06.png#light-mode-only)
![Console log](../../../img/examples_pytorch_distributed_example_06_dark.png#dark-mode-only)

11
docs/guides/frameworks/pytorch/pytorch_matplotlib.md
View File

@@ -14,15 +14,18 @@ The example does the following:
The images shown in the example script's `imshow` function appear according to metric in **DEBUG SAMPLES**.
![image](../../../img/examples_pytorch_matplotlib_02.png)
![Debug samples](../../../img/examples_pytorch_matplotlib_02.png#light-mode-only)
![Debug samples](../../../img/examples_pytorch_matplotlib_02_dark.png#dark-mode-only)
Select a debug sample by metric.
![image](../../../img/examples_pytorch_matplotlib_02a.png)
![Debug sample selection](../../../img/examples_pytorch_matplotlib_02a.png#light-mode-only)
![Debug sample selection](../../../img/examples_pytorch_matplotlib_02a_dark.png#dark-mode-only)
Open the debug sample in the image viewer.
Click a debug sample to view it in the image viewer.
![image](../../../img/examples_pytorch_matplotlib_02b.png)
![Debug sample image viewer](../../../img/examples_pytorch_matplotlib_02b.png#light-mode-only)
![Debug sample image viewer](../../../img/examples_pytorch_matplotlib_02b_dark.png#dark-mode-only)

15
docs/guides/frameworks/pytorch/pytorch_mnist.md
View File

@@ -36,28 +36,33 @@ Logger.current_logger().report_scalar(
These scalars can be visualized in plots, which appear in the ClearML [web UI](../../../webapp/webapp_overview.md),
in the task's **SCALARS** tab.
![image](../../../img/examples_pytorch_mnist_07.png)
![Scalars](../../../img/examples_pytorch_mnist_07.png#light-mode-only)
![Scalars](../../../img/examples_pytorch_mnist_07_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**.
![image](../../../img/examples_pytorch_mnist_01.png)
![Hyperparameters](../../../img/examples_pytorch_mnist_01.png#light-mode-only)
![Hyperparameters](../../../img/examples_pytorch_mnist_01_dark.png#dark-mode-only)
## Console
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_pytorch_mnist_06.png)
![Console Log](../../../img/examples_pytorch_mnist_06.png#light-mode-only)
![Console Log](../../../img/examples_pytorch_mnist_06_dark.png#dark-mode-only)
## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks models
and any snapshots created using PyTorch.
![image](../../../img/examples_pytorch_mnist_02.png)
![Models](../../../img/examples_pytorch_mnist_02.png#light-mode-only)
![Models](../../../img/examples_pytorch_mnist_02_dark.png#dark-mode-only)
Clicking on the 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.
![image](../../../img/examples_pytorch_mnist_03.png)
![Model details](../../../img/examples_pytorch_mnist_03.png#light-mode-only)
![Model details](../../../img/examples_pytorch_mnist_03_dark.png#dark-mode-only)

18
docs/guides/frameworks/pytorch/pytorch_tensorboard.md
View File

@@ -18,34 +18,40 @@ In the example script, the `train` and `test` functions call the TensorBoard `Su
These scalars, along with the resource utilization plots, which are titled **:monitor: machine**, appear in the task's
page in the [ClearML web UI](../../../webapp/webapp_overview.md) under **SCALARS**.
![image](../../../img/examples_pytorch_tensorboard_07.png)
![Scalars](../../../img/examples_pytorch_tensorboard_07.png#light-mode-only)
![Scalars](../../../img/examples_pytorch_tensorboard_07_dark.png#dark-mode-only)
## Debug Samples
ClearML automatically tracks images and text output to TensorFlow. They appear in **DEBUG SAMPLES**.
![image](../../../img/examples_pytorch_tensorboard_08.png)
![Debug Samples](../../../img/examples_pytorch_tensorboard_08.png#light-mode-only)
![Debug Samples](../../../img/examples_pytorch_tensorboard_08_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**.
![image](../../../img/examples_pytorch_tensorboard_01.png)
![Hyperparameters](../../../img/examples_pytorch_tensorboard_01.png#light-mode-only)
![Hyperparameters](../../../img/examples_pytorch_tensorboard_01_dark.png#dark-mode-only)
## Console
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_pytorch_tensorboard_06.png)
![Console Log](../../../img/examples_pytorch_tensorboard_06.png#light-mode-only)
![Console Log](../../../img/examples_pytorch_tensorboard_06_dark.png#dark-mode-only)
## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
models and any snapshots created using PyTorch.
![image](../../../img/examples_pytorch_tensorboard_02.png)
![Artifacts](../../../img/examples_pytorch_tensorboard_02.png#light-mode-only)
![Artifacts](../../../img/examples_pytorch_tensorboard_02_dark.png#dark-mode-only)
Clicking on a model's 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.
![image](../../../img/examples_pytorch_tensorboard_03.png)
![Model details](../../../img/examples_pytorch_tensorboard_03.png#light-mode-only)
![Model details](../../../img/examples_pytorch_tensorboard_03_dark.png#dark-mode-only)

15
docs/guides/frameworks/pytorch/pytorch_tensorboardx.md
View File

@@ -18,29 +18,34 @@ The loss and accuracy metric scalar plots, along with the resource utilization p
appear in the task's page in the [web UI](../../../webapp/webapp_overview.md), under **SCALARS**.
![image](../../../img/examples_pytorch_tensorboardx_03.png)
![Scalars](../../../img/examples_pytorch_tensorboardx_03.png#light-mode-only)
![Scalars](../../../img/examples_pytorch_tensorboardx_03_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>**
**HYPERPARAMETERS** **>** **Args**.
![image](../../../img/examples_pytorch_tensorboardx_01.png)
![Hyperparameters](../../../img/examples_pytorch_tensorboardx_01.png#light-mode-only)
![Hyperparameters](../../../img/examples_pytorch_tensorboardx_01_dark.png#dark-mode-only)
## Log
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_pytorch_tensorboardx_02.png)
![Console log](../../../img/examples_pytorch_tensorboardx_02.png#light-mode-only)
![Console log](../../../img/examples_pytorch_tensorboardx_02_dark.png#dark-mode-only)
## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
models and any snapshots created using PyTorch.
![image](../../../img/examples_pytorch_tensorboardx_04.png)
![Artifacts](../../../img/examples_pytorch_tensorboardx_04.png#light-mode-only)
![Artifacts](../../../img/examples_pytorch_tensorboardx_04_dark.png#dark-mode-only)
Clicking on the 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.
![image](../../../img/examples_pytorch_tensorboardx_model.png)
![Model details](../../../img/examples_pytorch_tensorboardx_model.png#light-mode-only)
![Model details](../../../img/examples_pytorch_tensorboardx_model_dark.png#dark-mode-only)

6
docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md
View File

@@ -11,10 +11,12 @@ associated with the `examples` project.
The debug sample images appear according to metric, in the task's **DEBUG SAMPLES** tab.
![image](../../../img/examples_tensorboard_toy_pytorch_02.png)
![Debug samples](../../../img/examples_tensorboard_toy_pytorch_02.png#light-mode-only)
![Debug samples](../../../img/examples_tensorboard_toy_pytorch_02_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**.
![image](../../../img/examples_tensorboard_toy_pytorch_00.png)
![Hyperparameters](../../../img/examples_tensorboard_toy_pytorch_00.png#light-mode-only)
![Hyperparameters](../../../img/examples_tensorboard_toy_pytorch_00_dark.png#dark-mode-only)