mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
This commit is contained in:
@@ -31,20 +31,22 @@ table / full screen**.
|
||||
The info panel keeps the task table in view so that [task actions](webapp_exp_table.md#task-actions)
|
||||
can be performed from the table (as well as the menu in the info panel).
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Click <img src="/docs/latest/icons/ico-compact-view.svg" alt="Compressed view" className="icon size-md space-sm" /> to
|
||||
hide details in the task table, so only the task names and statuses are displayed
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Full Screen Details View
|
||||
|
||||
The full screen details view allows for easier viewing and working with task tracking and results. The task
|
||||
table is not visible when the full screen details view is open. Perform task actions from the menu.
|
||||
|
||||

|
||||
|
||||

|
||||

|
||||
|
||||
## Execution
|
||||
A task's **EXECUTION** tab of lists the following:
|
||||
@@ -65,25 +67,29 @@ The Source Code section of a task's **EXECUTION** tab includes:
|
||||
* Working directory
|
||||
* Binary (Python executable)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Uncommitted Changes
|
||||
|
||||
ClearML displays the git diff of the task in the Uncommitted Changes section.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Python Packages
|
||||
|
||||
The Python Packages section lists the task's installed Python packages and their versions.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
When a ClearML agent executing a task ends up using a different set of Python packages than was originally
|
||||
specified, both the original specification (`original pip` or `original conda`), and the packages the agent ended up
|
||||
using to set up an environment (`pip` or `conda`) are available. Select which requirements to view in the dropdown menu.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Container
|
||||
The Container section list the following information:
|
||||
@@ -102,14 +108,16 @@ clearml-agent daemon --queue <execution_queue_to_pull_from> --docker [optional d
|
||||
For more information, see [Docker Mode](../clearml_agent/clearml_agent_execution_env.md#docker-mode).
|
||||
:::
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Output
|
||||
The Output details include:
|
||||
* The output destination used for storing model checkpoints (snapshots) and artifacts (see also, [default_output_uri](../configs/clearml_conf.md#config_default_output_uri)
|
||||
in the configuration file, and `output_uri` in [`Task.init`](../references/sdk/task.md#taskinit) parameters).
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -127,7 +135,8 @@ The **Args** group shows automatically logged argument parser parameters (e.g. `
|
||||
Hover over <img src="/docs/latest/icons/ico-description.svg" alt="Description" className="icon size-md space-sm" /> (menu) on a
|
||||
parameter's line, and the type, description, and default value appear, if they were provided.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
#### Environment Variables
|
||||
|
||||
@@ -138,7 +147,8 @@ field of the `clearml.conf` file, the **Environment** group displays the listed
|
||||
The `CLEARML_LOG_ENVIRONMENT` variable always overrides the `clearml.conf` file.
|
||||
:::
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
#### Custom Parameter Groups
|
||||
|
||||
@@ -146,33 +156,37 @@ Custom parameter groups show parameter dictionaries if the parameters were conne
|
||||
[`Task.connect()`](../references/sdk/task.md#connect) with a `name` argument provided. `General` is the default section
|
||||
if a name is not provided.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
#### TensorFlow Definitions
|
||||
|
||||
The **TF_DEFINE** parameter group shows automatic TensorFlow logging.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### User Properties
|
||||
|
||||
User properties allow to store any descriptive information in a key-value pair format. They are editable in any task,
|
||||
except *Published* ones (read-only).
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Configuration Objects
|
||||
|
||||
ClearML tracks a task's 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 object (see the `name`
|
||||
parameter in [`Task.connect_configuration`](../references/sdk/task.md#connect_configuration)).
|
||||
|
||||

|
||||
|
||||

|
||||

|
||||
|
||||
## Artifacts
|
||||
|
||||
@@ -190,7 +204,8 @@ to obtain the file path to facilitate local storage access since web application
|
||||
* **Remote Files** (e.g. network-hosted artifacts with `https://`, `s3://`, etc. URIs): Use the download action (<img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-md space-sm" />)
|
||||
to retrieve the file.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Models
|
||||
|
||||
@@ -201,7 +216,8 @@ The task's input and output models appear in the **ARTIFACTS** tab. Each model e
|
||||
|
||||
Input models also display their creating task, which on-click navigates you to the task's page.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
To view more model details, including design, label enumeration, and general information, click the model name
|
||||
to navigate to its page in the **MODELS** tab (see [Model Details](webapp_model_viewing.md)).
|
||||
@@ -229,7 +245,8 @@ The Enterprise Server also displays a detailed history of task activity:
|
||||
|
||||
To download the task history as a CSV file, hover over the log and click <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
:::note Limited persistency
|
||||
ClearML maintains a system-wide, large but strict limit for task history items. Once the limit is reached, the oldest entries are purged to make room for fresh entries.
|
||||
@@ -260,7 +277,8 @@ The **Task Details** section lists information describing the task:
|
||||
* Python version
|
||||
* Task Progress
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Task Results
|
||||
|
||||
@@ -275,8 +293,8 @@ tools (e.g. Notion). See [Plot Controls](#plot-controls).
|
||||
The complete task log containing everything printed to stdout and stderr appears in the **CONSOLE** tab. The full log
|
||||
is downloadable. To view the end of the log, click **Jump to end**.
|
||||
|
||||

|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
### Scalars
|
||||
@@ -302,7 +320,8 @@ to update the graph.
|
||||
Single value scalars (see [`Logger.report_single_value`](../references/sdk/logger.md#report_single_value)) are shown in
|
||||
a `Summary` table.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Use the scalar tools to improve analysis of scalar metrics. In the info panel, click <img src="/docs/latest/icons/ico-settings.svg" alt="Settings gear" className="icon size-md space-sm" /> to use the tools. In the full screen details view, the tools
|
||||
are on the left side of the window. The tools include:
|
||||
@@ -313,13 +332,15 @@ are on the left side of the window. The tools include:
|
||||
* **Metric** - Displays all variants for a metric on the same plot. For example, if you have a "Test" metric with
|
||||
"loss" and "accuracy" variants, both variants will appear on the same plot that is titled "Test".
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
* **None** - Displays individual plots for each metric-variant combination, grouped into sections by metric. For
|
||||
example, a "Test" metric with "loss" and "accuracy" variants will have a separate plot for each variant under the
|
||||
"Test" group.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
* Horizontal axis - Select the x-axis units:
|
||||
* Iterations
|
||||
@@ -336,7 +357,8 @@ which will copy to clipboard the embed code to put in your Reports. To quickly g
|
||||
specific metric, click Embed <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-md space-sm" />
|
||||
on the group section header (available when plots are [grouped by](#group_by) `None`).
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
In contrast to static screenshots, embedded resources
|
||||
are retrieved when the report is displayed allowing your reports to show the latest up-to-date data.
|
||||
@@ -356,7 +378,8 @@ shows a table summary of your metrics with a row per metric/variant:
|
||||
|
||||
If all the values of a specific metric/variant are the same, the row will display a <img src="/docs/latest/icons/ico-equal-outline.svg" alt="Same values" className="icon size-md space-sm" /> sign.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Choose which metrics to view using one of the following out the options:
|
||||
* Use the quick filter bar (<img src="/docs/latest/icons/ico-search.svg" alt="Magnifying glass" className="icon size-md space-sm" />)
|
||||
@@ -371,7 +394,8 @@ Non-time-series plots appear in **PLOTS**. These include data generated by libra
|
||||
explicitly reported using the ClearML Logger. These may include 2D and 3D plots, tables (Pandas and CSV files), and
|
||||
Plotly plots. Individual plots can be shown / hidden or filtered by title.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Plots are grouped into sections by metric. To quickly get the embed codes for all plots of a specific metric, click Embed <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-md space-sm" />
|
||||
on the group section header.
|
||||
@@ -384,7 +408,8 @@ previous/next plot in the current iteration using the <img src="/docs/latest/ico
|
||||
buttons (or using the left/right arrow keyboard shortcut).
|
||||
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
#### Plot Controls
|
||||
|
||||
@@ -431,7 +456,8 @@ libraries and visualization tools, and explicitly reported using the [ClearML Lo
|
||||
You can view debug samples by metric in the reported iterations. Filter the samples by metric by selecting a metric from the
|
||||
dropdown menu above the samples. The most recent iteration appears first.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
For each metric, the latest reported debug sample is displayed.
|
||||
|
||||
@@ -442,7 +468,8 @@ arrow keyboard shortcut). Go to the previous/next sample in the current iteratio
|
||||
buttons (or using the left/right arrow keyboard shortcut).
|
||||
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Tagging Tasks
|
||||
|
||||
|
||||
Reference in New Issue
Block a user