ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#260)

Browse Source
This commit is contained in:
pollfly 2022-05-26 09:54:41 +03:00 committed by GitHub
parent 4a361782d8
commit 31ab5d0af7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
33 changed files with 42 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/fundamentals/hyperparameters.md
View File

@ -101,7 +101,7 @@ including their sub-sections (see [WebApp sections](#webapp-access) below).
## WebApp Interface
Configurations can be viewed in web UI experiment pages, in the **CONFIGURATIONS** panel.
Configurations can be viewed in web UI experiment pages, in the **CONFIGURATION** tab.
The configuration panel is split into three sections according to type:
- **User Properties** - Modifiable section that can be edited post-execution.

2
docs/fundamentals/task.md
View File

@ -158,6 +158,6 @@ The following table describes the task states and state transitions.
## SDK Interface
See [the task SDK interface](../clearml_sdk/task_sdk.md) for an overview for using the most basic Pythonic methods of the `Task`class.
See [the task SDK interface](../clearml_sdk/task_sdk.md) for an overview for using the most basic Pythonic methods of the `Task` class.
See the [Task reference page](../references/sdk/task.md) for a complete list of available list.

5
docs/guides/advanced/execute_remotely.md
View File

@ -52,14 +52,13 @@ Logger.current_logger().report_scalar(
)
```
These scalars can be visualized in plots, which appear in the ClearML web UI, in the experiment's
page **>** **SCALARS**.
These scalars can be visualized in plots, which appear in the ClearML web UI, in the experiment's **SCALARS** tab.
![Experiment Scalars](../../img/examples_pytorch_mnist_07.png)
## Hyperparameters
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **Args**.
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**.
![Experiment hyperparameters](../../img/examples_pytorch_mnist_01.png)

2
docs/guides/automation/task_piping.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS**.
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**.

2
docs/guides/distributed/distributed_pytorch_example.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS**.
All the hyperparameters appear in **CONFIGURATION** **>** **HYPER PARAMETERS**.
![Experiment hyperparameters Args](../../img/examples_pytorch_distributed_example_01.png)

2
docs/guides/distributed/subprocess_example.md
View File

@ -24,7 +24,7 @@ additional_parameters = {
Task.current_task().connect(additional_parameters)
```
Command line options appear in **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **Args**.
Command line options appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**.
![image](../../img/examples_subprocess_example_01.png)

2
docs/guides/frameworks/autokeras/autokeras_imdb_example.md
View File

@ -20,7 +20,7 @@ which are titled **:monitor: machine**.
## Hyperparameters
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**.
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**.
![image](../../../img/examples_keras_16.png)

2
docs/guides/frameworks/keras/jupyter.md
View File

@ -55,7 +55,7 @@ task_params['nb_epoch'] = 6
task_params['hidden_dim'] = 512
```
Parameter dictionaries appear in **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **General**.
Parameter dictionaries appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **General**.
![image](../../../img/examples_keras_jupyter_20.png)

4
docs/guides/frameworks/keras/keras_tensorboard.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **Args**.
Command line options appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**.
![image](../../../img/examples_keras_00.png)
@ -60,6 +60,6 @@ method.
task.connect_configuration({'test': 1337, 'nested': {'key': 'value', 'number': 1}})
```
It appears in **CONFIGURATIONS** **>** **CONFIGURATION OBJECTS** **>** **General**.
It appears in **CONFIGURATION** **>** **CONFIGURATION OBJECTS** **>** **General**.
![image](../../../img/keras_colab_02.png)

6
docs/guides/frameworks/megengine/megengine_mnist.md
View File

@ -14,8 +14,8 @@ The example script does the following:
## Hyperparameters
ClearML automatically logs command line options defined with `argparse`. They appear in the experiment's **CONFIGURATIONS**
page under **HYPER PARAMETERS** **>** **Args**.
ClearML automatically logs command line options defined with `argparse`. They appear in the experiment's **CONFIGURATION**
tab under **HYPER PARAMETERS** **>** **Args**.
![Configuration tab](../../../img/examples_megengine_mnist_config.png)
@ -25,7 +25,7 @@ The example script's `train` function calls TensorBoardX's `SummaryWriter.add_sc
ClearML automatically captures the data that is added to the `SummaryWriter` object.
These scalars can be visualized in plots, which appear in the ClearML [WebApp](../../../webapp/webapp_home.md), in the
experiment's **SCALARS** page.
experiment's **SCALARS** tab.
![Scalars tab](../../../img/examples_megengine_mnist_scalars.png)

2
docs/guides/frameworks/pytorch/notebooks/audio/audio_classification_UrbanSound8K.md
View File

@ -36,7 +36,7 @@ a call to the [Task.connect](../../../../../references/sdk/task.md#connect) meth
configuration_dict = {'number_of_epochs': 10, '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 **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **General**.
Parameter dictionaries appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **General**.
![image](../../../../../img/examples_audio_classification_UrbanSound8K_01.png)

4
docs/guides/frameworks/pytorch/notebooks/image/hyperparameter_search.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS**.
optimizer task's **CONFIGURATION** **>** **HYPER PARAMETERS**.
```python
optimizer = HyperParameterOptimizer(
@ -65,7 +65,7 @@ All console output appears in the optimizer task's **CONSOLE**.
### Scalars
Scalar metrics for total accuracy and remaining budget by iteration, and a plot of total accuracy by iteration appear in the
experiment's **SCALARS**. Remaining budget indicates the percentage of total iterations for all jobs left before that total is reached.
experiment's **SCALARS** tab. Remaining budget indicates the percentage of total iterations for all jobs left before that total is reached.
ClearML automatically reports the scalars generated by `HyperParameterOptimizer`.

2
docs/guides/frameworks/pytorch/notebooks/image/image_classification_CIFAR10.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **General**.
Parameter dictionaries appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **General**.
![image](../../../../../img/examples_image_classification_CIFAR10_01.png)

2
docs/guides/frameworks/pytorch/notebooks/text/text_classification_AG_NEWS.md
View File

@ -26,7 +26,7 @@ configuration_dict = {
configuration_dict = task.connect(configuration_dict)
```
Command line options appear in **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **Args**.
Command line options appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**.
![image](../../../../../img/text_classification_AG_NEWS_01.png)

4
docs/guides/frameworks/pytorch/pytorch_abseil.md
View File

@ -41,13 +41,13 @@ Logger.current_logger().report_scalar(
```
These scalars can be visualized in plots, which appear in the [ClearML web UI](../../../webapp/webapp_overview.md), in
the experiment's page **>** **SCALARS**.
the experiment's **SCALARS** tab.
![image](../../../img/examples_pytorch_mnist_07.png)
## Hyperparameters
ClearML automatically logs command line options defined with abseil flags. They appear in **CONFIGURATIONS** **>**
ClearML automatically logs command line options defined with abseil flags. They appear in **CONFIGURATION** **>**
**HYPER PARAMETERS** **>** **TF_DEFINE**.
![image](../../../img/examples_pytorch_abseil_params.png)

2
docs/guides/frameworks/pytorch/pytorch_distributed_example.md
View File

@ -58,7 +58,7 @@ param = {'worker_{}_stuff'.format(dist.get_rank()): 'some stuff ' + str(randint(
Task.current_task().connect(param)
```
Command line options appear in **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **Args**.
Command line options appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**.
![image](../../../img/examples_pytorch_distributed_example_01.png)

2
docs/guides/frameworks/pytorch/pytorch_mnist.md
View File

@ -40,7 +40,7 @@ in the experiment's page **>** **SCALARS**.
## Hyperparameters
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **Args**.
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args**.
![image](../../../img/examples_pytorch_mnist_01.png)

2
docs/guides/frameworks/pytorch/pytorch_tensorboard.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**.
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**.
![image](../../../img/examples_pytorch_tensorboard_01.png)

2
docs/guides/frameworks/pytorch/pytorch_tensorboardx.md
View File

@ -22,7 +22,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 **CONFIGURATIONS** **>**
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>**
**HYPER PARAMETERS** **>** **Args**.
![image](../../../img/examples_pytorch_tensorboardx_01.png)

4
docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md
View File

@ -9,12 +9,12 @@ associated with the `examples` project.
## Debug Samples
The debug sample images appear according to metric, in the experiment page in the **ClearML web UI** under **DEBUG SAMPLES**.
The debug sample images appear according to metric, in the experiment's **DEBUG SAMPLES** tab.
![image](../../../img/examples_tensorboard_toy_pytorch_02.png)
## Hyperparameters
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**.
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**.
![image](../../../img/examples_tensorboard_toy_pytorch_00.png)

2
docs/guides/frameworks/tensorboardx/tensorboardx.md
View File

@ -20,7 +20,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 **CONFIGURATIONS** **>**
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>**
**HYPER PARAMETERS** **>** **Args**.
![image](../../../img/examples_pytorch_tensorboardx_01.png)

2
docs/guides/frameworks/tensorboardx/video_tensorboardx.md
View File

@ -12,7 +12,7 @@ the `examples` project.
## Debug Samples
ClearML automatically captures the video data that is added to the `SummaryWriter` object, using the `add_video` method.
The video appears in the experiment page in the ClearML web UI under **DEBUG SAMPLES**.
The video appears in the experiment's **DEBUG SAMPLES** tab.
![Debug Samples](../../../img/examples_tensorboardx_debug.png)

2
docs/guides/frameworks/tensorflow/tensorboard_pr_curve.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**.
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **TF_DEFINE**.
![image](../../../img/examples_tensorboard_pr_curve_04.png)

2
docs/guides/frameworks/tensorflow/tensorboard_toy.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>**
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS** **>**
**TF_DEFINE**.
![image](../../../img/examples_tensorboard_toy_01.png)

2
docs/guides/frameworks/tensorflow/tensorflow_mnist.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS**
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPER PARAMETERS**
**>** **TF_DEFINE**.
![image](../../../img/examples_tensorflow_mnist_01.png)

2
docs/guides/frameworks/xgboost/xgboost_metrics.md
View File

@ -11,7 +11,7 @@ the `examples` project.
## Scalars
ClearML automatically captures scalars logged with XGBoost, which can be visualized in plots in the
ClearML WebApp, in the experiment's **SCALARS** page.
ClearML WebApp, in the experiment's **SCALARS** tab.
![Scalars](../../../img/examples_xgboost_metric_scalars.png)

2
docs/guides/reporting/3d_plots_reporting.md
View File

@ -7,7 +7,7 @@ example demonstrates reporting a series as a surface plot and as a 3D scatter pl
When the script runs, it creates an experiment named `3D plot reporting`, which is associated with the `examples` project.
ClearML reports these plots in the **ClearML Web UI** **>** experiment page **>** **PLOTS** tab.
ClearML reports these plots in the experiment's **PLOTS** tab.
## Surface Plot

2
docs/guides/reporting/hyper_parameters.md
View File

@ -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 **CONFIGURATIONS** **>** **HYPER PARAMETERS**.
Hyperparameters appear in the **web UI** in the experiment's page, under **CONFIGURATION** **>** **HYPER PARAMETERS**.
Each type is in its own subsection. Parameters from older experiments are grouped together with the ``argparse`` command
line options (in the **Args** subsection).

2
docs/guides/reporting/image_reporting.md
View File

@ -48,7 +48,7 @@ Logger.current_logger().report_image(
)
```
ClearML reports these images as debug samples in the **ClearML Web UI** **>** experiment details **>**
ClearML reports these images as debug samples in the **ClearML Web UI**, under the experiment's
**DEBUG SAMPLES** tab.
![image](../../img/examples_reporting_07.png)

2
docs/guides/ui/tuning_exp.md
View File

@ -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, **CONFIGURATIONS** **>** **HYPER PARAMETERS** **>** **Args** **>** Hover and click **EDIT**.
1. In the info panel, **CONFIGURATION** **>** **HYPER PARAMETERS** **>** **Args** **>** Hover and click **EDIT**.
1. Change the value of `batch_size` from `64` to `32`.

2
docs/webapp/webapp_exp_comparing.md
View File

@ -204,7 +204,7 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
**To view a debug sample in the viewer / player:**
1. Click the debug sample click the thumbnail.
1. Click the debug sample thumbnail.
1. Do any of the following:

2
docs/webapp/webapp_exp_track_visual.md
View File

@ -377,7 +377,7 @@ Use the viewer / player to inspect images, audio, video samples and do any of th
**To view a debug sample in the viewer / player:**
1. Click the debug sample click the thumbnail.
1. Click the debug sample thumbnail.
1. Do any of the following:

6
docs/webapp/webapp_exp_tuning.md
View File

@ -138,7 +138,7 @@ 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 **CONFIGURATION** tab **>** **HYPER PARAMETERS** > **General** **>** hover **>** **EDIT** **>** add, change,
or delete keys and /or values **>** **SAVE**.
@ -150,7 +150,7 @@ 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 **CONFIGURATION** **>** **USER PROPERTIES** > **Properties** **>** hover **>** **EDIT** **>** add, change, or delete
keys and /or values **>** **SAVE**.
@ -164,7 +164,7 @@ CONFIGURATION** section. Task model configurations now appear in **CONFIGURATION
**To add, change, or delete the Task model configurations:**
* In **CONFIGURATIONS** **>** **CONFIGURATION OBJECTS** **>** **GENERAL** **>** hover **>** **EDIT** or **CLEAR** (if the
* In **CONFIGURATION** **>** **CONFIGURATION OBJECTS** **>** **GENERAL** **>** hover **>** **EDIT** or **CLEAR** (if the
configuration is not empty).
### Artifacts