mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Update docs for ClearML server 1.6 (#280)
This commit is contained in:
pollfly
GitHub
50
docs/webapp/datasets/webapp_dataset_page.md
Normal file
50
docs/webapp/datasets/webapp_dataset_page.md
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Datasets Page
|
||||
---
|
||||
|
||||
:::tip version compatibility
|
||||
To use the WebApp's Dataset pages, you must use `clearml` and `clearml-server` versions 1.6+.
|
||||
:::
|
||||
|
||||
Use the **Datasets** Page to navigate between and manage datasets. The page shows summaries
|
||||
for all datasets created using [ClearML Data](../../clearml_data/clearml_data.md).
|
||||
|
||||
Click on a dataset card to navigate to its [Version List](webapp_dataset_viewing.md), where you can view the
|
||||
dataset versions' lineage and contents.
|
||||
|
||||
|
||||
|
||||
|
||||
## Dataset Cards
|
||||
|
||||
The dataset cards display summarized dataset information:
|
||||
|
||||
<div class="max-w-50">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
* Dataset name
|
||||
* Time since last update
|
||||
* Number of versions
|
||||
* Details about latest version
|
||||
* Number of files
|
||||
* Size
|
||||
* Tags
|
||||
|
||||
### Dataset Actions
|
||||
|
||||
Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> on the top right
|
||||
of a dataset card to open its context menu and access dataset actions.
|
||||
|
||||
<div class="max-w-50">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
* **Rename** - Change the dataset’s name
|
||||
* **Add Tag** - Add label to the dataset to help easily classify groups of dataset.
|
||||
* **Delete** - Delete the dataset and all of its versions. To delete a dataset, all its versions must first be
|
||||
[archived](../webapp_archiving.md).
|
||||
95
docs/webapp/datasets/webapp_dataset_viewing.md
Normal file
95
docs/webapp/datasets/webapp_dataset_viewing.md
Normal file
@@ -0,0 +1,95 @@
|
||||
---
|
||||
title: Dataset Details
|
||||
---
|
||||
|
||||
:::tip version compatibility
|
||||
To use the WebApp's Dataset pages, you must use `clearml` and `clearml-server` versions 1.6+.
|
||||
:::
|
||||
|
||||
The dataset page lists the dataset's versions. For a selected version, the **Dataset Version Panel** shoes its lineage
|
||||
in graph form.
|
||||
|
||||
|
||||
|
||||
Each node in the graph represents a dataset version, and shows the following details:
|
||||
|
||||
<div class="max-w-50">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
* Version name and number
|
||||
* Version size
|
||||
* Version update time
|
||||
* Version details button - Hover over the version and click <img src="/docs/latest/icons/ico-console.svg" alt="console" className="icon size-md space-sm" />
|
||||
to view the version’s [details panel](#version-details-panel)
|
||||
|
||||
## Version Details
|
||||
### Version Info
|
||||
|
||||
On the right side of the dataset version panel, view the **VERSION INFO** which shows:
|
||||
* Version name
|
||||
* Dataset ID
|
||||
* Version file size
|
||||
* Number of files
|
||||
* Number of links
|
||||
* Changes from previous version
|
||||
* Number of files added
|
||||
* Number of files modified
|
||||
* Number of files removed
|
||||
* Change in size
|
||||
|
||||
<div class="max-w-50">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
To view a version’s detailed information, click **Full details**, which will open the dataset version’s [task page](../webapp_exp_track_visual.md).
|
||||
|
||||
|
||||
|
||||
To view the information for any version in the lineage graph, click its node, and the **VERSION INFO** panel displays
|
||||
that version's details.
|
||||
|
||||
### Version Details Panel
|
||||
|
||||
Click on **DETAILS** on the top left of the info panel or hover over a version node and click <img src="/docs/latest/icons/ico-console.svg" alt="details" className="icon size-md space-sm" />
|
||||
to view:
|
||||
* **CONTENT** - Table summarizing version contents, including file names, file sizes, and hashes
|
||||
* **PREVIEW** - A preview of the dataset version's contents
|
||||
access [plot tools](../webapp_exp_track_visual.md#scalar-plot-tools). Click on a debug sample to expand it.
|
||||
* **CONSOLE** - The dataset version’s console output
|
||||
|
||||
Click <img src="/docs/latest/icons/ico-max-panel.svg" alt="Expand" className="icon size-md space-sm" /> to on the content panel header to view the panel in full screen.
|
||||
|
||||
## Dataset Actions
|
||||
The following table describes the actions that can be done from the dataset versions list.
|
||||
|
||||
Access these actions with the context menu by right-clicking a version on the dataset versions list.
|
||||
|
||||
| Action | Description |
|
||||
|-----|----|
|
||||
|Add Tag |User-defined labels added to versions for grouping and organization. |
|
||||
|Archive| To more easily work with active dataset versions, archive a version. [See Archiving](../webapp_archiving.md).|
|
||||
|Restore|Action available in the archive. Restore a version to the active dataset versions table.|
|
||||
|Delete| Delete an archived version and its artifacts. This action is available only from the dataset’s archive |
|
||||
|
||||
|
||||
|
||||
The actions mentioned in the chart above can be performed on multiple versions at once. [Select multiple versions](#selecting-multiple-versions),
|
||||
then use either the context menu, or the bar that appears at the bottom of the page, to perform operations on the
|
||||
selected versions.
|
||||
|
||||
## Selecting Multiple Versions
|
||||
Select multiple versions by clicking the checkbox on the left of each relevant version. Clear any existing selection by
|
||||
clicking the checkbox in the top left corner of the list.
|
||||
|
||||
Click the checkbox in the top left corner of the list to select all items currently visible.
|
||||
|
||||
An extended bulk selection tool is available through the down arrow next to the checkbox in the top left corner, enabling selecting items beyond the items currently on-screen:
|
||||
* All - Select all versions in the dataset
|
||||
* None - Clear selection
|
||||
* Filtered - Select all versions in the dataset that match the current active filters
|
||||
|
||||
@@ -313,6 +313,11 @@ Individual plots can be shown / hidden or filtered by title.
|
||||
|
||||
|
||||
|
||||
The last iteration of each plot is displayed. Viewing a plot in full
|
||||
screen (<img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" />)
|
||||
provides navigation to plots from previous iterations.
|
||||
|
||||
|
||||
|
||||
#### Plot Controls
|
||||
|
||||
|
||||
@@ -13,8 +13,10 @@ The **ClearML Web UI** is the graphical user interface for the ClearML platform,
|
||||
|
||||
|
||||
The ClearML Web UI is composed of the following pages:
|
||||
* [Dashboard](webapp_home.md) - The dashboard for recent activity and quick access to experiments and projects.
|
||||
* [Projects](webapp_projects_page.md) - The main experimentation page. Access your experiments and models as they are organized into projects.
|
||||
* [Dashboard](webapp_home.md) <img src="/docs/latest/icons/ico-bars-homepage.svg" className="icon size-md space-sm" /> -
|
||||
The dashboard for recent activity and quick access to experiments and projects.
|
||||
* [Projects](webapp_projects_page.md) <img src="/docs/latest/icons/ico-bars-projects.svg" className="icon size-md space-sm" /> -
|
||||
The main experimentation page. Access your experiments and models as they are organized into projects.
|
||||
The [experiments](webapp_exp_table.md) and [models](webapp_model_table.md) are displayed in tables
|
||||
which let you:
|
||||
* [Track ongoing experiments and visualize their results](webapp_exp_track_visual.md)
|
||||
@@ -23,9 +25,9 @@ The ClearML Web UI is composed of the following pages:
|
||||
* [Compare experiments](webapp_exp_comparing.md)
|
||||
* [Share experiments and their models](webapp_exp_sharing.md) with other ClearML hosted service users
|
||||
* [Archive experiments and models](webapp_archiving.md)
|
||||
|
||||
* [Pipelines](pipelines/webapp_pipeline_page.md) - View and manage your pipelines.
|
||||
* [Workers and Queues](webapp_workers_queues.md) - The resource monitoring and queues management page.
|
||||
* [Datasets](datasets/webapp_dataset_page.md) <img src="/docs/latest/icons/ico-side-bar-datasets.svg" alt="Datasets" className="icon size-md space-sm" /> - View and manage your datasets.
|
||||
* [Pipelines](pipelines/webapp_pipeline_page.md) <img src="/docs/latest/icons/pipelines.svg" className="icon size-md space-sm" /> - View and manage your pipelines.
|
||||
* [Workers and Queues](webapp_workers_queues.md) <img src="/docs/latest/icons/ico-workers.svg" alt="Workers and Queues" className="icon size-md space-sm" /> - The resource monitoring and queues management page.
|
||||
|
||||
* [Settings](webapp_profile.md) (available through the profile menu <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />) -
|
||||
Manage your ClearML user account:
|
||||
@@ -37,8 +39,6 @@ The ClearML Web UI is composed of the following pages:
|
||||
* Manage users and workspaces
|
||||
* Manage resource access permissions (available in the ClearML Enterprise plan)
|
||||
|
||||
|
||||
|
||||
|
||||
## WebApp Menus
|
||||
|
||||
|
||||
Reference in New Issue
Block a user