ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 13:21:46 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Edit sharing experiments page (#556)

Browse Source
This commit is contained in:
pollfly 2023-05-11 09:15:13 +03:00 committed by GitHub
parent f2519bbb3d
commit 78afff270a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/webapp/webapp_exp_sharing.md
View File

@ -2,41 +2,39 @@
title: Sharing Experiments and Models title: Sharing Experiments and Models
--- ---
:::important :::info Hosted Service Feature
This is a ClearML Hosted Service feature only. 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 **ClearML Hosted Service** users can share experiments with users in other workspaces. Sharing an experiment also shares
models, as well. Shared experiments are read-only, and they can be made private by archiving all its contents including models, artifacts, and results.
them.
**To share an experiment and its model(s):**
1. Click **Share** in one of these ways:
* In the [experiment table](webapp_exp_table.md), right-click the experiment **>** **Share**
* In the experiment info panel or full screen details view, click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
(menu) **>** **Share**.
1. Click **Create link**.
1. Copy the hyperlink and send it to a **ClearML Hosted Service** user of another workspace. Any user with this link will have
read-only access to the experiment and all its contents.
:::note :::note
When a user opens the hyperlink for a shared experiment in their browser, only that experiment appears in the experiment table. When a user opens the hyperlink for a shared experiment in their browser, only that experiment appears in the experiment table.
::: :::
## Sharing Experiments
Share experiments from the experiments table, the info panel menu, and/or the full screen details menu.
**To share an experiment and its model:**
1. Click **Share** in one of these ways:
* The experiment table - Right-click the experiment **>** **Share**
* The info panel or full screen details view - Click the experiment **>** <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
(menu) **>** **Share**.
1. Click **Create link**.
1. Copy the hyperlink and send it to a **ClearML Hosted Service** user of another workspace.
## Making Shared Experiment Private ## Making Shared Experiment Private
**To make a shared experiment private again:** **To make a shared experiment private again:**
1. Make private from the experiment table, info panel, or full screen details view (see "Sharing experiments" above). 1. Click **Share** in one of these ways:
1. Click **Share**. * The experiment table - Right-click the experiment **>** **Share**
* The experiment info panel or full screen details view **>** <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
(menu) **>** **Share**.
1. Click **Remove link**. 1. Click **Remove link**.

4
sidebars.js
View File

@ -66,11 +66,13 @@ module.exports = {
'webapp/webapp_project_overview', 'webapp/webapp_project_overview',
{ {
'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning', 'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning',
'webapp/webapp_exp_comparing', 'webapp/webapp_exp_sharing'] 'webapp/webapp_exp_comparing']
}, },
{ {
'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing'] 'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing']
}, },
'webapp/webapp_exp_sharing'
] ]
}, },
{ {