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

Rewrite model config example, fix configuration terminology (#45)

Browse Source
This commit is contained in:
pollfly
2021-08-22 15:23:48 +03:00
committed by GitHub
parent df935fa049
commit de1f0e559f
5 changed files with 37 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/webapp/webapp_exp_track_visual.md
View File

@@ -131,13 +131,13 @@ Hyperparameters are grouped by their type and appear in **CONFIGURATION** **>**
#### Command line arguments
The **Args** section 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** 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.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
![Command line arguments configuration section](../img/webapp_tracking_22.png)
![Command line arguments configuration group](../img/webapp_tracking_22.png)
</div>
</details>
@@ -145,13 +145,13 @@ The **Args** section shows automatically logged `argparse` arguments, and all ol
#### Environment variables
If the `CLEARML_LOG_ENVIRONMENT` variable was set, the **Environment** section will show environment variables (see [this FAQ](../faq#track-env-vars)).
If the `CLEARML_LOG_ENVIRONMENT` variable was set, the **Environment** group will show environment variables (see [this FAQ](../faq#track-env-vars)).
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
![Environment variables configuration section](../img/webapp_tracking_23.png)
![Environment variables configuration group](../img/webapp_tracking_23.png)
</div>
</details>
@@ -159,27 +159,27 @@ If the `CLEARML_LOG_ENVIRONMENT` variable was set, the **Environment** section w
#### Custom parameter groups
Custom sections shows parameter dictionaries, if the parameters were connected to the Task, using the `Task.connect` method,
Custom parameter groups show parameter dictionaries if the parameters were connected to the Task, using the `Task.connect` method,
with a `name` argument provided.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
![Custom parameters section](../img/webapp_tracking_25.png)
![Custom parameters group](../img/webapp_tracking_25.png)
</div>
</details>
#### TensorFlow Definitions
The **TF_DEFINE** sections shows automatic TensorFlow logging.
The **TF_DEFINE** parameter group shows automatic TensorFlow logging.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
![TF_DEFINE parameter section](../img/webapp_tracking_26.png)
![TF_DEFINE parameter group](../img/webapp_tracking_26.png)
</div>
</details>
@@ -205,7 +205,7 @@ except experiments whose status is *Published* (read-only).
**ClearML** tracks experiment (Task) model configuration objects, which appear in **Configuration Objects** **>** **General**.
These objects include those that are automatically tracked, and those connected to a Task in code (see [Task.connect_configuration](../references/sdk/task.md#connect_configuration)).
**ClearML** supports providing a name for a Task model configuration (see the [name](../references/sdk/task.md#connect_configuration)
**ClearML** supports providing a name for a Task model configuration object (see the [name](../references/sdk/task.md#connect_configuration)
parameter in `Task.connect_configuration`.
:::important