This commit is contained in:
revital 2025-02-06 12:20:35 +02:00
commit 443202ed31
461 changed files with 501 additions and 232 deletions

View File

@ -44,7 +44,10 @@ ClearML Agent uses the provided default Docker container, which can be overridde
You can set the docker container via the UI:
1. Clone the experiment
2. Set the Docker in the cloned task's **Execution** tab **> Container** section
![Container section](../img/webapp_exp_container.png)
![Container section](../img/webapp_exp_container.png#light-mode-only)
![Container section](../img/webapp_exp_container_dark.png#dark-mode-only)
3. Enqueue the cloned task
The task will be executed in the container specified in the UI.

View File

@ -273,7 +273,8 @@ The agents default container can be overridden via the UI:
1. Clone the task
1. Set the Docker in the cloned task's **Execution** tab > **Container** section
![Task container](../img/fractional_gpu_task_container.png)
![Task container](../img/fractional_gpu_task_container.png#light-mode-only)
![Task container](../img/fractional_gpu_task_container_dark.png#dark-mode-only)
1. Enqueue the cloned task

View File

@ -895,7 +895,8 @@ task.connect(me)
task.connect(params_dictionary)
```
![Task parameters](../img/fundamentals_task_config_hyperparams.png)
![Task parameters](../img/fundamentals_task_config_hyperparams.png#light-mode-only)
![Task parameters](../img/fundamentals_task_config_hyperparams_dark.png#dark-mode-only)
### Configuration Objects
@ -918,7 +919,8 @@ config_file_yaml = task.connect_configuration(
)
```
![Task configuration objects](../img/fundamentals_task_config_object.png)
![Task configuration objects](../img/fundamentals_task_config_object.png#light-mode-only)
![Task configuration objects](../img/fundamentals_task_config_object_dark.png#dark-mode-only)
### User Properties
A task's user properties do not impact task execution, so you can add / modify the properties at any stage. Add user
@ -932,7 +934,8 @@ task.set_user_properties(
)
```
![Task user properties](../img/fundamentals_task_config_properties.png)
![Task user properties](../img/fundamentals_task_config_properties.png#light-mode-only)
![Task user properties](../img/fundamentals_task_config_properties_dark.png#dark-mode-only)
## Scalars

View File

@ -59,7 +59,8 @@ Installing an Agent on machines allows it to monitor all the machine's status (G
When managing multiple machines, this allows users to have an overview of their HW resources: the status of each machine,
the expected workload on each machine, etc.
![Workers and Queues page](../img/agents_queues_resource_management.png)
![Workers and Queues page](../img/agents_queues_resource_management.png#light-mode-only)
![Workers and Queues page](../img/agents_queues_resource_management_dark.png#dark-mode-only)
You can organize your queues according to resource usage. Say you have a single-GPU machine. You can create a queue called

View File

@ -50,7 +50,8 @@ Artifacts appear under the **ARTIFACTS** tab of a Task. Each artifact's location
applications are prohibited from accessing the local disk for security reasons)
* **Network stored artifacts**: Display a download action to retrieve files from URLs (e.g., `https://`, `s3://`).
![WebApp Artifacts section](../img/webapp_tracking_30.png)
![WebApp Artifacts section](../img/webapp_tracking_30.png#light-mode-only)
![WebApp Artifacts section](../img/webapp_tracking_30_dark.png#dark-mode-only)
## SDK Interface
See the [Artifacts](../clearml_sdk/task_sdk.md#artifacts) section in the Task SDK page for an overview of how to work

View File

@ -31,13 +31,17 @@ The preceding diagram demonstrates the typical flow of hyperparameter optimizati
summary of the optimization results in tabular and parallel coordinate formats, and in a scalar plot.
![Optimization results summary chart](../img/fundamentals_hpo_summary.png)
![Optimization results summary chart](../img/fundamentals_hpo_summary.png#light-mode-only)
![Optimization results summary chart](../img/fundamentals_hpo_summary_dark.png#dark-mode-only)
<Collapsible title="Parallel coordinate and scalar plots" type="screenshot">
![Parallel Coordinates](../img/fundamentals_hpo_parallel_coordinates.png)
![Parallel Coordinates](../img/fundamentals_hpo_parallel_coordinates.png#light-mode-only)
![Parallel Coordinates](../img/fundamentals_hpo_parallel_coordinates_dark.png#dark-mode-only)
![Scalars](../img/fundamentals_hpo_scalars.png)
![Scalars](../img/fundamentals_hpo_scalars.png#light-mode-only)
![Scalars](../img/fundamentals_hpo_scalars_dark.png#dark-mode-only)
</Collapsible>

View File

@ -124,7 +124,9 @@ The configuration panel is split into three sections according to type:
These sections are further broken down into subsections based on how the parameters were logged (General / Args / TF_Define / Environment).
![Task hyperparameters sections](../img/hyperparameters_sections.png)
![Task hyperparameters sections](../img/hyperparameters_sections.png#light-mode-only)
![Task hyperparameters sections](../img/hyperparameters_sections_dark.png#dark-mode-only)
## SDK Interface

View File

@ -19,7 +19,8 @@ ClearML supports four types of reports:
- Plots - General graphs and diagrams, such as histograms, confusion matrices, line plots, and custom plotly charts.
- Debug Samples - Images, audio, and videos. Can be reported per iteration.
![image](../img/fundamentals_logger_results.png)
![Logged plots](../img/report_plotly.png#light-mode-only)
![Logged plots](../img/report_plotly_dark.png#dark-mode-only)
## Automatic Reporting
@ -31,7 +32,8 @@ library warning messages.
GPU, CPU, Memory, and Network information is also automatically captured.
![image](../img/fundamentals_logger_cpu_monitoring.png)
![CPU monitoring](../img/fundamentals_logger_cpu_monitoring.png#light-mode-only)
![CPU monitoring](../img/fundamentals_logger_cpu_monitoring_dark.png#dark-mode-only)
### Supported Packages
- [TensorBoard](https://www.tensorflow.org/tensorboard)
@ -74,7 +76,8 @@ outputs that would be used later on.
Only the last X results of each title / series are saved to prevent overloading the server.
See details in [`Logger.report_media`](../references/sdk/logger.md#report_media).
![image](../img/fundamentals_logger_reported_images.png)
![Logger reported images](../img/webapp_tracking_43.png#light-mode-only)
![Logger reported images](../img/webapp_tracking_43_dark.png#dark-mode-only)
### Explicit Reporting Examples

View File

@ -68,7 +68,8 @@ label enumeration, lineage, and general information, click the model name, which
Models can also be accessed through their associated project's [Model Table](../webapp/webapp_model_table.md), where all
the models associated with a project are listed.
![WebApp Model](../img/fundamentals_models.png)
![WebApp Model](../img/webapp_model_general.png#light-mode-only)
![WebApp Model](../img/webapp_model_general_dark.png#dark-mode-only)
## SDK Interface

View File

@ -39,7 +39,8 @@ modified hyperparameters
![Task](../img/fundamentals_task.png)
![Task](../img/fundamentals_task.png#light-mode-only)
![Task](../img/fundamentals_task_dark.png#dark-mode-only)
## Task Sections

View File

@ -143,7 +143,8 @@ Since not all metrics are tracked that way, you can also manually report metrics
You can log everything, from time series data and confusion matrices to HTML, Audio, and Video, to custom plotly graphs! Everything goes!
![Experiment plots](../../img/report_plotly.png)
![Experiment plots](../../img/report_plotly.png#light-mode-only)
![Experiment plots](../../img/report_plotly_dark.png#dark-mode-only)
Once everything is neatly logged and displayed, use the [comparison tool](../../webapp/webapp_exp_comparing.md) to find the best configuration!
@ -152,7 +153,8 @@ Once everything is neatly logged and displayed, use the [comparison tool](../../
The experiments table is a powerful tool for creating dashboards and views of your own projects, your team's projects, or the entire development.
![Experiments table](../../img/webapp_experiment_table.png)
![Experiments table](../../img/webapp_experiment_table.png#light-mode-only)
![Experiments table](../../img/webapp_experiment_table_dark.png#dark-mode-only)
### Creating Leaderboards

View File

@ -120,7 +120,8 @@ GUI applications
- Build [pipelines](../pipelines/pipelines.md) from code
- Much more!
![Webapp gif](../img/gif/webapp_screenshots.gif)
![Webapp gif](../img/gif/webapp_screenshots.gif#light-mode-only)
![Webapp gif](../img/gif/webapp_screenshots_dark.gif#dark-mode-only)
## Who We Are
ClearML is supported by you :heart: and the [clear.ml](https://clear.ml) team, which helps enterprise companies build scalable MLOps/LLMOps.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 121 KiB

After

Width:  |  Height:  |  Size: 186 KiB

BIN
docs/img/4100_dark.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 210 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 146 KiB

After

Width:  |  Height:  |  Size: 204 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 204 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 158 KiB

After

Width:  |  Height:  |  Size: 160 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 260 KiB

After

Width:  |  Height:  |  Size: 273 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 299 KiB

BIN
docs/img/apps_gradio.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 181 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 214 KiB

After

Width:  |  Height:  |  Size: 169 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 146 KiB

After

Width:  |  Height:  |  Size: 178 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 182 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 183 KiB

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 180 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 194 KiB

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 190 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 164 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 164 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 198 KiB

After

Width:  |  Height:  |  Size: 168 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 170 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 147 KiB

After

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 179 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 131 KiB

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 401 KiB

After

Width:  |  Height:  |  Size: 529 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 413 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

After

Width:  |  Height:  |  Size: 184 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 241 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 310 KiB

After

Width:  |  Height:  |  Size: 503 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 406 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 MiB

After

Width:  |  Height:  |  Size: 3.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 153 KiB

After

Width:  |  Height:  |  Size: 198 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 198 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 131 KiB

After

Width:  |  Height:  |  Size: 190 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 191 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 208 KiB

After

Width:  |  Height:  |  Size: 260 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 264 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 69 KiB

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.4 KiB

After

Width:  |  Height:  |  Size: 5.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Some files were not shown because too many files have changed in this diff Show More