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:
pollfly
GitHub
@@ -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.).
|
||||
|
||||
@@ -14,7 +14,7 @@ them.
|
||||
When a user opens the hyperlink for a shared experiment in their browser, only that experiment appears in the experiment table.
|
||||
:::
|
||||
|
||||
## Sharing experiments
|
||||
## Sharing Experiments
|
||||
|
||||
Share experiments from the experiments table, the info panel menu, and/or the full screen details menu.
|
||||
|
||||
@@ -30,7 +30,7 @@ Share experiments from the experiments table, the info panel menu, and/or the fu
|
||||
|
||||
1. Copy the hyperlink and send it to a **ClearML Hosted Service** user of another workspace.
|
||||
|
||||
## Making shared experiment private
|
||||
## Making Shared Experiment Private
|
||||
|
||||
**To make a shared experiment private again:**
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ including:
|
||||
* [Plots](#other-plots) - Other plots and data, for example: Matplotlib, Plotly, and **ClearML** explicit reporting.
|
||||
* [Debug samples](#debug-samples) - Images, audio, video, and HTML.
|
||||
|
||||
## Viewing modes
|
||||
## Viewing Modes
|
||||
|
||||
The **ClearML Web UI** provides two viewing modes for experiment details:
|
||||
|
||||
@@ -27,7 +27,7 @@ Both modes contain all experiment details. When either view is open, switch to t
|
||||
table / full screen**.
|
||||
|
||||
|
||||
### Info panel
|
||||
### Info Panel
|
||||
|
||||
The info panel keeps the experiment table in view so that [experiment actions](webapp_exp_table#clearml-actions-from-the-experiments-table)
|
||||
can be performed from the table (as well as the menu in the info panel).
|
||||
@@ -41,7 +41,7 @@ can be performed from the table (as well as the menu in the info panel).
|
||||
</div>
|
||||
</details>
|
||||
|
||||
### Full screen details view
|
||||
### Full Screen Details View
|
||||
|
||||
The full screen details view allows for easier viewing and working with experiment tracking and results. The experiments
|
||||
table is not visible when the full screen details view is open. Perform experiment actions from the menu.
|
||||
@@ -56,7 +56,7 @@ table is not visible when the full screen details view is open. Perform experime
|
||||
</details>
|
||||
|
||||
|
||||
## Execution details
|
||||
## Execution Details
|
||||
In the EXECUTION tab of an experiment's detail page, there are records of:
|
||||
* Source code
|
||||
* **ClearML Agent** configuration
|
||||
@@ -65,7 +65,7 @@ In the EXECUTION tab of an experiment's detail page, there are records of:
|
||||
* Installed Python packages
|
||||
|
||||
|
||||
### Source code, ClearML Agent configuration, and output details
|
||||
### Source Code, ClearML Agent Configuration, and Output Details
|
||||
|
||||
The source code details of the EXECUTION tab of an experiment include:
|
||||
* The experiment's repository
|
||||
@@ -94,7 +94,7 @@ The output details include:
|
||||
</details>
|
||||
|
||||
|
||||
### Uncommitted changes
|
||||
### Uncommitted Changes
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
|
||||
@@ -106,7 +106,7 @@ The output details include:
|
||||
</details>
|
||||
|
||||
|
||||
### Installed Python packages and their versions
|
||||
### Installed Python packages and Their Versions
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
|
||||
<div className="cml-expansion-panel-content">
|
||||
@@ -129,7 +129,7 @@ In older versions of **ClearML Server**, the **CONFIGURATION** tab was named **H
|
||||
|
||||
Hyperparameters are grouped by their type and appear in **CONFIGURATION** **>** **HYPER PARAMETERS**.
|
||||
|
||||
#### Command line arguments
|
||||
#### Command Line Arguments
|
||||
|
||||
The **Args** parameter group shows automatically logged `argparse` arguments, and all older experiments parameters, except TensorFlow Definitions. Hover over a parameter, and the type, description, and default value appear, if they were provided.
|
||||
|
||||
@@ -143,7 +143,7 @@ The **Args** parameter group shows automatically logged `argparse` arguments, an
|
||||
</details>
|
||||
|
||||
|
||||
#### Environment variables
|
||||
#### Environment Variables
|
||||
|
||||
If the `CLEARML_LOG_ENVIRONMENT` variable was set, the **Environment** group will show environment variables (see [this FAQ](../faq#track-env-vars)).
|
||||
|
||||
@@ -157,7 +157,7 @@ If the `CLEARML_LOG_ENVIRONMENT` variable was set, the **Environment** group wil
|
||||
</details>
|
||||
|
||||
|
||||
#### Custom parameter groups
|
||||
#### Custom Parameter Groups
|
||||
|
||||
Custom parameter groups show parameter dictionaries if the parameters were connected to the Task, using the `Task.connect` method,
|
||||
with a `name` argument provided.
|
||||
@@ -186,7 +186,7 @@ The **TF_DEFINE** parameter group shows automatic TensorFlow logging.
|
||||
|
||||
Once an experiment is run and stored in **ClearML Server**, any of these hyperparameters can be [modified](webapp_exp_tuning.md#modifying-experiments).
|
||||
|
||||
### User properties
|
||||
### User Properties
|
||||
|
||||
User properties allow to store any descriptive information in a key-value pair format. They are editable in any experiment,
|
||||
except experiments whose status is *Published* (read-only).
|
||||
@@ -201,7 +201,7 @@ except experiments whose status is *Published* (read-only).
|
||||
</details>
|
||||
|
||||
|
||||
### Configuration objects
|
||||
### Configuration Objects
|
||||
|
||||
**ClearML** tracks experiment (Task) model configuration objects, which appear in **Configuration Objects** **>** **General**.
|
||||
These objects include those that are automatically tracked, and those connected to a Task in code (see [Task.connect_configuration](../references/sdk/task.md#connect_configuration)).
|
||||
@@ -266,7 +266,7 @@ including design, label enumeration, and general information, go to the **MODELS
|
||||
</details>
|
||||
|
||||
|
||||
### Other artifacts
|
||||
### Other Artifacts
|
||||
|
||||
**To retrieve another artifact:**
|
||||
|
||||
@@ -276,7 +276,7 @@ including design, label enumeration, and general information, go to the **MODELS
|
||||
* Copy its location to the clipboard <img src="/docs/latest/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md space-sm" />,
|
||||
if it is in a local file.
|
||||
|
||||
#### Data audit
|
||||
#### Data Audit
|
||||
|
||||
Artifacts which are uploaded and dynamically tracked by **ClearML** appear in the **DATA AUDIT** section. They include the file path, file size, hash, and metadata stored with the artifact.
|
||||
|
||||
@@ -306,7 +306,7 @@ Other artifacts, which are uploaded but not dynamically tracked after the upload
|
||||
|
||||
|
||||
|
||||
## General information
|
||||
## General Information
|
||||
|
||||
General experiment details appear in the **INFO** tab. This includes information describing the stored experiment:
|
||||
* The parent experiment
|
||||
@@ -339,7 +339,7 @@ General experiment details appear in the **INFO** tab. This includes information
|
||||
|
||||
|
||||
|
||||
## Experiment results
|
||||
## Experiment Results
|
||||
|
||||
|
||||
|
||||
@@ -364,7 +364,7 @@ is downloadable. To view the end of the log, click **Jump to end**.
|
||||
|
||||
All scalars that **ClearML** automatically logs, as well as those explicitly reported in code, appear in **RESULTS** **>** **SCALARS**.
|
||||
|
||||
#### Scalar plot tools
|
||||
#### Scalar Plot Tools
|
||||
|
||||
Use the scalar tools to improve analysis of scalar metrics. In the info panel, click <img src="/docs/latest/icons/ico-settings.svg" className="icon size-md space-sm" /> to use the tools. In the full screen details view, the tools
|
||||
are on the left side of the window. The tools include:
|
||||
@@ -417,7 +417,7 @@ Individual plots can be shown / hidden or filtered by title.
|
||||
</details>
|
||||
|
||||
|
||||
#### Plot controls
|
||||
#### Plot Controls
|
||||
|
||||
The table below lists the plot controls which may be available for any plot (in the **SCALARS** and **PLOTS** tabs).
|
||||
These controls allow you to better analyze the results. Hover over a plot, and the controls appear.
|
||||
@@ -441,7 +441,7 @@ These controls allow you to better analyze the results. Hover over a plot, and t
|
||||
| <img src="/docs/latest/icons/ico-download-json.svg" alt="Download JSON icon" className="icon size-sm space-sm" /> | To get metric data for further analysis, download plot data to JSON file. |
|
||||
| <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" /> | Expand plot to entire window. |
|
||||
|
||||
#### 3D plot controls
|
||||
#### 3D Plot Controls
|
||||
|Icon|Description|
|
||||
|---|---|
|
||||
| <img src="/docs/latest/icons/ico-orbital-rotation.svg" alt="Orbital rotation mode icon" className="icon size-sm" />| Switch to orbital rotation mode - rotate the plot around its middle point. |
|
||||
@@ -449,7 +449,7 @@ These controls allow you to better analyze the results. Hover over a plot, and t
|
||||
| <img src="/docs/latest/icons/ico-homepage.svg" alt="reset axes icon" className="icon size-sm" />| Reset axes to default position. |
|
||||
|
||||
|
||||
### Debug samples
|
||||
### Debug Samples
|
||||
|
||||
View debug samples by metric at any iteration. The most recent iteration appears first. Use the viewer / player to inspect images, audio, video samples and do any of the following:
|
||||
|
||||
@@ -501,7 +501,7 @@ View debug samples by metric at any iteration. The most recent iteration appears
|
||||
* For images, locate a position on the sample - Hover over the sample and the X, Y coordinates appear in the legend below the sample.
|
||||
|
||||
|
||||
## Tagging experiments
|
||||
## Tagging Experiments
|
||||
|
||||
Tags are user-defined, color-coded labels that can be added to experiments (and models), allowing to easily identify and
|
||||
group experiments. Tags can show any text. For example, add tags for the type of remote machine experiments were executed
|
||||
@@ -518,6 +518,6 @@ on, label versions of experiments, or apply team names to organize experimentati
|
||||
|
||||
|
||||
|
||||
## Locating the experiment (Task) ID
|
||||
## Locating the Experiment (Task) ID
|
||||
|
||||
* In the info panel, in the top area, to the right of the Task name, click **ID**. The Task ID appears.
|
||||
|
||||
@@ -4,7 +4,7 @@ title: Tuning experiments
|
||||
|
||||
Tune experiments and edit an experiment's execution details, then execute the tuned experiments on local or remote machines.
|
||||
|
||||
## To tune an experiment and execute it remotely:
|
||||
## To Tune an Experiment and Execute it Remotely:
|
||||
|
||||
1. Locate the experiment. Open the experiment's Project page from the Home page or the main Projects page.
|
||||
|
||||
@@ -32,7 +32,7 @@ Tune experiments and edit an experiment's execution details, then execute the tu
|
||||
The experiment's status becomes *Pending*. When the worker assigned to the queue fetches the Task (experiment), the
|
||||
status becomes *Running*. The experiment can now be tracked and its results visualized.
|
||||
|
||||
## Modifying experiments
|
||||
## Modifying Experiments
|
||||
|
||||
Experiments whose status is *Draft* are editable (see the [user properties](#user-properties) exception). In the **ClearML
|
||||
Web UI**, edit any of the following
|
||||
@@ -51,11 +51,11 @@ User parameters are editable in any experiment, except experiments whose status
|
||||
* [Initial weight input model](#initial-weights-input-model)
|
||||
* [Output destination for artifacts storage](#output-destination)
|
||||
|
||||
### Execution details
|
||||
### Execution Details
|
||||
|
||||
|
||||
|
||||
#### Source code
|
||||
#### Source Code
|
||||
|
||||
Select source code by changing any of the following:
|
||||
|
||||
@@ -70,7 +70,7 @@ Select source code by changing any of the following:
|
||||
|
||||
|
||||
|
||||
#### Base Docker image
|
||||
#### Base Docker Image
|
||||
Select a pre-configured Docker that **ClearML Agent** will use to remotely execute this experiment (see [Building Docker containers](../clearml_agent.md#building-docker-containers)).
|
||||
|
||||
**To add, change, or delete a base Docker image:**
|
||||
@@ -80,7 +80,7 @@ Select a pre-configured Docker that **ClearML Agent** will use to remotely execu
|
||||
|
||||
|
||||
|
||||
#### Output destination
|
||||
#### Output Destination
|
||||
|
||||
Set an output destination for model checkpoints (snapshots) and other artifacts. Examples of supported types of destinations
|
||||
and formats for specifying locations include:
|
||||
@@ -102,7 +102,7 @@ method), and in the **ClearML** configuration file for all experiments (see [def
|
||||
on the **ClearML** Configuration Reference page).
|
||||
:::
|
||||
|
||||
#### Log level
|
||||
#### Log Level
|
||||
|
||||
Set a logging level for the experiment (see the standard Python [logging levels](https://docs.python.org/3/howto/logging.html#logging-levels)).
|
||||
|
||||
@@ -142,7 +142,7 @@ Add, change, or delete hyperparameters, which are organized in the **ClearML Web
|
||||
|
||||
|
||||
|
||||
#### User properties
|
||||
#### User Properties
|
||||
|
||||
User properties allow storing any descriptive information in key-value pair format. They are editable in any experiment,
|
||||
except experiments whose status is *Published* (read-only).
|
||||
@@ -154,7 +154,7 @@ except experiments whose status is *Published* (read-only).
|
||||
|
||||
|
||||
|
||||
#### Configuration objects
|
||||
#### Configuration Objects
|
||||
|
||||
:::important
|
||||
In older versions of **ClearML Server**, the Task model configuration appeared in the **ARTIFACTS** tab **>** **MODEL
|
||||
@@ -168,7 +168,7 @@ CONFIGURATION** section. Task model configurations now appear in **CONFIGURATION
|
||||
|
||||
### Artifacts
|
||||
|
||||
### Initial weights input model
|
||||
### Initial Weights Input Model
|
||||
|
||||
Edit model configuration and label enumeration, choose a different initial input weight model for the same project or any
|
||||
other project, or remove the model.
|
||||
|
||||
@@ -7,7 +7,7 @@ view model details, and modify, publish, archive, tag, and move models to other
|
||||
|
||||
|
||||
|
||||
## Models table columns
|
||||
## Models Table Columns
|
||||
|
||||
The models table contains the following columns:
|
||||
|
||||
@@ -25,7 +25,7 @@ The models table contains the following columns:
|
||||
|
||||
|
||||
|
||||
## Customizing the models table
|
||||
## Customizing the Models Table
|
||||
|
||||
The models table is customizable. Changes are persistent (cached in the browser) and represented in the URL, so customized settings
|
||||
can be saved in a browser bookmark and shared with other **ClearML** users to collaborate.
|
||||
@@ -51,7 +51,7 @@ If a project has sub-projects, the models can be viewed by their sub-project gro
|
||||
all the models in the project. The customizations of these two views are saved separately.
|
||||
:::
|
||||
|
||||
## Model actions
|
||||
## Model Actions
|
||||
|
||||
The following table describes the actions that can be done from the models table, including the states that
|
||||
allow each feature. Model states are *Draft* (editable) and *Published* (read-only).
|
||||
@@ -75,7 +75,7 @@ The same information can be found in the bottom menu, in a tooltip that appears
|
||||
|
||||
|
||||
|
||||
## Tagging models
|
||||
## Tagging Models
|
||||
|
||||
Tags are user-defined, color-coded labels that can be added to models (and experiments), allowing to easily identify and
|
||||
group of experiments. A tag can show any text, for any purpose. For example, add tags for the type of remote machine
|
||||
|
||||
@@ -9,7 +9,7 @@ meaning that it's the first thing that is seen when opening the project.
|
||||
|
||||
|
||||
|
||||
## Metric snapshot
|
||||
## Metric Snapshot
|
||||
|
||||
On the top of the **OVERVIEW** tab, there is an option to display a **metric snapshot**. Choose a metric and variant,
|
||||
and then the window will present an aggregated view of the value for that metric and the time that each
|
||||
@@ -20,14 +20,14 @@ on their status (`Completed`, `Aborted`, `Published`, or `Failed`). Hover over a
|
||||
appear with the details of the experiment associated with the metric value. Click the point, and you will
|
||||
be sent to the experiment's page.
|
||||
|
||||
## Project description
|
||||
## Project Description
|
||||
|
||||
Every project has a `description` field. The UI provides a Markdown editor to edit this field.
|
||||
|
||||
In the Markdown document, you can write and share reports and add links to **ClearML** experiments
|
||||
or any network resource such as issue tracker, web repository, etc.
|
||||
|
||||
### Editing the description
|
||||
### Editing the Description
|
||||
|
||||
To edit the description in the **OVERVIEW** tab, hover over the description section, and press the **EDIT** button that
|
||||
appears on the top right of the window.
|
||||
|
||||
Reference in New Issue
Block a user