ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-05-21 12:36:42 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Remove archive page (#551)

Browse Source
This commit is contained in:
pollfly 2023-05-07 13:38:27 +03:00 committed by GitHub
parent e7ca3daf01
commit 320991ef13
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 40 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/hyperdatasets/webapp/webapp_dataviews.md
View File

@ -14,6 +14,10 @@ using the buttons on the top left of the page. Use the table view for a comparat
columns of interest. Use the details view to access a selected Dataview’s details, while keeping the Dataview list in view.
Details view can also be accessed by double-clicking a specific Dataview in the table view to open its details view.
You can archive Dataviews so the Dataviews table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
table to open the archive and view all archived Dataviews. From the archive, you can restore
Dataviews to remove them from the archive. You can also permanently delete Dataviews.
![Dataviews table](../../img/hyperdatasets/webapp_dataviews_table.png)
The Dataviews table includes the following columns:
@ -68,8 +72,9 @@ Access these actions with the context menu in any of the following ways:
| ClearML Action | Description |
|---|---|
| Details | View Dataview details, including input datasets, label mapping, augmentation operations, and iteration control. Can also be accessed by double-clicking a Dataview in the Dataviews table. |
| Archive | To more easily work with active Dataviews, move a Dataview to the archive, removing it from the active Dataview table. |
| Archive | Move Dataview to the Dataview's archive. |
| Restore | Action available in the archive. Restore a Dataview to the active Dataviews table. |
| Delete | Action available in the archive. Permanently delete a Dataview. |
| Clone | Make an exact copy of a Dataview that is editable. |
| Move to Project | Move a Dataview to another project. |
| Publish | Publish a Dataview to prevent changes to it. *Published* Dataviews are read-only.|

2
docs/webapp/datasets/webapp_dataset_page.md
View File

@ -77,4 +77,4 @@ of a dataset card to open its context menu and access dataset actions.
* **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).
archived.

8
docs/webapp/datasets/webapp_dataset_viewing.md
View File

@ -26,6 +26,12 @@ Each node in the graph represents a dataset version, and shows the following det
* 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)
:::tip archiving versions
You can archive dataset versions so the versions list doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of
the list to open the archive and view all archived versions. From the archive, you can restore
versions to remove them from the archive. You can also permanently delete versions.
:::
## Version Details
### Version Info
@ -83,7 +89,7 @@ Access these actions with the context menu by right-clicking a version on the da
| 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).|
|Archive| Move dataset versions to the dataset's archive. |
|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 |

2
docs/webapp/pipelines/webapp_pipeline_page.md
View File

@ -65,4 +65,4 @@ of a pipeline card to open its context menu and access pipeline actions.
* **Rename** - Change the pipeline’s name
* **Add Tag** - Add label to the pipeline to help easily classify groups of pipelines.
* **Delete** - Delete the pipeline: delete all its runs and any models/artifacts produced (a list of remaining artifacts
is returned). To delete a pipeline, all its runs must first be [archived](../webapp_archiving.md).
is returned). To delete a pipeline, all its runs must first be archived.

6
docs/webapp/pipelines/webapp_pipeline_table.md
View File

@ -12,6 +12,10 @@ using the buttons on the top left of the page. Use the table view for a comparat
columns of interest. Use the details view to access a selected run’s details, while keeping the pipeline runs list in view.
Details view can also be accessed by double-clicking a specific pipeline run in the table view to open its details view.
You can archive pipeline runs so the runs table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
table to open the archive and view all archived runs. From the archive, you can restore
runs to remove them from the archive. You can also permanently delete runs.
![Pipeline runs table](../../img/webapp_pipeline_runs_table.png)
## Run Table Columns
@ -105,7 +109,7 @@ Access these actions with the context menu in any of the following ways:
| Abort | Manually stop / cancel a run. | *Running* / *Pending* | *Aborted* |
| Continue | Rerun with the same parameters. | *Aborted* | *Pending* |
| Add Tag | User-defined labels added to runs for grouping and organization. | Any state | None |
| Archive | To more easily work with active runs, archive a run. See [Archiving](../webapp_archiving.md). | Any state | None |
| Archive | Move pipeline run to the pipeline's archive. | Any state | *Pending* to *Draft* |
| Restore | Action available in the archive. Restore a run to the active pipeline runs table. | Any state | None |
| Delete | Action available in the archive. Delete a run and its steps, which will also remove all their logs, results, artifacts and debug samples | Any State | N/A |

