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 docs (#744)

Browse Source
This commit is contained in:
pollfly
2024-01-01 21:22:09 +02:00
committed by GitHub
parent 9ce5e955c7
commit e636e07785
7 changed files with 46 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/webapp/webapp_exp_table.md
View File

@@ -6,11 +6,15 @@ The experiments table is a [customizable](#customizing-the-experiments-table) li
table, view experiment details, and work with experiments (reset, clone, enqueue, create [tracking leaderboards](../guides/ui/building_leader_board.md)
to monitor experimentation, and more). The experiments table's auto-refresh lets users continually monitor experiment progress.
View the experiments table in table view <img src="/docs/latest/icons/ico-table-view.svg" alt="Table view" className="icon size-md space-sm" />
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
View the experiments in table view <img src="/docs/latest/icons/ico-table-view.svg" alt="Table view" className="icon size-md space-sm" />,
details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />, or
comparison view <img src="/docs/latest/icons/ico-charts-view.svg" alt="Comparison view" className="icon size-md space-sm" />
using the buttons on the top left of the page. Use the table view for a comparative view of your experiments according
to columns of interest. Use the details view to access a selected experiment's details, while keeping the experiment list
in view. Details view can also be accessed by double-clicking a specific experiment in the table view to open its details view.
Use the [comparison view](#comparing-experiments) to compare your experiments' scalar and plot results (for a more in
depth comparison, see [Comparing Experiments](webapp_exp_comparing.md)). When selected, this view presents a comparison
of all selected experiments. If no experiments are selected, all currently visible experiments in the table are compared.
You can archive experiments so the experiments table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
table to open the archive and view all archived experiments. From the archive, you can restore
@@ -188,6 +192,37 @@ selecting items beyond the items currently on-screen:
* **None** - Clear selection
* **Filtered** - Select **all experiments in the project** that match the current active filters in the project
## Comparing Experiments
The comparison view compares experiment scalar and plot results (for a more in depth comparison, see [Comparing Experiments](webapp_exp_comparing.md)).
When selected, the view presents a comparison of all [selected experiments](#selecting-multiple-experiments). If no
experiments are selected, all currently visible experiments in the table are displayed in the comparison.
In the dropdown menu, select to view **Scalars** or **Plots**. **Scalars** shows experiments' scalar results as time
series line graphs. **Plots** shows the last reported iteration sample of each metric/variant combination per compared
experiment.
Line, scatter, and bar graphs are compared by overlaying each metric/variant from all compared experiments' into a
single comparative plot.
![Merged comparison plots](../img/webapp_compare_view_1.png)
Other plot types are displayed separately for each experiment.
![Separate comparison plots](../img/webapp_compare_view_2.png)
All single value scalars are plotted into a single clustered bar chart under the "Summary" title, where each cluster
represents a reported metric, and each bar in the cluster represents an experiment.
![Single scalar comparison](../img/webapp_compare_view_3.png)
Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> to customize which
metrics to view.
In the **Scalars** view, click <img src="/docs/latest/icons/ico-tune.svg" alt="Tune" className="icon size-md" /> to access
scalar plot tools (see [here](webapp_exp_track_visual.md#scalar-plot-tools)).
## Creating an Experiment Leaderboard
Filter and sort the experiments of any project to create a leaderboard that can be shared and stored. This leaderboard

6
docs/webapp/webapp_exp_track_visual.md
View File

@@ -80,6 +80,12 @@ The Installed Packages section lists the experiment's installed Python packages
![Installed packages section](../img/webapp_exp_installed_packages.png)
When a ClearML agent executing an experiment ends up using a different set of python packages than was originally
specified, both the original specification (`original pip` or `original conda`), and the packages the agent ended up
using to set up an environment (`pip` or `conda`) are available. Select which requirements to view in the dropdown menu.
![Packages used by agent](../img/webapp_exp_installed_packages_2.png.png)
### Container
The Container section list the following information:
* Image - a pre-configured Docker that ClearML Agent will use to remotely execute this experiment (see [Building Docker containers](../clearml_agent.md#exporting-a-task-into-a-standalone-docker-container))