mirror of
https://github.com/clearml/clearml-docs
synced 2025-03-09 13:42:26 +00:00
Update docs (#744)
This commit is contained in:
parent
9ce5e955c7
commit
e636e07785
BIN
docs/img/webapp_compare_view_1.png
Normal file
BIN
docs/img/webapp_compare_view_1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 333 KiB |
BIN
docs/img/webapp_compare_view_2.png
Normal file
BIN
docs/img/webapp_compare_view_2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 252 KiB |
BIN
docs/img/webapp_compare_view_3.png
Normal file
BIN
docs/img/webapp_compare_view_3.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 153 KiB |
BIN
docs/img/webapp_exp_installed_packages_2.png.png
Normal file
BIN
docs/img/webapp_exp_installed_packages_2.png.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 17 KiB |
@ -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.
|
||||
|
||||

|
||||
|
||||
Other plot types are displayed separately for each experiment.
|
||||
|
||||

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

|
||||
|
||||
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
|
||||
|
@ -80,6 +80,12 @@ The Installed Packages section lists the experiment's installed Python packages
|
||||
|
||||

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

|
||||
|
||||
### 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))
|
||||
|
3
static/icons/ico-charts-view.svg
Normal file
3
static/icons/ico-charts-view.svg
Normal file
@ -0,0 +1,3 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="m22,19c0,.55-.45,1-1,1H4c-1.1,0-2-.9-2-2V5c0-.55.45-1,1-1s1,.45,1,1v13h17c.55,0,1,.45,1,1Zm-12.71-3.29c.19.19.44.29.71.29.06,0,.12,0,.18-.02.32-.06.6-.28.73-.58l3.04-6.83,1.12,2.8c.15.38.52.63.93.63h5c.55,0,1-.45,1-1s-.45-1-1-1h-4.32l-1.75-4.37c-.15-.37-.51-.62-.91-.63-.41,0-.77.23-.93.59l-3.41,7.67-1.97-1.97c-.39-.39-1.02-.39-1.41,0s-.39,1.02,0,1.41l3,3Z" fill="#8492c2"/>
|
||||
</svg>
|
After Width: | Height: | Size: 454 B |
Loading…
Reference in New Issue
Block a user