42
docs/webapp/webapp_archiving.md
View File

@ -1,42 +0,0 @@
---
title: Archiving
---
Archive experiments and models to improve the organization of active work. Archived experiments and models do not appear
in the active (main) experiments and models tables. They only appear in the archive. Experiments can be restored from the
archive.
When archiving an experiment:
* If it is enqueued to execute (its status is *Pending*), the experiment is automatically dequeued (its status becomes
*Draft*).
* If it is shared (**ClearML Hosted Service** only), the experiment becomes private.
**To archive experiments or models:**
* Archive an experiment or model from either the:
* Experiments or models table - Right-click the experiment or model **>** **Archive**.
* Info panel or full screen details view - Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu) **>** **Archive**.
* Archive multiple experiments or models from the:
* Experiments or models table - Multi-select or individually select the checkboxes of the experiments to archive **>** In the footer menu that appears, click **ARCHIVE**.
**To restore experiments or models:**
1. Go to the experiment table of the archived experiment's project, or to the **All Projects** experiments table.
1. Click **OPEN ARCHIVE** on the top left of the page.
1. Select the experiment(s) or model(s):
* Restore an experiment or model from either the:
* Experiments or models table - Right-click the experiment or model **>** **Restore**.
* Info panel or full screen details view - Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" />
(menu) **>** **Restore from Archive**.
* Restore multiple experiments or models from the:
* Experiments or models table - Multi-select or individually select the checkboxes of the experiments to restore **>** Click **Restore** in the footer menu that appears.

4
docs/webapp/webapp_exp_sharing.md
View File

@ -7,7 +7,7 @@ This is a ClearML Hosted Service feature only.
:::
**ClearML Hosted Service** users can share experiments with users of another workspace. Sharing an experiment shares its
models, as well. Shared experiments are read-only, and they can be made private by [archiving](webapp_archiving.md)
models, as well. Shared experiments are read-only, and they can be made private by archiving
them.
:::note
@ -40,4 +40,4 @@ Share experiments from the experiments table, the info panel menu, and/or the fu
1. Click **Remove link**.
Another option is to [archive](webapp_archiving.md) the experiment. When archiving the experiment, it automatically becomes private.
Another option is to archive the experiment, which makes the experiment private.

12
docs/webapp/webapp_exp_table.md
View File

@ -10,11 +10,16 @@ View the experiments table in table view <img src="/docs/latest/icons/ico-table-
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your experiments according
to columns of interest. Use the details view to access a selected experiment’s details, while keeping the experiment list
in view. Details view can also be accessed by double-clicking a specific experiment in the table view to open its details view.
in view. Details view can also be accessed by double-clicking a specific experiment in the table view to open its details view.
You can archive experiments so the experiments table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
table to open the archive and view all archived experiments. From the archive, you can restore
experiments to remove them from the archive. You can also permanently delete experiments.
:::info
To assist in focusing on active experimentation, experiments and models can be archived, so they will not appear
in the active experiments and models tables. See [Archiving](webapp_archiving.md).
in the active experiments and models tables.
:::
![Experiment table](../img/webapp_experiment_table.png)
@ -144,8 +149,9 @@ to open the context menu
| Manage Queue | If an experiment is *Pending* in a queue, view the utilization of that queue, manage that queue (remove experiments and change the order of experiments), and view information about the worker(s) listening to the queue. See the [Workers and Queues](webapp_workers_queues.md) page. | *Enqueued* | None |
| View Worker | If an experiment is *Running*, view resource utilization, worker details, and queues to which a worker is listening. | *Running* | None |
| Share | For **ClearML Hosted Service** users only, [share](webapp_exp_sharing.md) an experiment and its model with a **ClearML Hosted Service** user in another workspace. | Any state | None |
| Archive | To more easily work with active experiments, move an experiment to the archive. See [Archiving](webapp_archiving.md). | Any state | None |
| Archive | Move experiment to the project's archive. If it is shared (ClearML Hosted Service only), the experiment becomes private. | Any state | *Pending* to *Draft* |
| Restore |Action available in the archive. Restore an experiment to the active experiments table.| Any State | None |
| Delete | Action available in the archive. Delete an experiment, which will also remove all their logs, results, artifacts and debug samples. | Any State | N/A |
| Enqueue | Add an experiment to a queue for a worker or workers (listening to the queue) to execute. | *Draft* | *Pending* |
| Dequeue | Remove an experiment from a queue. | *Pending* | *Draft* |
| Reset | Delete the log and output from a previous run of an experiment (for example, before rerunning it). | *Completed*, *Aborted*, or *Failed* | *Draft* |

