From 0934530a3a47afb9f41861d5c5906fe994fa5821 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 12 Jan 2023 12:49:55 +0200 Subject: [PATCH] Small edits (#434) --- docs/clearml_data/clearml_data_sdk.md | 8 ++++---- docs/configs/clearml_conf.md | 2 +- docs/faq.md | 2 +- docs/guides/advanced/execute_remotely.md | 2 +- docs/guides/automation/task_piping.md | 2 +- docs/guides/distributed/distributed_pytorch_example.md | 2 +- docs/guides/distributed/subprocess_example.md | 2 +- .../guides/frameworks/autokeras/autokeras_imdb_example.md | 2 +- docs/guides/frameworks/keras/jupyter.md | 2 +- docs/guides/frameworks/keras/keras_tensorboard.md | 2 +- docs/guides/frameworks/lightgbm/lightgbm_example.md | 2 +- docs/guides/frameworks/megengine/megengine_mnist.md | 2 +- .../notebooks/audio/audio_classification_UrbanSound8K.md | 2 +- .../pytorch/notebooks/image/hyperparameter_search.md | 4 ++-- .../notebooks/image/image_classification_CIFAR10.md | 2 +- .../pytorch/notebooks/text/text_classification_AG_NEWS.md | 2 +- docs/guides/frameworks/pytorch/pytorch_abseil.md | 2 +- .../frameworks/pytorch/pytorch_distributed_example.md | 4 ++-- docs/guides/frameworks/pytorch/pytorch_mnist.md | 2 +- docs/guides/frameworks/pytorch/pytorch_tensorboard.md | 2 +- docs/guides/frameworks/pytorch/pytorch_tensorboardx.md | 2 +- docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md | 2 +- .../pytorch_lightning/pytorch_lightning_example.md | 2 +- docs/guides/frameworks/tensorboardx/tensorboardx.md | 2 +- .../frameworks/tensorflow/integration_keras_tuner.md | 2 +- docs/guides/frameworks/tensorflow/tensorboard_pr_curve.md | 2 +- docs/guides/frameworks/tensorflow/tensorboard_toy.md | 2 +- docs/guides/frameworks/tensorflow/tensorflow_mnist.md | 2 +- docs/guides/reporting/hyper_parameters.md | 8 ++++---- docs/guides/services/aws_autoscaler.md | 4 ++-- docs/guides/services/cleanup_service.md | 2 +- docs/guides/services/slack_alerts.md | 2 +- docs/guides/ui/building_leader_board.md | 2 +- docs/guides/ui/tuning_exp.md | 6 +++--- docs/release_notes/ver_0_13.md | 2 +- docs/release_notes/ver_1_0.md | 4 ++-- docs/webapp/webapp_exp_comparing.md | 4 ++-- docs/webapp/webapp_exp_table.md | 4 ++-- docs/webapp/webapp_exp_track_visual.md | 2 +- docs/webapp/webapp_exp_tuning.md | 2 +- 40 files changed, 54 insertions(+), 54 deletions(-) diff --git a/docs/clearml_data/clearml_data_sdk.md b/docs/clearml_data/clearml_data_sdk.md index 978906f3..325afe18 100644 --- a/docs/clearml_data/clearml_data_sdk.md +++ b/docs/clearml_data/clearml_data_sdk.md @@ -117,11 +117,11 @@ dataset = Dataset.get( Pass `auto_create=True`, and a dataset will be created on-the-fly with the input attributes (project name, dataset name, and tags) if no datasets match the query. -In cases where you use a dataset in a task (e.g. consuming a dataset), you can have its ID stored in the task’s hyper -parameters: pass `alias=`, and the task using the dataset will store the dataset’s ID in the -`dataset_alias_string` parameter under the `Datasets` hyper parameters section. This way you can easily track which +In cases where you use a dataset in a task (e.g. consuming a dataset), you can have its ID stored in the task’s +hyperparameters: pass `alias=`, and the task using the dataset will store the dataset’s ID in the +`dataset_alias_string` parameter under the `Datasets` hyperparameters section. This way you can easily track which dataset the task is using. If you use `alias` with `overridable=True`, you can override the dataset ID from the UI’s -**CONFIGURATION > HYPER PARAMETERS >** `Datasets` section, allowing you to change the dataset used when running a task +**CONFIGURATION > HYPERPARAMETERS >** `Datasets` section, allowing you to change the dataset used when running a task remotely. In case you want to get a modifiable dataset, you can get a newly created mutable dataset with the current one as its diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md index cfd6e4cd..0b934a89 100644 --- a/docs/configs/clearml_conf.md +++ b/docs/configs/clearml_conf.md @@ -935,7 +935,7 @@ and limitations on bucket naming. **`sdk.development.log_os_environments`** (*[string]*) * Log specific environment variables. OS environments are listed in the UI, under an experiment's - **CONFIGURATION > HYPER PARAMETERS > Environment** section. + **CONFIGURATION > HYPERPARAMETERS > Environment** section. Multiple selected variables are supported including the suffix "\*". For example: "AWS\_\*" will log any OS environment variable starting with "AWS\_". Example: `log_os_environments: ["AWS_*", "CUDA_VERSION"]` diff --git a/docs/faq.md b/docs/faq.md index 5e9a7871..ca67e1b7 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -530,7 +530,7 @@ info panel > CONSOLE tab, use the *Download full log* feature. You can use the UI's [experiment comparison features](webapp/webapp_exp_comparing.md) to compare the logged hyperparameter and accuracy values of several experiments. -In an experiment comparison page, under the **HYPER PARAMETERS** tab, you can view the experiments' hyperparameter values +In an experiment comparison page, under the **HYPERPARAMETERS** tab, you can view the experiments' hyperparameter values in relation to a specific metric (e.g. accuracy) in a parallel coordinates plot. The image below shows a parallel coordinates plot which displays the values of selected hyperparameters (`base_lr`, diff --git a/docs/guides/advanced/execute_remotely.md b/docs/guides/advanced/execute_remotely.md index 02123a43..498acfa2 100644 --- a/docs/guides/advanced/execute_remotely.md +++ b/docs/guides/advanced/execute_remotely.md @@ -58,7 +58,7 @@ These scalars can be visualized in plots, which appear in the ClearML web UI, in ## Hyperparameters -ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**. +ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. ![Experiment hyperparameters](../../img/examples_pytorch_mnist_01.png) diff --git a/docs/guides/automation/task_piping.md b/docs/guides/automation/task_piping.md index 5440c992..6c232b17 100644 --- a/docs/guides/automation/task_piping.md +++ b/docs/guides/automation/task_piping.md @@ -22,4 +22,4 @@ This example accomplishes a task pipe by doing the following: 1. Setting the newly cloned Task's parameters to the search values in the parameter dictionary (Step 2). See [Task.set_parameters](../../references/sdk/task.md#set_parameters). 1. Enqueuing the newly cloned Task to execute. See [Task.enqueue](../../references/sdk/task.md#taskenqueue). -When the example script runs, it creates an instance of the template experiment, named `Auto generated cloned task` which is associated with the `examples` project. In the instance, the value of the customized parameter, `Example_Param` changed to `3`. You can see it in **CONFIGURATION** **>** **HYPER PARAMETERS**. \ No newline at end of file +When the example script runs, it creates an instance of the template experiment, named `Auto generated cloned task` which is associated with the `examples` project. In the instance, the value of the customized parameter, `Example_Param` changed to `3`. You can see it in **CONFIGURATION** **>** **HYPERPARAMETERS**. \ No newline at end of file diff --git a/docs/guides/distributed/distributed_pytorch_example.md b/docs/guides/distributed/distributed_pytorch_example.md index f1f27d16..6a750069 100644 --- a/docs/guides/distributed/distributed_pytorch_example.md +++ b/docs/guides/distributed/distributed_pytorch_example.md @@ -67,7 +67,7 @@ param = {'worker_{}_stuff'.format(dist.get_rank()): 'some stuff ' + str(randint( Task.current_task().connect(param) ``` -All the hyperparameters appear in **CONFIGURATION** **>** **HYPER PARAMETERS**. +All the hyperparameters appear in **CONFIGURATION** **>** **HYPERPARAMETERS**. ![Experiment hyperparameters Args](../../img/examples_pytorch_distributed_example_01.png) diff --git a/docs/guides/distributed/subprocess_example.md b/docs/guides/distributed/subprocess_example.md index ff15caad..bc24fe1a 100644 --- a/docs/guides/distributed/subprocess_example.md +++ b/docs/guides/distributed/subprocess_example.md @@ -24,7 +24,7 @@ additional_parameters = { Task.current_task().connect(additional_parameters) ``` -Command line options appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**. +Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. ![image](../../img/examples_subprocess_example_01.png) diff --git a/docs/guides/frameworks/autokeras/autokeras_imdb_example.md b/docs/guides/frameworks/autokeras/autokeras_imdb_example.md index 3fef205f..8111f86a 100644 --- a/docs/guides/frameworks/autokeras/autokeras_imdb_example.md +++ b/docs/guides/frameworks/autokeras/autokeras_imdb_example.md @@ -20,7 +20,7 @@ which are titled **:monitor: machine**. ## Hyperparameters -ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**. +ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**. ![image](../../../img/examples_keras_16.png) diff --git a/docs/guides/frameworks/keras/jupyter.md b/docs/guides/frameworks/keras/jupyter.md index 0e787360..50f76247 100644 --- a/docs/guides/frameworks/keras/jupyter.md +++ b/docs/guides/frameworks/keras/jupyter.md @@ -53,7 +53,7 @@ task_params['nb_epoch'] = 6 task_params['hidden_dim'] = 512 ``` -Parameter dictionaries appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **General**. +Parameter dictionaries appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **General**. ![image](../../../img/examples_keras_jupyter_20.png) diff --git a/docs/guides/frameworks/keras/keras_tensorboard.md b/docs/guides/frameworks/keras/keras_tensorboard.md index 1787faa9..18fb3307 100644 --- a/docs/guides/frameworks/keras/keras_tensorboard.md +++ b/docs/guides/frameworks/keras/keras_tensorboard.md @@ -37,7 +37,7 @@ Histograms for layer density appear in **PLOTS**. ClearML automatically logs command line options generated with `argparse`, and TensorFlow Definitions. -Command line options appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**. +Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. ![image](../../../img/examples_keras_00.png) diff --git a/docs/guides/frameworks/lightgbm/lightgbm_example.md b/docs/guides/frameworks/lightgbm/lightgbm_example.md index 33970fc8..6b262fd3 100644 --- a/docs/guides/frameworks/lightgbm/lightgbm_example.md +++ b/docs/guides/frameworks/lightgbm/lightgbm_example.md @@ -19,7 +19,7 @@ The scalars logged in the experiment can be visualized in a plot, which appears ## Hyperparameters -ClearML automatically logs the configurations applied to LightGBM. They appear in **CONFIGURATIONS > HYPER PARAMETERS > GENERAL**. +ClearML automatically logs the configurations applied to LightGBM. They appear in **CONFIGURATIONS > HYPERPARAMETERS > GENERAL**. ![LightGBM hyperparameters](../../../img/examples_lightgbm_config.png) diff --git a/docs/guides/frameworks/megengine/megengine_mnist.md b/docs/guides/frameworks/megengine/megengine_mnist.md index 68e630cd..7a9601f5 100644 --- a/docs/guides/frameworks/megengine/megengine_mnist.md +++ b/docs/guides/frameworks/megengine/megengine_mnist.md @@ -15,7 +15,7 @@ The example script does the following: ## Hyperparameters ClearML automatically logs command line options defined with `argparse`. They appear in the experiment's **CONFIGURATION** -tab under **HYPER PARAMETERS** **>** **Args**. +tab under **HYPERPARAMETERS** **>** **Args**. ![Configuration tab](../../../img/examples_megengine_mnist_config.png) diff --git a/docs/guides/frameworks/pytorch/notebooks/audio/audio_classification_UrbanSound8K.md b/docs/guides/frameworks/pytorch/notebooks/audio/audio_classification_UrbanSound8K.md index 2f215c99..27ed5c34 100644 --- a/docs/guides/frameworks/pytorch/notebooks/audio/audio_classification_UrbanSound8K.md +++ b/docs/guides/frameworks/pytorch/notebooks/audio/audio_classification_UrbanSound8K.md @@ -42,7 +42,7 @@ configuration_dict = { } configuration_dict = task.connect(configuration_dict) # enabling configuration override by clearml ``` -Parameter dictionaries appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **General**. +Parameter dictionaries appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **General**. ![image](../../../../../img/examples_audio_classification_UrbanSound8K_01.png) diff --git a/docs/guides/frameworks/pytorch/notebooks/image/hyperparameter_search.md b/docs/guides/frameworks/pytorch/notebooks/image/hyperparameter_search.md index bc9ef0b5..03fbb5e2 100644 --- a/docs/guides/frameworks/pytorch/notebooks/image/hyperparameter_search.md +++ b/docs/guides/frameworks/pytorch/notebooks/image/hyperparameter_search.md @@ -22,7 +22,7 @@ The optimizer Task, `Hyperparameter Optimization`, and the experiments appear in ### Hyperparameters The `HyperParameterOptimizer`'s configuration, which is provided when the object instantiated, are stored under the -optimizer task's **CONFIGURATION** **>** **HYPER PARAMETERS**. +optimizer task's **CONFIGURATION** **>** **HYPERPARAMETERS**. ```python optimizer = HyperParameterOptimizer( @@ -101,7 +101,7 @@ Use the ClearML Web UI [experiment comparison](../../../../../webapp/webapp_exp_ ### Side by Side Hyperparameter Value Comparison -In the experiment comparison window, **HYPER PARAMETERS** tab, select **Values** in the list (the right of **+ Add Experiment**), and hyperparameter differences appear with a different background color. +In the experiment comparison window, **HYPERPARAMETERS** tab, select **Values** in the list (the right of **+ Add Experiment**), and hyperparameter differences appear with a different background color. ![Hyperparameter comparison](../../../../../img/examples_hyperparameter_search_06.png) diff --git a/docs/guides/frameworks/pytorch/notebooks/image/image_classification_CIFAR10.md b/docs/guides/frameworks/pytorch/notebooks/image/image_classification_CIFAR10.md index ec1bcad8..c86b486c 100644 --- a/docs/guides/frameworks/pytorch/notebooks/image/image_classification_CIFAR10.md +++ b/docs/guides/frameworks/pytorch/notebooks/image/image_classification_CIFAR10.md @@ -35,7 +35,7 @@ a call to the [Task.connect](../../../../../references/sdk/task.md#connect) meth configuration_dict = {'number_of_epochs': 3, 'batch_size': 4, 'dropout': 0.25, 'base_lr': 0.001} configuration_dict = task.connect(configuration_dict) # enabling configuration override by clearml -Parameter dictionaries appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **General**. +Parameter dictionaries appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **General**. ![image](../../../../../img/examples_image_classification_CIFAR10_01.png) diff --git a/docs/guides/frameworks/pytorch/notebooks/text/text_classification_AG_NEWS.md b/docs/guides/frameworks/pytorch/notebooks/text/text_classification_AG_NEWS.md index fe816f89..8ecc071d 100644 --- a/docs/guides/frameworks/pytorch/notebooks/text/text_classification_AG_NEWS.md +++ b/docs/guides/frameworks/pytorch/notebooks/text/text_classification_AG_NEWS.md @@ -26,7 +26,7 @@ configuration_dict = { configuration_dict = task.connect(configuration_dict) ``` -Command line options appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**. +Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. ![image](../../../../../img/text_classification_AG_NEWS_01.png) diff --git a/docs/guides/frameworks/pytorch/pytorch_abseil.md b/docs/guides/frameworks/pytorch/pytorch_abseil.md index 031a246b..a0bdad34 100644 --- a/docs/guides/frameworks/pytorch/pytorch_abseil.md +++ b/docs/guides/frameworks/pytorch/pytorch_abseil.md @@ -48,7 +48,7 @@ the experiment's **SCALARS** tab. ## Hyperparameters ClearML automatically logs command line options defined with abseil flags. They appear in **CONFIGURATION** **>** -**HYPER PARAMETERS** **>** **TF_DEFINE**. +**HYPERPARAMETERS** **>** **TF_DEFINE**. ![image](../../../img/examples_pytorch_abseil_params.png) diff --git a/docs/guides/frameworks/pytorch/pytorch_distributed_example.md b/docs/guides/frameworks/pytorch/pytorch_distributed_example.md index e52fa666..eaf7c38a 100644 --- a/docs/guides/frameworks/pytorch/pytorch_distributed_example.md +++ b/docs/guides/frameworks/pytorch/pytorch_distributed_example.md @@ -58,11 +58,11 @@ param = {'worker_{}_stuff'.format(dist.get_rank()): 'some stuff ' + str(randint( Task.current_task().connect(param) ``` -Command line options appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**. +Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. ![image](../../../img/examples_pytorch_distributed_example_01.png) -Parameter dictionaries appear in the **General** section of **HYPER PARAMETERS**. +Parameter dictionaries appear in the **General** section of **HYPERPARAMETERS**. ```python param = {'worker_{}_stuff'.format(dist.get_rank()): 'some stuff ' + str(randint(0, 100))} diff --git a/docs/guides/frameworks/pytorch/pytorch_mnist.md b/docs/guides/frameworks/pytorch/pytorch_mnist.md index ca4a4459..d2825d8d 100644 --- a/docs/guides/frameworks/pytorch/pytorch_mnist.md +++ b/docs/guides/frameworks/pytorch/pytorch_mnist.md @@ -40,7 +40,7 @@ in the experiment's page **>** **SCALARS**. ## Hyperparameters -ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**. +ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. ![image](../../../img/examples_pytorch_mnist_01.png) diff --git a/docs/guides/frameworks/pytorch/pytorch_tensorboard.md b/docs/guides/frameworks/pytorch/pytorch_tensorboard.md index 26d965bb..9eb1f5c6 100644 --- a/docs/guides/frameworks/pytorch/pytorch_tensorboard.md +++ b/docs/guides/frameworks/pytorch/pytorch_tensorboard.md @@ -28,7 +28,7 @@ ClearML automatically tracks images and text output to TensorFlow. They appear i ## Hyperparameters -ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**. +ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**. ![image](../../../img/examples_pytorch_tensorboard_01.png) diff --git a/docs/guides/frameworks/pytorch/pytorch_tensorboardx.md b/docs/guides/frameworks/pytorch/pytorch_tensorboardx.md index 1d31574d..bb469bc1 100644 --- a/docs/guides/frameworks/pytorch/pytorch_tensorboardx.md +++ b/docs/guides/frameworks/pytorch/pytorch_tensorboardx.md @@ -23,7 +23,7 @@ appear in the experiment's page in the [web UI](../../../webapp/webapp_overview. ## Hyperparameters ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** -**HYPER PARAMETERS** **>** **Args**. +**HYPERPARAMETERS** **>** **Args**. ![image](../../../img/examples_pytorch_tensorboardx_01.png) diff --git a/docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md b/docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md index deeb2a83..becf7da2 100644 --- a/docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md +++ b/docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md @@ -15,6 +15,6 @@ The debug sample images appear according to metric, in the experiment's **DEBUG ## Hyperparameters -ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**. +ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**. ![image](../../../img/examples_tensorboard_toy_pytorch_00.png) \ No newline at end of file diff --git a/docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md b/docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md index c7943d74..e4bb6c47 100644 --- a/docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md +++ b/docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md @@ -22,7 +22,7 @@ plots are automatically captured by ClearML. ## Hyperparameters ClearML automatically logs command line options defined with argparse and TensorFlow Definitions, which appear in -**CONFIGURATIONS > HYPER PARAMETERS > Args** and **TF_DEFINE** respectively. +**CONFIGURATIONS > HYPERPARAMETERS > Args** and **TF_DEFINE** respectively. ![PyTorch Lightning parameters](../../../img/examples_pytorch_lightning_params.png) diff --git a/docs/guides/frameworks/tensorboardx/tensorboardx.md b/docs/guides/frameworks/tensorboardx/tensorboardx.md index 2220527d..bb9f9555 100644 --- a/docs/guides/frameworks/tensorboardx/tensorboardx.md +++ b/docs/guides/frameworks/tensorboardx/tensorboardx.md @@ -21,7 +21,7 @@ The loss and accuracy metric scalar plots appear in the experiment's page in the ## Hyperparameters ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** -**HYPER PARAMETERS** **>** **Args**. +**HYPERPARAMETERS** **>** **Args**. ![image](../../../img/examples_pytorch_tensorboardx_01.png) diff --git a/docs/guides/frameworks/tensorflow/integration_keras_tuner.md b/docs/guides/frameworks/tensorflow/integration_keras_tuner.md index 6c606b32..fbaf4d12 100644 --- a/docs/guides/frameworks/tensorflow/integration_keras_tuner.md +++ b/docs/guides/frameworks/tensorflow/integration_keras_tuner.md @@ -65,7 +65,7 @@ The model configuration is stored with the model. ### Hyperparameters -ClearML automatically logs the TensorFlow Definitions, which appear in **CONFIGURATION** **>** **HYPER PARAMETERS**. +ClearML automatically logs the TensorFlow Definitions, which appear in **CONFIGURATION** **>** **HYPERPARAMETERS**. ![image](../../../img/integration_keras_tuner_01.png) diff --git a/docs/guides/frameworks/tensorflow/tensorboard_pr_curve.md b/docs/guides/frameworks/tensorflow/tensorboard_pr_curve.md index 0cd6cdde..acf7458a 100644 --- a/docs/guides/frameworks/tensorflow/tensorboard_pr_curve.md +++ b/docs/guides/frameworks/tensorflow/tensorboard_pr_curve.md @@ -27,7 +27,7 @@ In the **ClearML Web UI**, the PR Curve summaries appear in the experiment's pag ## Hyperparameters -ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**. +ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**. ![image](../../../img/examples_tensorboard_pr_curve_04.png) diff --git a/docs/guides/frameworks/tensorflow/tensorboard_toy.md b/docs/guides/frameworks/tensorflow/tensorboard_toy.md index bf3d52dc..6866c892 100644 --- a/docs/guides/frameworks/tensorflow/tensorboard_toy.md +++ b/docs/guides/frameworks/tensorflow/tensorboard_toy.md @@ -30,7 +30,7 @@ ClearML automatically tracks images and text output to TensorFlow. They appear i ## Hyperparameters -ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** +ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**. ![image](../../../img/examples_tensorboard_toy_01.png) diff --git a/docs/guides/frameworks/tensorflow/tensorflow_mnist.md b/docs/guides/frameworks/tensorflow/tensorflow_mnist.md index da7264af..b13aa133 100644 --- a/docs/guides/frameworks/tensorflow/tensorflow_mnist.md +++ b/docs/guides/frameworks/tensorflow/tensorflow_mnist.md @@ -17,7 +17,7 @@ The loss and accuracy metric scalar plots appear in the experiment's page in the ## Hyperparameters -ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** +ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**. ![image](../../../img/examples_tensorflow_mnist_01.png) diff --git a/docs/guides/reporting/hyper_parameters.md b/docs/guides/reporting/hyper_parameters.md index 534917ea..7b1c2a19 100644 --- a/docs/guides/reporting/hyper_parameters.md +++ b/docs/guides/reporting/hyper_parameters.md @@ -7,7 +7,7 @@ script demonstrates: * ClearML's automatic logging of `argparse` command line options and TensorFlow Definitions * Logging user-defined hyperparameters with a parameter dictionary and connecting the dictionary to a Task. -Hyperparameters appear in the **web UI** in the experiment's page, under **CONFIGURATION** **>** **HYPER PARAMETERS**. +Hyperparameters appear in the **web UI** in the experiment's page, under **CONFIGURATION** **>** **HYPERPARAMETERS**. Each type is in its own subsection. Parameters from older experiments are grouped together with the ``argparse`` command line options (in the **Args** subsection). @@ -28,7 +28,7 @@ parser.add_argument('--argparser_str_value', help='string value', default='a str args = parser.parse_args() ``` -Command line options appears in **HYPER PARAMETERS** **>** **Args**. +Command line options appears in **HYPERPARAMETERS** **>** **Args**. ![image](../../img/examples_reporting_hyper_param_01.png) @@ -48,7 +48,7 @@ flags.DEFINE_string('echo5', '5', 'Text to echo.', module_name='test') ``` -TensorFlow Definitions appear in **HYPER PARAMETERS** **>** **TF_DEFINE**. +TensorFlow Definitions appear in **HYPEPARAMETERS** **>** **TF_DEFINE**. ![image](../../img/examples_reporting_hyper_param_03.png) @@ -77,7 +77,7 @@ parameters['float'] = '9.9' ``` -Parameters from dictionaries connected to Tasks appear in **HYPER PARAMETERS** **>** **General**. +Parameters from dictionaries connected to Tasks appear in **HYPERPARAMETERS** **>** **General**. ![image](../../img/examples_reporting_hyper_param_02.png) diff --git a/docs/guides/services/aws_autoscaler.md b/docs/guides/services/aws_autoscaler.md index a2a2c45f..2433cc56 100644 --- a/docs/guides/services/aws_autoscaler.md +++ b/docs/guides/services/aws_autoscaler.md @@ -153,10 +153,10 @@ Make sure a `clearml-agent` is assigned to that queue. The values configured through the wizard are stored in the task’s hyperparameters and configuration objects by using the [`Task.connect`](../../references/sdk/task.md#connect) and [`Task.set_configuration_object`](../../references/sdk/task.md#set_configuration_object) -methods respectively. They can be viewed in the WebApp, in the task’s **CONFIGURATION** page under **HYPER PARAMETERS** and **CONFIGURATION OBJECTS > General**. +methods respectively. They can be viewed in the WebApp, in the task’s **CONFIGURATION** page under **HYPERPARAMETERS** and **CONFIGURATION OBJECTS > General**. ClearML automatically logs command line arguments defined with argparse. View them in the experiments **CONFIGURATION** -page under **HYPER PARAMETERS > General**. +page under **HYPERPARAMETERS > General**. ![Autoscaler configuration](../../img/examples_aws_autoscaler_config.png) diff --git a/docs/guides/services/cleanup_service.md b/docs/guides/services/cleanup_service.md index 532be5ff..fbd10a14 100644 --- a/docs/guides/services/cleanup_service.md +++ b/docs/guides/services/cleanup_service.md @@ -53,7 +53,7 @@ an `APIClient` object that establishes a session with the ClearML Server, and ac ## Configuration The experiment’s hyperparameters are explicitly logged to ClearML using the [`Task.connect`](../../references/sdk/task.md#connect) -method. View them in the WebApp, in the experiment’s **CONFIGURATION** page under **HYPER PARAMETERS > General**. +method. View them in the WebApp, in the experiment’s **CONFIGURATION** page under **HYPERPARAMETERS > General**. The task can be reused. Clone the task, edit its parameters, and enqueue the task to run in ClearML Agent [services mode](../../clearml_agent.md#services-mode). diff --git a/docs/guides/services/slack_alerts.md b/docs/guides/services/slack_alerts.md index dad7d357..be79c570 100644 --- a/docs/guides/services/slack_alerts.md +++ b/docs/guides/services/slack_alerts.md @@ -80,7 +80,7 @@ The script supports the following additional command line options: ## Configuration ClearML automatically logs command line options defined with argparse. They appear in the experiment’s **CONFIGURATION** -page under **HYPER PARAMETERS > Args**. +page under **HYPERPARAMETERS > Args**. ![Monitoring configuration](../../img/examples_slack_config.png) diff --git a/docs/guides/ui/building_leader_board.md b/docs/guides/ui/building_leader_board.md index 76653fcc..89df2da0 100644 --- a/docs/guides/ui/building_leader_board.md +++ b/docs/guides/ui/building_leader_board.md @@ -79,7 +79,7 @@ recent), minimum, and / or maximum values. 1. Click settings. 1. For metrics, click **+ METRIC**, expand a metric category, and then select the metric checkboxes of those to show in the leaderboard, and select the metric values (min / max / last). -1. For hyperparameters, click **+ HYPER PARAMETERS**, and then select the hyperparameter checkboxes of those to show in the leaderboard. +1. For hyperparameters, click **+ HYPERPARAMETERS**, and then select the hyperparameter checkboxes of those to show in the leaderboard. ## Step 5: Enable Auto Refresh diff --git a/docs/guides/ui/tuning_exp.md b/docs/guides/ui/tuning_exp.md index 44a738b6..6f0db5de 100644 --- a/docs/guides/ui/tuning_exp.md +++ b/docs/guides/ui/tuning_exp.md @@ -32,7 +32,7 @@ Clone the experiment to create an editable copy for tuning. To demonstrate tuning, change two hyperparameter values. -1. In the info panel, **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args** **>** Hover and click **EDIT**. +1. In the info panel, **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args** **>** Hover and click **EDIT**. 1. Change the value of `batch_size` from `64` to `32`. @@ -104,12 +104,12 @@ To compare the original and tuned experiments: * **DETAILS** - The **ARTIFACTS** section, including input and output models with their network designs, and other artifacts; the **EXECUTION** section execution, including source code control, installed Python packages and versions, uncommitted changes, and the Docker image name which, in this case, is empty. - * **HYPER PARAMETERS** - The hyperparameters and their values. + * **HYPERPARAMETERS** - The hyperparameters and their values. * **SCALARS** - Scalar metrics with the option to view them as charts or values. * **PLOTS** - Plots of any data with the option to view them as charts or values. * **DEBUG SAMPLES** - Media including images, audio, and video uploaded by your experiment shown as thumbnails. 1. Examine the differences. - 1. Compare the hyperparameters. In the **HYPER PARAMETERS** tab, expand **ARGS**. The hyperparameters `batch_size` + 1. Compare the hyperparameters. In the **HYPERPARAMETERS** tab, expand **ARGS**. The hyperparameters `batch_size` and `lr` are shown with a different background color. The values are different. 1. Compare the metrics. In the **SCALARS** tab, to the right of **Add Experiment**, select the plot or value comparison: * **Graph** - The scalar metrics plots show `pytorch mnist train` and `Clone of pytorch mnist train`. diff --git a/docs/release_notes/ver_0_13.md b/docs/release_notes/ver_0_13.md index 0161fc9c..0d7115b8 100644 --- a/docs/release_notes/ver_0_13.md +++ b/docs/release_notes/ver_0_13.md @@ -100,7 +100,7 @@ title: Version 0.13 **Features and Bug Fixes** -* Add parallel coordinates hyperparameter comparison, available under **Compare Experiments** **>** **HYPER PARAMETERS** +* Add parallel coordinates hyperparameter comparison, available under **Compare Experiments** **>** **HYPERPARAMETERS** **>** **Parallel Coordinates** (in the drop-down) ([GitHub Issue #53](https://github.com/allegroai/trains/issues/53)). * Add encoding of experiment table view settings in URL to allow sharing, using browser URL copy / paste. * Add loguru (ANSI color) support ([GitHub Issue #29](https://github.com/allegroai/trains/issues/29)). diff --git a/docs/release_notes/ver_1_0.md b/docs/release_notes/ver_1_0.md index 321ef269..26a0d567 100644 --- a/docs/release_notes/ver_1_0.md +++ b/docs/release_notes/ver_1_0.md @@ -258,7 +258,7 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()` * Improve experiment table columns * Add filter by user * Add filters time columns - * Add filters for custom columns (metrics and hyper parameters) + * Add filters for custom columns (metrics and hyperparameters) * Add secondary nested sorting * Add worker<->queue clickable reference in workers and queues tables * Add presenting all metric debug samples concurrently @@ -270,7 +270,7 @@ Arguments order changed in `Logger.report_line_plot()`, `Logger.report_plotly()` * Fix UI storage credentials input missing for HTML artifacts * Fix sorting custom metric columns sort treats empty fields as zeroes * Fix UI experiments table redundant rendering on auto refresh -* Fix missing URL encoding for hyper parameters key names +* Fix missing URL encoding for hyperparameters key names * Fix UI experiment section edit opens outside viewable screen * Fix UI missing default selection of artifacts in full screen view * Fix UI variant name not shown in plots diff --git a/docs/webapp/webapp_exp_comparing.md b/docs/webapp/webapp_exp_comparing.md index c0d031a1..8479ff47 100644 --- a/docs/webapp/webapp_exp_comparing.md +++ b/docs/webapp/webapp_exp_comparing.md @@ -64,7 +64,7 @@ The Values mode is a side-by-side comparison that shows hyperparameter value dif **To view a side by side values comparison:** -1. Click the **HYPER PARAMETERS** tab. +1. Click the **HYPERPARAMETERS** tab. 1. In the dropdown menu (on the upper left, next to **+ Add Experiments**), choose **Values**. 1. To show only differences, move the **Hide Identical Fields** slider to on. 1. Locate differences by either: @@ -82,7 +82,7 @@ In the Parallel Coordinates mode, compare a metric to any combination of hyperpa **To compare by metric:** -1. Click the **HYPER PARAMETERS** tab. +1. Click the **HYPERPARAMETERS** tab. 1. In the dropdown menu (on the upper left, next to **+ Add Experiments**), choose **Parallel Coordinates**. 1. In **Performance Metric**, expand a metric or monitored resource, and then click a variant. 1. Select the metric values to use. Choose one of the following: diff --git a/docs/webapp/webapp_exp_table.md b/docs/webapp/webapp_exp_table.md index 9449d8be..bfda08f4 100644 --- a/docs/webapp/webapp_exp_table.md +++ b/docs/webapp/webapp_exp_table.md @@ -50,7 +50,7 @@ Customize the table using any of the following: * Changing table columns * Show / hide columns - Click Setting Gear **>** mark or clear the checkboxes of columns to show or hide. - * Add custom columns - Click **+ METRICS** or **+ HYPER PARAMETERS** to add metric / hyperparameter columns to the + * Add custom columns - Click **+ METRICS** or **+ HYPERPARAMETERS** to add metric / hyperparameter columns to the main column list. Added columns are by default displayed in the table. You can remove the custom columns from the main column list or the column addition windows. * [Filter columns](#filtering-columns) @@ -95,7 +95,7 @@ experiments in the table. #### To Add Hyperparameters: -* Click Setting Gear **>** **+ HYPER PARAMETERS** **>** Expand a section **>** Select the +* Click Setting Gear **>** **+ HYPERPARAMETERS** **>** Expand a section **>** Select the hyperparameter checkboxes. :::note Float Values Display diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index 64450464..a1d0b2ec 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -113,7 +113,7 @@ All parameters and configuration objects appear in the **CONFIGURATION** tab. ### Hyperparameters -Hyperparameters are grouped by their type and appear in **CONFIGURATION** **>** **HYPER PARAMETERS**. +Hyperparameters are grouped by their type and appear in **CONFIGURATION** **>** **HYPERPARAMETERS**. #### Command Line Arguments diff --git a/docs/webapp/webapp_exp_tuning.md b/docs/webapp/webapp_exp_tuning.md index df3979a9..7215caa2 100644 --- a/docs/webapp/webapp_exp_tuning.md +++ b/docs/webapp/webapp_exp_tuning.md @@ -133,7 +133,7 @@ Add, change, or delete hyperparameters, which are organized in the **ClearML Web **To add, change, or delete hyperparameters:** -* In the **CONFIGURATION** tab **>** **HYPER PARAMETERS** > **General** **>** hover **>** **EDIT** **>** add, change, +* In the **CONFIGURATION** tab **>** **HYPERPARAMETERS** > **General** **>** hover **>** **EDIT** **>** add, change, or delete keys and /or values **>** **SAVE**.