mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Change headings to title caps (#62)
This commit is contained in:
@@ -25,7 +25,7 @@ The **ClearML Web UI** provides a deep experiment comparison, allowing to locate
|
||||
|
||||
The **ClearML** experiment comparison provides [comparison features](#comparison-features) making it easy to compare experiments.
|
||||
|
||||
## Selecting experiments to compare
|
||||
## Selecting Experiments to Compare
|
||||
|
||||
**To select experiments to compare:**
|
||||
|
||||
@@ -45,7 +45,7 @@ The **DETAILS** tab includes deep comparisons of the following:
|
||||
* Output model and model design.
|
||||
* Other artifacts, if any.
|
||||
|
||||
### Execution details
|
||||
### Execution Details
|
||||
* The Source code - repository, branch, commit ID, script file name, and working directory.
|
||||
* Uncommitted changes, sorted by file name.
|
||||
* Installed Python packages and versions, sorted by package name.
|
||||
@@ -55,7 +55,7 @@ The **DETAILS** tab includes deep comparisons of the following:
|
||||
sorted by sections.
|
||||
|
||||
|
||||
### To locate the source differences:
|
||||
### To Locate the Source Differences:
|
||||
|
||||
* Click the **DETAILS** tab **>** Expand highlighted sections, or, in the header, click <img src="/docs/latest/icons/ico-previous-diff.svg" alt="Previous diff" className="icon size-md" />
|
||||
(Previous diff) or <img src="/docs/latest/icons/ico-next-diff.svg" alt="next difference" className="icon size-md space-sm" /> (Next diff).
|
||||
@@ -71,7 +71,7 @@ and name are different.
|
||||
|
||||
Compare hyperparameters as values, or compare by metric (hyperparameter parallel coordinate comparison).
|
||||
|
||||
### Values mode
|
||||
### Values Mode
|
||||
|
||||
The Values mode is a side-by-side comparison that shows hyperparameter value differences highlighted line-by-line.
|
||||
|
||||
@@ -89,7 +89,7 @@ For example, expanding **General** shows that the `batch_size` and `epochs` diff
|
||||
|
||||

|
||||
|
||||
### Parallel Coordinates mode
|
||||
### Parallel Coordinates Mode
|
||||
|
||||
In the Parallel Coordinates mode, compare a metric to any combination of hyperparameters using a parallel coordinates plot.
|
||||
|
||||
@@ -120,7 +120,7 @@ Hover over one of the experiment names in the legend, and the plot shows only th
|
||||
|
||||
Visualize the comparison of scalars, which includes metrics and monitored resources in the **SCALARS** tab.
|
||||
|
||||
### Compare specific values
|
||||
### Compare Specific Values
|
||||
|
||||
**To compare specific values:**
|
||||
|
||||
@@ -133,7 +133,7 @@ Visualize the comparison of scalars, which includes metrics and monitored resour
|
||||
|
||||

|
||||
|
||||
### Compare scalar series
|
||||
### Compare Scalar Series
|
||||
|
||||
Compare scalar series in plots and analyze differences using **ClearML Web UI** plot tools.
|
||||
|
||||
@@ -187,7 +187,7 @@ in the **PLOTS** tab.
|
||||
|
||||
|
||||
|
||||
## Debug samples
|
||||
## Debug Samples
|
||||
|
||||
Compare debug samples at any iteration to verify that an experiment is running as expected. The most recent iteration appears
|
||||
first. Use the viewer / player to inspect images, audio, video samples and do any of the following:
|
||||
@@ -226,7 +226,7 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
|
||||
* Zoom
|
||||
* For images, locate a position on the sample - Hover over the sample and the X, Y coordinates appear in the legend below the sample.
|
||||
|
||||
## Comparison features
|
||||
## Comparison Features
|
||||
|
||||
To assist in experiment analysis, the comparison page supports:
|
||||
|
||||
@@ -241,7 +241,7 @@ To assist in experiment analysis, the comparison page supports:
|
||||
|
||||
|
||||
|
||||
### Adding experiments to the comparison
|
||||
### Adding Experiments to the Comparison
|
||||
|
||||
Add an experiment to the comparison - Click **Add Experiment** and start typing an experiment name. An experiment search
|
||||
and select dialog appears showing matching experiments to choose from. To add an experiment, click **+**. To Remove
|
||||
@@ -251,26 +251,26 @@ an experiment, click <img src="/docs/latest/icons/ico-trash.svg" alt="Trash" cla
|
||||
|
||||
|
||||
|
||||
### Finding the next or previous difference
|
||||
### Finding the Next or Previous Difference
|
||||
|
||||
* Find the previous difference <img src="/docs/latest/icons/ico-previous-diff.svg" className="icon size-md space-sm" />, or
|
||||
the next difference <img src="/docs/latest/icons/ico-next-diff.svg" className="icon size-md space-sm" />.
|
||||
|
||||
|
||||
|
||||
### Hiding identical fields
|
||||
### Hiding Identical Fields
|
||||
|
||||
Move the **Hide Identical Fields** slider to "on" mode to see only fields that are different.
|
||||
|
||||
|
||||
|
||||
### Searching all text
|
||||
### Searching All Text
|
||||
|
||||
Search all text in the comparison.
|
||||
|
||||
|
||||
|
||||
### Choosing a different base experiment
|
||||
### Choosing a Different Base Experiment
|
||||
|
||||
Show differences in other experiments in reference to a new base experiment. To set a new base experiment, do one of the following:
|
||||
* Click on <img src="/docs/latest/icons/ico-switch-base.svg" className="icon size-md space-sm" /> on the top right of the experiment that will be the new base.
|
||||
@@ -280,20 +280,20 @@ Show differences in other experiments in reference to a new base experiment. To
|
||||
|
||||
|
||||
|
||||
### Dynamic ordering of the compared experiments
|
||||
### Dynamic Ordering of the Compared Experiments
|
||||
|
||||
To reorder the experiments being compared, press <img src="/docs/latest/icons/ico-pan.svg" className="icon size-md space-sm" /> on the top right of the experiment that
|
||||
needs to be moved, and drag the experiment to its new position.
|
||||
|
||||

|
||||
|
||||
### Removing an experiment from the comparison
|
||||
### Removing an Experiment from the Comparison
|
||||
Remove an experiment from the comparison, by pressing <img src="/docs/latest/icons/ico-remove-compare.svg" className="icon size-md space-sm" />
|
||||
on the top right of the experiment that needs to be removed.
|
||||
|
||||

|
||||
|
||||
### Sharing experiments
|
||||
### Sharing Experiments
|
||||
|
||||
To share a comparison table, copy the full URL from the address bar and send it to a teammate to collaborate. They will
|
||||
get the exact same page (including selected tabs etc.).
|
||||
|
||||
Reference in New Issue
Block a user