mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Small edits (#526)
This commit is contained in:
@@ -28,7 +28,7 @@ The models table contains the following columns:
|
||||
| **STARTED** | Elapsed time since the run started. To view the date and time of start, hover over the elapsed time. | Date-time |
|
||||
| **UPDATED** | Elapsed time since the last update to the run. To view the date and time of update, hover over the elapsed time. | Date-time |
|
||||
| **RUN TIME** | The current / total running time of the run. | Time |
|
||||
| **_Metrics_** | Add metrics column (last, minimum, and / or maximum values). Available options depend upon the runs in the table. | Varies according to runs in table |
|
||||
| **_Metrics_** | Add metrics column (last, minimum, and/or maximum values). Available options depend upon the runs in the table. | Varies according to runs in table |
|
||||
| **_Hyperparameters_** | Add hyperparameters. Available options depend upon the runs in the table. | Varies according to runs in table |
|
||||
|
||||
## Customizing the Runs Table
|
||||
@@ -57,8 +57,8 @@ on a column, and the relevant filter appears.
|
||||
|
||||
There are a few types of filters:
|
||||
* Value set - Choose which values to include from a list of all values in the column
|
||||
* Numerical ranges - Insert minimum and / or maximum value
|
||||
* Date ranges - Insert starting and / or ending date and time
|
||||
* Numerical ranges - Insert minimum and/or maximum value
|
||||
* Date ranges - Insert starting and/or ending date and time
|
||||
* Tags - Choose which tags to filter by from a list of all tags used in the column.
|
||||
* Filter by multiple tag values using the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR" respectively. These
|
||||
options appear on the top of the tag list.
|
||||
|
||||
@@ -236,7 +236,7 @@ To assist in experiment analysis, the comparison page supports:
|
||||
experiment table with the currently compared experiments at the top.
|
||||
1. Find the experiments to add by sorting and [filtering](webapp_exp_table.md#filtering-columns) the experiments with
|
||||
the appropriate column header controls. Alternatively, use the search bar to find experiments by name.
|
||||
1. Select experiments to include in the comparison (and / or clear the selection of any experiment you wish to remove).
|
||||
1. Select experiments to include in the comparison (and/or clear the selection of any experiment you wish to remove).
|
||||
1. Click **APPLY**.
|
||||
|
||||

|
||||
|
||||
@@ -36,7 +36,7 @@ The experiments table default and customizable columns are described in the foll
|
||||
| **ITERATION** | Last or most recent iteration of the experiment. | Default |
|
||||
| **DESCRIPTION** | A description of the experiment. For cloned experiments, the description indicates it was auto generated with a timestamp. | Default (hidden) |
|
||||
| **RUN TIME** | The current / total running time of the experiment. | Default (hidden) |
|
||||
| **_Metrics_** | Add metrics column (last, minimum, and / or maximum values). The metrics depend upon the experiments in the table. See [adding metrics](#to-add-metrics). | Customizable |
|
||||
| **_Metrics_** | Add metrics column (last, minimum, and/or maximum values). The metrics depend upon the experiments in the table. See [adding metrics](#to-add-metrics). | Customizable |
|
||||
| **_Hyperparameters_** | Add hyperparameters. The hyperparameters depend upon the experiments in the table. See [adding hyperparameters](#to-add-hyperparameters). | Customizable |
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ Use experiments table customization for various use cases, including:
|
||||
* Creating a [leaderboard](#creating-an-experiment-leaderboard) that will update in real time with experiment
|
||||
performance, which can be shared and stored.
|
||||
* Sorting models by metrics - Models are associated with the experiments that created them. For each metric, use the last
|
||||
value, the minimal value, and / or the maximal value.
|
||||
value, the minimal value, and/or the maximal value.
|
||||
* Tracking hyperparameters - Track hyperparameters by adding them as columns, and applying filters and sorting.
|
||||
|
||||
Changes are persistent (cached in the browser), and represented in the URL so customized settings can be saved in a browser
|
||||
@@ -81,17 +81,17 @@ all the experiments in the project. The customizations of these two views are sa
|
||||
|
||||
|
||||
|
||||
### Adding Metrics and / or Hyperparameters
|
||||
### Adding Metrics and/or Hyperparameters
|
||||
|
||||

|
||||
|
||||
Add metrics and / or hyperparameters columns to the experiments table. The metrics and hyperparameters depend upon the
|
||||
Add metrics and/or hyperparameters columns to the experiments table. The metrics and hyperparameters depend upon the
|
||||
experiments in the table.
|
||||
|
||||
#### To Add Metrics:
|
||||
|
||||
* Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> **>** **+ METRICS** **>** Expand a metric **>** Select the **LAST** (value),
|
||||
**MIN** (minimal value), and / or **MAX** (maximal value) checkboxes.
|
||||
**MIN** (minimal value), and/or **MAX** (maximal value) checkboxes.
|
||||
|
||||
#### To Add Hyperparameters:
|
||||
|
||||
@@ -112,8 +112,8 @@ on a column, and the relevant filter appears.
|
||||
|
||||
There are a few types of filters:
|
||||
* Value set - Choose which values to include from a list of all values in the column
|
||||
* Numerical ranges - Insert minimum and / or maximum value
|
||||
* Date ranges - Insert starting and / or ending date and time
|
||||
* Numerical ranges - Insert minimum and/or maximum value
|
||||
* Date ranges - Insert starting and/or ending date and time
|
||||
* Tags - Choose which tags to filter by from a list of all tags used in the column.
|
||||
* Filter by multiple tag values using the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR" respectively. These
|
||||
options appear on the top of the tag list.
|
||||
|
||||
@@ -60,7 +60,7 @@ User parameters are editable in any experiment, except experiments whose status
|
||||
Select source code by changing any of the following:
|
||||
|
||||
* Repository, commit (select by ID, tag name, or choose the last commit in the branch), script, and /or working directory.
|
||||
* Installed Python packages and / or versions - Edit or clear (remove) them all.
|
||||
* Installed Python packages and/or versions - Edit or clear (remove) them all.
|
||||
* Uncommitted changes - Edit or clear (remove) them all.
|
||||
|
||||
**To select different source code:**
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: Model Details
|
||||
---
|
||||
|
||||
In the models table, double-click on a model to view and / or modify the following:
|
||||
In the models table, double-click on a model to view and/or modify the following:
|
||||
* General model information
|
||||
* Model configuration
|
||||
* Model label enumeration
|
||||
|
||||
@@ -223,7 +223,7 @@ The user group table lists all the active user groups. Each row includes a group
|
||||
#### To edit a user group:
|
||||
1. Hover over the user group's row on the table
|
||||
1. Click the <img src="/docs/latest/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" /> button
|
||||
1. Edit the group's name and / or description
|
||||
1. Edit the group's name and/or description
|
||||
1. Edit group members (see details [here](#to-create-a-user-group))
|
||||
1. Click **Save**
|
||||
|
||||
@@ -241,7 +241,7 @@ This feature is available under the ClearML Enterprise plan
|
||||
:::
|
||||
|
||||
Workspace administrators can use the **Access Rules** page to manage workspace permissions, by specifying which users
|
||||
and / or user groups have access permissions to the following workspace resources:
|
||||
and/or user groups have access permissions to the following workspace resources:
|
||||
|
||||
* [Projects](../fundamentals/projects.md)
|
||||
* [Tasks](../fundamentals/task.md)
|
||||
@@ -260,7 +260,7 @@ Access privileges can be viewed, defined, and edited in the **Access Rules** tab
|
||||
specific project or task), click the input box, and select the object from the list that appears. Filter the
|
||||
list by typing part of the desired object name
|
||||
1. Select the permission type - **Read Only** or **Read & Modify**
|
||||
1. Assign users and / or [user groups](#user-groups) to be given access. Click the desired input box, and select the
|
||||
1. Assign users and/or [user groups](#user-groups) to be given access. Click the desired input box, and select the
|
||||
users / groups from the list that appears. Filter the list by typing part of the desired object name. To revoke
|
||||
access, hover over a user's or group's row and click the <img src="/docs/latest/icons/ico-trash.svg" alt="Trash can" className="icon size-md" />
|
||||
button
|
||||
|
||||
Reference in New Issue
Block a user