Merge branch 'main' of https://github.com/allegroai/clearml-docs into edits_3
@ -17,7 +17,7 @@ title: ClearML Agent
|
||||
|
||||
**ClearML Agent** is a virtual environment and execution manager for DL / ML solutions on GPU machines. It integrates with the **ClearML Python Package** and ClearML Server to provide a full AI cluster solution. <br/>
|
||||
Its main focus is around:
|
||||
- Reproducing tasks, including their complete environments.
|
||||
- Reproducing task runs, including their complete environments.
|
||||
- Scaling workflows on multiple target machines.
|
||||
|
||||
ClearML Agent executes a task or other workflow by reproducing the state of the code from the original machine
|
||||
@ -46,7 +46,7 @@ install Python, so make sure to use a container or environment with the version
|
||||
While the agent is running, it continuously reports system metrics to the ClearML Server (these can be monitored in the
|
||||
[**Orchestration**](webapp/webapp_workers_queues.md) page).
|
||||
|
||||
Continue using ClearML Agent once it is running on a target machine. Reproduce tasks and execute
|
||||
Continue using ClearML Agent once it is running on a target machine. Reproducing task runs and execute
|
||||
automated workflows in one (or both) of the following ways:
|
||||
* Programmatically (using [`Task.enqueue()`](references/sdk/task.md#taskenqueue) or [`Task.execute_remotely()`](references/sdk/task.md#execute_remotely))
|
||||
* Through the ClearML Web UI (without working directly with code), by cloning tasks and enqueuing them to the
|
||||
|
@ -14,7 +14,7 @@ powerful remote machine. This is useful for:
|
||||
* Managing execution through ClearML's queue system.
|
||||
|
||||
This guide focuses on transitioning a locally executed process to a remote machine for scalable execution. To learn how
|
||||
to reproduce a previously executed process on a remote machine, see [Reproducing Tasks](reproduce_tasks.md).
|
||||
to reproduce a previously executed process on a remote machine, see [Reproducing Task Runs](reproduce_tasks.md).
|
||||
|
||||
## Running a Task Remotely
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Reproducing Tasks
|
||||
title: Reproducing Task Runs
|
||||
---
|
||||
|
||||
:::note
|
||||
|
@ -18,22 +18,26 @@ The example does the following:
|
||||
|
||||
The loss and accuracy metric scalar plots appear in **SCALARS**, along with the resource utilization plots, which are titled **:monitor: machine**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Plots
|
||||
|
||||
The example calls Matplotlib methods to create several sample plots, and TensorBoard methods to plot histograms for layer density.
|
||||
They appear in **PLOTS**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Debug Samples
|
||||
|
||||
The example calls Matplotlib methods to log debug sample images. They appear in **DEBUG SAMPLES**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Hyperparameters
|
||||
|
||||
@ -55,17 +59,20 @@ task_params['hidden_dim'] = 512
|
||||
|
||||
Parameter dictionaries appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **General**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
The TensorFlow Definitions appear in the **TF_DEFINE** subsection.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Console
|
||||
|
||||
Text printed to the console for training appears in **CONSOLE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Artifacts
|
||||
|
||||
@ -74,9 +81,11 @@ created using Keras.
|
||||
|
||||
The task info panel shows model tracking, including the model name and design in **ARTIFACTS** **>** **Output Model**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||

|
||||

|
@ -25,31 +25,36 @@ The example script does the following:
|
||||
The loss and accuracy metric scalar plots appear in **SCALARS**, along with the resource utilization plots,
|
||||
which are titled **:monitor: machine**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Histograms
|
||||
|
||||
Histograms for layer density appear in **PLOTS**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Hyperparameters
|
||||
|
||||
ClearML automatically logs command line options generated with `argparse`, and TensorFlow Definitions.
|
||||
ClearML automatically logs command line options generated with `argparse` and TensorFlow Definitions.
|
||||
|
||||
Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
TensorFlow Definitions appear in **TF_DEFINE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Console
|
||||
|
||||
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Configuration Objects
|
||||
|
||||
@ -64,4 +69,5 @@ task.connect_configuration(
|
||||
|
||||
It appears in **CONFIGURATION** **>** **CONFIGURATION OBJECTS** **>** **MyConfig**.
|
||||
|
||||

|
||||

|
||||

|
@ -12,16 +12,19 @@ and `matplotlib` to create a scatter diagram. When the script runs, it creates a
|
||||
ClearML automatically logs the scatter plot, which appears in the [task's page](../../../webapp/webapp_exp_track_visual.md)
|
||||
in the ClearML web UI, under **PLOTS**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Artifacts
|
||||
|
||||
Models created by the task appear in the task's **ARTIFACTS** tab.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
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.
|
||||
|
||||
|
||||

|
||||

|
||||

|
@ -16,30 +16,35 @@ The script does the following:
|
||||
The loss and accuracy metric scalar plots appear in the task's page in the **ClearML web UI**, under
|
||||
**SCALARS**. The also includes resource utilization plots, which are titled **:monitor: machine**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Hyperparameters
|
||||
|
||||
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>**
|
||||
**HYPERPARAMETERS** **>** **Args**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Console
|
||||
|
||||
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## 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.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Clicking on the 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.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
|
@ -14,5 +14,6 @@ the `examples` project.
|
||||
ClearML automatically captures the video data that is added to the `SummaryWriter` object, using the `add_video` method.
|
||||
The video appears in the task's **DEBUG SAMPLES** tab.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
|
@ -44,28 +44,33 @@ When the script runs, it logs:
|
||||
ClearML logs the scalars from training each network. They appear in the task's page in the **ClearML web UI**, under
|
||||
**SCALARS**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Summary of Hyperparameter Optimization
|
||||
|
||||
ClearML automatically logs the parameters of each task run in the hyperparameter search. They appear in tabular
|
||||
form in **PLOTS**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Artifacts
|
||||
|
||||
ClearML automatically stores the output model. It appears in **ARTIFACTS** **>** **Output Model**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Model details, such as snap locations, appear in the **MODELS** tab.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
The model configuration is stored with the model.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Configuration Objects
|
||||
|
||||
@ -73,12 +78,14 @@ The model configuration is stored with the model.
|
||||
|
||||
ClearML automatically logs the TensorFlow Definitions, which appear in **CONFIGURATION** **>** **HYPERPARAMETERS**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Configuration
|
||||
|
||||
The Task configuration appears in **CONFIGURATION** **>** **General**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
|
||||
|
@ -20,24 +20,29 @@ In the **ClearML Web UI**, the PR Curve summaries appear in the task's page unde
|
||||
|
||||
* Blue PR curves
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
* Green PR curves
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
* Red PR curves
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Hyperparameters
|
||||
|
||||
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Console
|
||||
|
||||
All other console output appears in **CONSOLE**.
|
||||
All console output appears in **CONSOLE** tab.
|
||||
|
||||

|
||||

|
||||

|
||||
|
@ -14,25 +14,29 @@ project.
|
||||
The `tf.summary.scalar` output appears in the ClearML web UI, in the task's
|
||||
**SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Plots
|
||||
|
||||
The `tf.summary.histogram` output appears in **PLOTS**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Debug Samples
|
||||
|
||||
ClearML automatically tracks images and text output to TensorFlow. They appear in **DEBUG SAMPLES**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Hyperparameters
|
||||
|
||||
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>**
|
||||
**TF_DEFINE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
|
||||
|
@ -13,30 +13,35 @@ When the script runs, it creates a task named `Tensorflow v2 mnist with summarie
|
||||
The loss and accuracy metric scalar plots appear in the task's page in the **ClearML web UI** under
|
||||
**SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Hyperparameters
|
||||
|
||||
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS**
|
||||
**>** **TF_DEFINE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Console
|
||||
|
||||
All console output appears in **CONSOLE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Artifacts
|
||||
|
||||
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
|
||||
models and any snapshots created using TensorFlow.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
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.
|
||||
|
||||
|
||||

|
||||

|
||||

|
@ -13,7 +13,8 @@ the `examples` project.
|
||||
ClearML automatically captures scalars logged with XGBoost, which can be visualized in plots in the
|
||||
ClearML WebApp, in the task's **SCALARS** tab.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Models
|
||||
|
||||
@ -21,14 +22,17 @@ ClearML automatically captures the model logged using the `xgboost.save` method,
|
||||
|
||||
View saved snapshots in the task's **ARTIFACTS** tab.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Console
|
||||
|
||||
All console output during the script's execution appears in the task's **CONSOLE** page.
|
||||
|
||||

|
||||

|
||||

|
@ -18,25 +18,30 @@ classification dataset using XGBoost
|
||||
The feature importance plot and tree plot appear in the task's page in the **ClearML web UI**, under
|
||||
**PLOTS**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
|
||||
## Console
|
||||
|
||||
All other console output appear in **CONSOLE**.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Artifacts
|
||||
|
||||
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
|
||||
models and any snapshots created using XGBoost.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Clicking on the 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.
|
||||
|
||||

|
||||

|
||||

|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 39 KiB |
BIN
docs/img/examples_keras_00_dark.png
Normal file
After Width: | Height: | Size: 40 KiB |
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 76 KiB |
BIN
docs/img/examples_keras_00a_dark.png
Normal file
After Width: | Height: | Size: 78 KiB |
Before Width: | Height: | Size: 129 KiB After Width: | Height: | Size: 120 KiB |
BIN
docs/img/examples_keras_01_dark.png
Normal file
After Width: | Height: | Size: 126 KiB |
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 115 KiB |
BIN
docs/img/examples_keras_02_dark.png
Normal file
After Width: | Height: | Size: 119 KiB |
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 104 KiB |
BIN
docs/img/examples_keras_jupyter_03_dark.png
Normal file
After Width: | Height: | Size: 107 KiB |
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 99 KiB |
BIN
docs/img/examples_keras_jupyter_03a_dark.png
Normal file
After Width: | Height: | Size: 100 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 43 KiB |
BIN
docs/img/examples_keras_jupyter_04_dark.png
Normal file
After Width: | Height: | Size: 43 KiB |
Before Width: | Height: | Size: 269 KiB After Width: | Height: | Size: 128 KiB |
BIN
docs/img/examples_keras_jupyter_07_dark.png
Normal file
After Width: | Height: | Size: 130 KiB |
Before Width: | Height: | Size: 120 KiB After Width: | Height: | Size: 118 KiB |
BIN
docs/img/examples_keras_jupyter_08_dark.png
Normal file
After Width: | Height: | Size: 123 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 47 KiB |
BIN
docs/img/examples_keras_jupyter_20_dark.png
Normal file
After Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 71 KiB |
BIN
docs/img/examples_keras_jupyter_21_dark.png
Normal file
After Width: | Height: | Size: 73 KiB |
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 72 KiB |
BIN
docs/img/examples_keras_jupyter_23_dark.png
Normal file
After Width: | Height: | Size: 73 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 41 KiB |
BIN
docs/img/examples_keras_jupyter_24_dark.png
Normal file
After Width: | Height: | Size: 41 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 38 KiB |
BIN
docs/img/examples_sklearn_joblib_example_01_dark.png
Normal file
After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 44 KiB |
BIN
docs/img/examples_sklearn_joblib_example_02_dark.png
Normal file
After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 59 KiB |
BIN
docs/img/examples_sklearn_joblib_example_06_dark.png
Normal file
After Width: | Height: | Size: 59 KiB |
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 78 KiB |
BIN
docs/img/examples_tensorboard_pr_curve_01_dark.png
Normal file
After Width: | Height: | Size: 81 KiB |
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
BIN
docs/img/examples_tensorboard_pr_curve_02_dark.png
Normal file
After Width: | Height: | Size: 81 KiB |
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 77 KiB |
BIN
docs/img/examples_tensorboard_pr_curve_03_dark.png
Normal file
After Width: | Height: | Size: 81 KiB |
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 68 KiB |
BIN
docs/img/examples_tensorboard_pr_curve_04_dark.png
Normal file
After Width: | Height: | Size: 70 KiB |
Before Width: | Height: | Size: 189 KiB After Width: | Height: | Size: 48 KiB |
BIN
docs/img/examples_tensorboard_pr_curve_05_dark.png
Normal file
After Width: | Height: | Size: 49 KiB |
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 71 KiB |
BIN
docs/img/examples_tensorboard_toy_01_dark.png
Normal file
After Width: | Height: | Size: 73 KiB |
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 97 KiB |
BIN
docs/img/examples_tensorboard_toy_03_dark.png
Normal file
After Width: | Height: | Size: 98 KiB |
Before Width: | Height: | Size: 103 KiB After Width: | Height: | Size: 174 KiB |
BIN
docs/img/examples_tensorboard_toy_04_dark.png
Normal file
After Width: | Height: | Size: 185 KiB |
Before Width: | Height: | Size: 221 KiB After Width: | Height: | Size: 388 KiB |
BIN
docs/img/examples_tensorboard_toy_05_dark.png
Normal file
After Width: | Height: | Size: 387 KiB |
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 30 KiB |
BIN
docs/img/examples_tensorboardx_debug_dark.png
Normal file
After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 69 KiB |
BIN
docs/img/examples_tensorflow_mnist_01_dark.png
Normal file
After Width: | Height: | Size: 69 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 42 KiB |
BIN
docs/img/examples_tensorflow_mnist_03_dark.png
Normal file
After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 262 KiB After Width: | Height: | Size: 113 KiB |
BIN
docs/img/examples_tensorflow_mnist_05_dark.png
Normal file
After Width: | Height: | Size: 116 KiB |
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 112 KiB |
BIN
docs/img/examples_tensorflow_mnist_06_dark.png
Normal file
After Width: | Height: | Size: 116 KiB |
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 43 KiB |
BIN
docs/img/examples_tensorflow_mnist_10_dark.png
Normal file
After Width: | Height: | Size: 43 KiB |
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 38 KiB |
BIN
docs/img/examples_xgboost_metric_artifacts_dark.png
Normal file
After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 39 KiB |
BIN
docs/img/examples_xgboost_metric_console_dark.png
Normal file
After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 42 KiB |
BIN
docs/img/examples_xgboost_metric_model_dark.png
Normal file
After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 56 KiB |
BIN
docs/img/examples_xgboost_metric_scalars_dark.png
Normal file
After Width: | Height: | Size: 59 KiB |
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 44 KiB |
BIN
docs/img/examples_xgboost_sample_03_dark.png
Normal file
After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 45 KiB |
BIN
docs/img/examples_xgboost_sample_05_dark.png
Normal file
After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 59 KiB |
BIN
docs/img/examples_xgboost_sample_06_dark.png
Normal file
After Width: | Height: | Size: 59 KiB |
Before Width: | Height: | Size: 165 KiB After Width: | Height: | Size: 140 KiB |
BIN
docs/img/examples_xgboost_sample_06a_dark.png
Normal file
After Width: | Height: | Size: 141 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 38 KiB |
BIN
docs/img/examples_xgboost_sample_10_dark.png
Normal file
After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 75 KiB |
BIN
docs/img/integration_keras_tuner_01_dark.png
Normal file
After Width: | Height: | Size: 77 KiB |