Add table view persistence notes (#9)

This commit is contained in:
pollfly 2021-07-14 10:37:55 +03:00 committed by GitHub
parent 3b73334908
commit 13b7ac4d82
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 42 additions and 5 deletions

View File

@ -9,7 +9,7 @@ The **Dataviews table** is a [customizable](#customizing-the-dataviews-table) li
Use it to [view, create, and edit Dataviews](#viewing-adding-and-editing-dataviews) in the info panel. Dataview tables Use it to [view, create, and edit Dataviews](#viewing-adding-and-editing-dataviews) in the info panel. Dataview tables
can be filtered by name or name fragments and / or ID, by using the search bar. can be filtered by name or name fragments and / or ID, by using the search bar.
![image](../../img/hyperdatasets/dataviews_table_01.png) ![Dataviews table](../../img/hyperdatasets/dataviews_table_01.png)
The Dataviews table columns in their default order are below. Dynamically order the columns by dragging a column heading The Dataviews table columns in their default order are below. Dynamically order the columns by dragging a column heading
to a new position. to a new position.
@ -31,6 +31,18 @@ Customize any combination of the following:
* Sort columns - By experiment name and / or elapsed time since creation. * Sort columns - By experiment name and / or elapsed time since creation.
* Column autofit - In the column heading, double click a resizer (column separator). * Column autofit - In the column heading, double click a resizer (column separator).
:::note
The following Dataviews-table customizations are saved on a **per project** basis:
* Column order
* Column width
* Active sort order
* Active filters
If a project has sub-projects, the Dataviews can be viewed by their sub-project groupings or together with
all the Dataviews in the project. The customizations of these two views are saved separately.
:::
## Viewing, adding, and editing Dataviews ## Viewing, adding, and editing Dataviews
**To view, add, or edit a Dataview:** **To view, add, or edit a Dataview:**

View File

@ -12,7 +12,7 @@ To assist in focusing on active experimentation, experiments and models can be a
in the active experiments and models tables. See [Archiving](webapp_archiving). in the active experiments and models tables. See [Archiving](webapp_archiving).
::: :::
![image](../img/webapp_exp_table_01.png) ![Experiment table](../img/webapp_exp_table_01.png)
## Experiments table columns ## Experiments table columns
@ -55,10 +55,23 @@ Use experiments table customization for various use cases, including:
Changes are persistent (cached in the browser), and represented in the URL so customized settings can be saved in a browser Changes are persistent (cached in the browser), and represented in the URL so customized settings can be saved in a browser
bookmark and shared with other **ClearML** users to collaborate. bookmark and shared with other **ClearML** users to collaborate.
:::note
The following experiments-table customizations are saved on a **per project** basis:
* Columns order
* Column width
* Active sort order
* Active filters
* Custom columns
If a project has sub-projects, the experiments can be viewed by their sub-project groupings or together with
all the experiments in the project. The customizations of these two views are saved separately.
:::
### Adding metrics and / or hyperparameters ### Adding metrics and / or hyperparameters
![image](../img/gif/webapp_exp_table_cust.gif) ![Experiment table customization gif](../img/gif/webapp_exp_table_cust.gif)
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. experiments in the table.
@ -125,4 +138,4 @@ based on their name by using the search bar.
The final dashboard can be shared by copying the URL from the address bar, this address will replicate the exact same dashboard on any browser. The final dashboard can be shared by copying the URL from the address bar, this address will replicate the exact same dashboard on any browser.
The dashboard can also be bookmarked for later use. The dashboard can also be bookmarked for later use.
![image](../img/webapp_exp_table_sharing.png) ![Experiment table sharing](../img/webapp_exp_table_sharing.png)

View File

@ -5,7 +5,7 @@ title: The Models Table
The models table is a [customizable](#customizing-the-models-table) list of models associated with the experiments in a project. From the models table, The models table is a [customizable](#customizing-the-models-table) list of models associated with the experiments in a project. From the models table,
view model details, and modify, publish, archive, tag, and move models to other projects. view model details, and modify, publish, archive, tag, and move models to other projects.
![image](../img/webapp_models_01.png) ![Models table](../img/webapp_models_01.png)
## Models table columns ## Models table columns
@ -39,6 +39,18 @@ Customize any combination of the following:
* Sort columns - Metrics and hyperparameters, type of experiment, experiment name, start and last update elapsed time, and last iteration. * Sort columns - Metrics and hyperparameters, type of experiment, experiment name, start and last update elapsed time, and last iteration.
* Column autofit - In the column heading, double click a resizer (column separator). * Column autofit - In the column heading, double click a resizer (column separator).
:::note
The following models-table customizations are saved on a **per project** basis:
* Columns order
* Column width
* Active sort order
* Active filters
* Custom columns
If a project has sub-projects, the models can be viewed by their sub-project groupings or together with
all the models in the project. The customizations of these two views are saved separately.
:::
## ClearML Actions from the models table ## ClearML Actions from the models table
The following table describes the **ClearML** features that can be used from the models table, including the states that The following table describes the **ClearML** features that can be used from the models table, including the states that