Add tagging experiments info (#673)

* Small edits

* small edits

* small edits

* small edits

* small edits

* update GCP image

* Add 1.12.0 amis

* edit

* Add SDK 1.12.1 release notes

* update GCP image

* add clearml release notes 1.12

* Small edits

* pipeline remote execution

* add backup and restore note

* Revert "pipeline remote execution"

This reverts commit 789f07eb29.

* edits

* Add `--interactive` flag to clearml-session

* tagging experiments

* tagging experiments
This commit is contained in:
pollfly 2023-09-20 15:23:39 +03:00 committed by GitHub
parent c899c114b6
commit c8dcf50796
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -372,17 +372,36 @@ buttons (or using the left/right arrow keyboard shortcut).
## 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
on, label versions of experiments, or apply team names to organize experimentation.
<div class="vid" >
<iframe style={{position: 'absolute', top: '0', left: '0', bottom: '0', right: '0', width: '100%', height: '100%'}}
src="https://www.youtube.com/embed/uqik38jlBsQ?si=joU-KOPpUNLbn6Ws"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; fullscreen"
allowfullscreen>
</iframe>
</div>
* To add tags and change tag colors:
1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu)
1. Do one of the following:
<br/>
Tags are user-defined, color-coded labels that can be added to experiments (and pipelines, datasets, and models),
allowing to easily identify and group experiments. Tags can help in organizing, querying, and automating experiments.
For example, tag experiments by the machine type used to execute them, label versions, team names, or any other
category.
You can use tags to filter your experiments in your experiment table (see [Filtering Columns](webapp_exp_table.md#filtering-columns))
or when querying experiments in your code (see [Tag Filters](../clearml_sdk/task_sdk.md#tag-filters)). You can trigger
experiment execution according to their tags (see [TriggerScheduler](../references/sdk/trigger.md)) or automatically
deploy models according to their tags (see [ClearML Serving](../clearml_serving/clearml_serving_tutorial.md#automatic-model-deployment)).
**To add tags:**
1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu)
1. Do one of the following:
* Add a new tag - Type the new tag name **>** **(Create New)**.
* Add an existing tag - Click a tag.
* Change a tag's colors - Click **Tag Colors** **>** Click the tag icon **>** **Background** or **Foreground** **>** Pick a color **>** **OK** **>** **CLOSE**.
* To remove a tag - Hover over the tag **>** **X**.
* Customize a tag's colors - Click **Tag Colors** **>** Click the tag icon **>** **Background** or **Foreground** **>** Pick a color **>** **OK** **>** **CLOSE**.
**To remove a tag** - Hover over the tag and click **X**.