9
docs/webapp/webapp_model_table.md
View File

@ -11,6 +11,10 @@ using the buttons on the top left of the page. Use the table view for a comparat
columns of interest. Use the details view to access a selected model’s details, while keeping the model list in view.
Details view can also be accessed by double-clicking a specific model in the table view to open its details view.
You can archive models so the models table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
table to open the archive and view all archived models. From the archive, you can restore
models to remove them from the archive, and permanently delete models.
![Models table](../img/webapp_models_01.png)
## Models Table Columns
@ -75,8 +79,9 @@ Access these actions with the context menu in any of the following ways:
|---|---|--|
| Details | View model details, which include general information, the model configuration, and label enumeration. Can also be accessed by double-clicking a model in the models table | Any state |
| Publish | Publish a model to prevent changes to it. *Published* models are read-only. If a model is Published, its experiment also becomes Published (read-only). | *Draft* |
| Archive | To more easily work with active models, move a model to the archive. See [Archiving](webapp_archiving.md). | Any state |
| Restore | Action available in the archive. Restore a model to the active model table. | Any state |
| Archive | Move model to the project's archive. | Any state |
| Restore | Action available in the archive. Restore a model to the main model table. | Any state |
| Delete | Action available in the archive. Permanently delete the model. This will also remove the model weights file. Note that experiments using deleted models will no longer be able to run. | Any state |
| Add Tag | Tag models with color-coded labels to assist in organizing work. See [tagging models](#tagging-models). | Any state |
| Download | Download a model. The file format depends upon the framework. | *Published* |
| Move to Project | To organize work and improve collaboration, move a model to another project. | Any state |

1
docs/webapp/webapp_overview.md
View File

@ -24,7 +24,6 @@ The WebApp's sidebar provides access to the following modules:
* [Tune experiments with no code change](webapp_exp_tuning.md)
* [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)
* [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/ico-pipelines.svg" alt="Pipelines" className="icon size-md space-sm" /> - View and manage your pipelines.
* [Reports](webapp_reports.md) <img src="/docs/latest/icons/ico-reports.svg" alt="Reports" className="icon size-md space-sm" /> - View and manage your reports.

3
docs/webapp/webapp_projects_page.md
View File

@ -50,7 +50,8 @@ of a project folder to open its context menu and access the following project ac
* **Rename** - Rename the project.
* **New Project** - Create a new project (by default a subproject).
* **Move to** - Move the project into another project. If the target project does not exist, it is created on-the-fly.
* **Delete** - Delete the project. To delete a project, all of its experiments must be [archived](webapp_archiving.md) first.
* **Delete** - Delete the project. To delete a project, all of its all contents (i.e. any pipelines/reports/datasets) must
first be archived or removed.
## Create New Projects

1
sidebars.js
View File

@ -71,7 +71,6 @@ module.exports = {
{
'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing']
},
'webapp/webapp_archiving'
]
},
{