From 6802e5f5bf4d8d51e1755af1d41bc947cd871a60 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 7 Jan 2024 16:33:51 +0200 Subject: [PATCH] Edit Task Hyperparameters section (#751) --- docs/webapp/webapp_exp_track_visual.md | 15 ++++++++------- docs/webapp/webapp_exp_tuning.md | 8 +++----- static/icons/ico-description.svg | 4 ++-- 3 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index c35256d3..d7cd34a5 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -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 +Description (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, diff --git a/docs/webapp/webapp_exp_tuning.md b/docs/webapp/webapp_exp_tuning.md index 51471500..1a9afa60 100644 --- a/docs/webapp/webapp_exp_tuning.md +++ b/docs/webapp/webapp_exp_tuning.md @@ -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:** diff --git a/static/icons/ico-description.svg b/static/icons/ico-description.svg index 08097051..a12465b6 100644 --- a/static/icons/ico-description.svg +++ b/static/icons/ico-description.svg @@ -1,3 +1,3 @@ - - + + \ No newline at end of file