ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-01-31 06:27:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Edit Task Hyperparameters section (#751)

Browse Source
This commit is contained in:
pollfly 2024-01-07 16:33:51 +02:00 committed by GitHub
parent 3886446672
commit 6802e5f5bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/webapp/webapp_exp_track_visual.md
View File

@ -109,12 +109,14 @@ All parameters and configuration objects appear in the **CONFIGURATION** tab.
### Hyperparameters
Hyperparameters are grouped by their type and appear in **CONFIGURATION** **>** **HYPERPARAMETERS**.
Hyperparameters are grouped by their type and appear in **CONFIGURATION** **>** **HYPERPARAMETERS**. Once an experiment
is run and stored in ClearML Server, any of these hyperparameters can be [modified](webapp_exp_tuning.md#modifying-experiments).
#### 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.
The **Args** group shows automatically logged argument parser parameters (e.g. `argparse`, `click`, `hydra`). Hover over
<img src="/docs/latest/icons/ico-description" alt="Description" className="icon size-md" /> (menu) on a
parameter's line, and the type, description, and default value appear, if they were provided.
![Command line arguments configuration group](../img/webapp_tracking_22.png)
@ -126,8 +128,9 @@ If the `CLEARML_LOG_ENVIRONMENT` variable was set, the **Environment** group wil
#### 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.
Custom parameter groups show parameter dictionaries if the parameters were connected to the Task, using the
[`Task.connect()`](../references/sdk/task.md#connect) with a `name` argument provided. `General` is the default section
if a name is not provided.
![Custom parameters group](../img/webapp_tracking_25.png)
@ -137,8 +140,6 @@ The **TF_DEFINE** parameter group shows automatic TensorFlow logging.
![TF_DEFINE parameter group](../img/webapp_tracking_26.png)
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 allow to store any descriptive information in a key-value pair format. They are editable in any experiment,

8
docs/webapp/webapp_exp_tuning.md
View File

@ -110,17 +110,15 @@ on the ClearML Configuration Reference page).
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,
`argparse` argument automatic logging).
* **Args** - Automatically logged argument parser parameters (e.g. `argparse`, `click`, `hydra`).
* **TF_DEFINE** - TensorFlow definitions (from code, TF_DEFINEs automatic logging).
* **General** - Parameter dictionaries (from code, connected to the Task by calling the [Task.connect](../references/sdk/task.md#connect)
method).
* **General** - Parameter dictionaries (from code, connected to the Task by calling [`Task.connect()`](../references/sdk/task.md#connect)).
* Environment variables - Tracked if the `CLEARML_LOG_ENVIRONMENT` environment variable was set (see this [FAQ](../faq.md#track-env-vars)).
* Custom named parameter groups (see the `name` parameter in [Task.connect](../references/sdk/task.md#connect)).
* Custom named parameter groups (see the `name` parameter in [`Task.connect`](../references/sdk/task.md#connect)).
**To add, change, or delete hyperparameters:**

2
static/icons/ico-description.svg
View File

@ -1,3 +1,3 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M2,17V15H7v2Zm0-4V11H22v2ZM2,9V7H14V9Z" fill="#8f9dc9"/>
<path d="M2,17v-2h5v2H2ZM2,13v-2h20v2H2ZM2,9v-2h12v2H2Z" fill="#8492c2"/>
</svg>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 136 B

After

Width:  |  Height:  |  Size: 143 B