mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Fix icons
This commit is contained in:
allegroai
@@ -8,43 +8,43 @@ Tune experiments and edit an experiment's execution details, then execute the tu
|
||||
|
||||
1. Locate the experiment. Open the experiment's Project page from the Home page or the main Projects page.
|
||||
|
||||
* On the Home page,
|
||||
* On the Home page,
|
||||
* Click on an experiment from RECENT EXPERIMENTS
|
||||
* In RECENT PROJECTS **>** click on a project card **>** click experiment
|
||||
* In RECENT PROJECTS **>** click **VIEW ALL** **>** click the project card **>** click experiment
|
||||
* On the Projects page, click project card, or the **All projects** card **>** click experiment
|
||||
|
||||
|
||||
1. Clone the experiment. In the experiments table:
|
||||
|
||||
1. Click **Clone**, and a **Clone experiment** box will pop up.
|
||||
1. In the **Project** textbox, select or create a project. To search for another project, start typing the project name.
|
||||
1. Click **Clone**, and a **Clone experiment** box will pop up.
|
||||
1. In the **Project** textbox, select or create a project. To search for another project, start typing the project name.
|
||||
To create a new project, type new experiment name and click **Create New**.
|
||||
1. Enter an optional description.
|
||||
1. Click **CLONE**.
|
||||
|
||||
The cloned experiment's status is now *Draft*.
|
||||
|
||||
1. Edit the experiment. See [modifying experiments](#modifying-experiments).
|
||||
|
||||
1. Enqueue the experiment for execution. Right click the experiment **>** **Enqueue** **>** Select a queue **>**
|
||||
**ENQUEUE**.
|
||||
|
||||
The experiment's status becomes *Pending*. When the worker assigned to the queue fetches the Task (experiment), the
|
||||
1. Edit the experiment. See [modifying experiments](#modifying-experiments).
|
||||
|
||||
1. Enqueue the experiment for execution. Right click the experiment **>** **Enqueue** **>** Select a queue **>**
|
||||
**ENQUEUE**.
|
||||
|
||||
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
|
||||
|
||||
Experiments whose status is *Draft* are editable (see the [user properties](#user-properties) exception). In the **ClearML
|
||||
Experiments whose status is *Draft* are editable (see the [user properties](#user-properties) exception). In the **ClearML
|
||||
Web UI**, edit any of the following
|
||||
|
||||
* [Source code](#source-code)
|
||||
* [Output destination for artifacts](#output-destination)
|
||||
* [Output destination for artifacts](#output-destination)
|
||||
* [Base Docker image](#base-docker-image)
|
||||
* [Log level](#log-level)
|
||||
* [Hyperparameters](#hyperparameters) - Parameters, TensorFlow Definitions, command line options, environment variables, and user-defined properties
|
||||
|
||||
:::note
|
||||
User parameters are editable in any experiment, except experiments whose status is *Published* (read-only).
|
||||
User parameters are editable in any experiment, except experiments whose status is *Published* (read-only).
|
||||
:::
|
||||
|
||||
* [Configuration objects](#configuration-objects) - Task model description
|
||||
@@ -57,7 +57,7 @@ User parameters are editable in any experiment, except experiments whose status
|
||||
|
||||
#### Source code
|
||||
|
||||
Select source code by changing any of the following:
|
||||
Select source code by changing any of the following:
|
||||
|
||||
* Repository, commit (select by ID, tag name, or choose the last commit in the branch), script, and /or working directory.
|
||||
* Installed Python packages and / or versions - Edit or clear (remove) them all.
|
||||
@@ -65,7 +65,7 @@ Select source code by changing any of the following:
|
||||
|
||||
**To select different source code:**
|
||||
|
||||
* In the **EXECUTION** tab, hover over a section **>** **EDIT** or (**DISCARD DIFFS** for **UNCOMMITTED CHANGES**) **>**
|
||||
* In the **EXECUTION** tab, hover over a section **>** **EDIT** or (**DISCARD DIFFS** for **UNCOMMITTED CHANGES**) **>**
|
||||
edit **>** **SAVE**.
|
||||
|
||||
|
||||
@@ -75,14 +75,14 @@ Select a pre-configured Docker that **ClearML Agent** will use to remotely execu
|
||||
|
||||
**To add, change, or delete a base Docker image:**
|
||||
|
||||
* In **EXECUTION** **>** **AGENT CONFIGURATION** **>** **BASE DOCKER IMAGE** **>** hover **>** **EDIT** **>**
|
||||
* In **EXECUTION** **>** **AGENT CONFIGURATION** **>** **BASE DOCKER IMAGE** **>** hover **>** **EDIT** **>**
|
||||
Enter the base Docker image.
|
||||
|
||||
|
||||
|
||||
#### Output destination
|
||||
|
||||
Set an output destination for model checkpoints (snapshots) and other artifacts. Examples of supported types of destinations
|
||||
Set an output destination for model checkpoints (snapshots) and other artifacts. Examples of supported types of destinations
|
||||
and formats for specifying locations include:
|
||||
|
||||
* A shared folder: `/mnt/share/folder`
|
||||
@@ -91,20 +91,20 @@ and formats for specifying locations include:
|
||||
* Azure Storage: `azure://company.blob.core.windows.net/folder/`
|
||||
|
||||
**To add, change, or delete an artifact output destination:**
|
||||
|
||||
* In **EXECUTION** **>** **OUTPUT** > **DESTINATION** **>** hover **>** **EDIT** **>** edit **>** **SAVE**.
|
||||
|
||||
* In **EXECUTION** **>** **OUTPUT** > **DESTINATION** **>** hover **>** **EDIT** **>** edit **>** **SAVE**.
|
||||
|
||||
|
||||
:::note
|
||||
Also set the output destination for artifacts in code (see the `output_uri` parameter of the
|
||||
[Task.init](../references/sdk/task.md#classmethod-initproject_namenone-task_namenone-task_typetasktypestraining-training-tagsnone-reuse_last_task_idtrue-continue_last_taskfalse-output_urinone-auto_connect_arg_parsertrue-auto_connect_frameworkstrue-auto_resource_monitoringtrue-auto_connect_streamstrue)
|
||||
method), and in the **ClearML** configuration file for all experiments (see [default_output_uri](../configs/clearml_conf#config_default_output_uri)
|
||||
Also set the output destination for artifacts in code (see the `output_uri` parameter of the
|
||||
[Task.init](../references/sdk/task.md#classmethod-initproject_namenone-task_namenone-task_typetasktypestraining-training-tagsnone-reuse_last_task_idtrue-continue_last_taskfalse-output_urinone-auto_connect_arg_parsertrue-auto_connect_frameworkstrue-auto_resource_monitoringtrue-auto_connect_streamstrue)
|
||||
method), and in the **ClearML** configuration file for all experiments (see [default_output_uri](../configs/clearml_conf#config_default_output_uri)
|
||||
on the **ClearML** Configuration Reference page).
|
||||
:::
|
||||
|
||||
#### 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)).
|
||||
Set a logging level for the experiment (see the standard Python [logging levels](https://docs.python.org/3/howto/logging.html#logging-levels)).
|
||||
|
||||
**To add, change, or delete a log level:**
|
||||
|
||||
@@ -116,14 +116,14 @@ Set a logging level for the experiment (see the standard Python [logging levels]
|
||||
|
||||
#### Hyperparameters
|
||||
|
||||
:::important
|
||||
In older versions of **ClearML Server**, the **CONFIGURATION** tab was named **HYPER PARAMETERS**, and it contained all
|
||||
:::important
|
||||
In older versions of **ClearML Server**, the **CONFIGURATION** tab was named **HYPER PARAMETERS**, and it contained all
|
||||
parameters. The renamed tab contains a **HYPER PARAMETER** section, and subsections for hyperparameter groups.
|
||||
:::
|
||||
|
||||
Add, change, or delete hyperparameters, which are organized in the **ClearML Web UI** in the following sections:
|
||||
|
||||
* **Args** - Command line arguments and all older experiments parameters, except TensorFlow definitions (logged from code,
|
||||
* **Args** - Command line arguments and all older experiments parameters, except TensorFlow definitions (logged from code,
|
||||
`argparse` argument automatic logging).
|
||||
|
||||
* **TF_DEFINE** - TensorFlow definitions (from code, TF_DEFINEs automatic logging).
|
||||
@@ -137,19 +137,19 @@ Add, change, or delete hyperparameters, which are organized in the **ClearML Web
|
||||
|
||||
**To add, change, or delete hyperparameters:**
|
||||
|
||||
* In the **CONFIGURATIONS** tab **>** **HYPER PARAMETERS** > **General** **>** hover **>** **EDIT** **>** add, change,
|
||||
* In the **CONFIGURATIONS** tab **>** **HYPER PARAMETERS** > **General** **>** hover **>** **EDIT** **>** add, change,
|
||||
or delete keys and /or values **>** **SAVE**.
|
||||
|
||||
|
||||
|
||||
#### User properties
|
||||
#### User properties
|
||||
|
||||
User properties allow storing any descriptive information in key-value pair format. They are editable in any experiment,
|
||||
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).
|
||||
|
||||
**To add, change, or delete user properties:**
|
||||
|
||||
* In **CONFIGURATIONS** **>** **USER PROPERTIES** > **Properties** **>** hover **>** **EDIT** **>** add, change, or delete
|
||||
* In **CONFIGURATIONS** **>** **USER PROPERTIES** > **Properties** **>** hover **>** **EDIT** **>** add, change, or delete
|
||||
keys and /or values **>** **SAVE**.
|
||||
|
||||
|
||||
@@ -157,31 +157,31 @@ except experiments whose status is *Published* (read-only).
|
||||
#### Configuration objects
|
||||
|
||||
:::important
|
||||
In older versions of **ClearML Server**, the Task model configuration appeared in the **ARTIFACTS** tab **>** **MODEL
|
||||
In older versions of **ClearML Server**, the Task model configuration appeared in the **ARTIFACTS** tab **>** **MODEL
|
||||
CONFIGURATION** section. Task model configurations now appear in **CONFIGURATION** **>** **Configuration Objects**.
|
||||
:::
|
||||
|
||||
**To add, change, or delete the Task model configurations:**
|
||||
|
||||
* In **CONFIGURATIONS** **>** **CONFIGURATION OBJECTS** **>** **GENERAL** **>** hover **>** **EDIT** or **CLEAR** (if the
|
||||
* In **CONFIGURATIONS** **>** **CONFIGURATION OBJECTS** **>** **GENERAL** **>** hover **>** **EDIT** or **CLEAR** (if the
|
||||
configuration is not empty).
|
||||
|
||||
### Artifacts
|
||||
|
||||
### 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.
|
||||
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.
|
||||
|
||||
:::note
|
||||
The models are editable in the **MODELS** tab, not the **EXPERIMENTS** tab. Clicking the model name hyperlink shows the
|
||||
The models are editable in the **MODELS** tab, not the **EXPERIMENTS** tab. Clicking the model name hyperlink shows the
|
||||
model in the **MODELS** tab.
|
||||
:::
|
||||
|
||||
**To select a different model:**
|
||||
|
||||
1. In **ARTIFACTS** **>** **Input Model** **>** Hover and click **EDIT**.
|
||||
1. If a model is associated with the experiment, click <img src="/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" />.
|
||||
1. If a model is associated with the experiment, click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" />.
|
||||
1. In the **SELECT MODEL** dialog, select a model from the current project or any other project.
|
||||
|
||||
**To edit a model's configuration or label enumeration:**
|
||||
@@ -189,15 +189,15 @@ model in the **MODELS** tab.
|
||||
1. Click the model name hyperlink. The model details appear in the **MODELS** tab.
|
||||
1. Edit the model configuration or label enumeration.
|
||||
|
||||
* Model configuration - In the **NETWORK** tab **>** Hover and click **EDIT**. **>** CLick **EDIT** or **CLEAR** (to
|
||||
* Model configuration - In the **NETWORK** tab **>** Hover and click **EDIT**. **>** CLick **EDIT** or **CLEAR** (to
|
||||
remove the configuration
|
||||
|
||||
Users can also search for the configuration (hover over the configuration textbox, the search box appears) and copy the
|
||||
configuration to the clipboard (hover and click <img src="/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md" />).
|
||||
|
||||
* Label enumeration - In the **LABELS** tab **>** Hover and click **EDIT** **>** Add, change, or delete label
|
||||
Users can also search for the configuration (hover over the configuration textbox, the search box appears) and copy the
|
||||
configuration to the clipboard (hover and click <img src="/docs/latest/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md" />).
|
||||
|
||||
* Label enumeration - In the **LABELS** tab **>** Hover and click **EDIT** **>** Add, change, or delete label
|
||||
enumeration key-value pairs.
|
||||
|
||||
**To remove a model from an experiment:**
|
||||
|
||||
* Hover and click **EDIT** **>** Click <img src="/icons/ico-trash.svg" alt="Trash" className="icon size-md" />
|
||||
**To remove a model from an experiment:**
|
||||
|
||||
* Hover and click **EDIT** **>** Click <img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md" />
|
||||
|
||||
Reference in New Issue
Block a user