clearml-docs/docs/webapp/webapp_profile.md

128 lines
5.4 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
title: Profile Page
---
Use the Profile page to manage a **ClearML** user account, including:
* [User preferences](#setting-user-preferences) - Set **ClearML Web UI** options.
* [Cloud Storage access for the ClearML Web UI](#providing-cloud-storage-access-for-the-clearml-web-ui) - So that the **ClearML Web UI** can render data stored in a Cloud, such as debug samples.
* [ClearML credentials](#creating-clearml-credentials) - Create **ClearML** credentials to configure **ClearML** and **ClearML Agent** (if you run **ClearML Agent** commands directly).
2021-10-21 06:42:11 +00:00
* [Configuration vault](#configuration-vault) (supported by the Enterprise Server) - Define additional **ClearML** configuration entries that are applied to all **ClearML** and **ClearML Agent** instances (which use this profile's access credentials).
2021-05-13 23:48:51 +00:00
* [Switch workspaces](#switching-workspaces) - If using multiple workspaces (are a member of more than one **ClearML Hosted Service** team), switch workspaces.
* [Invite new teammates](#inviting-new-teammates) - Collaborate with new users by inviting them to a **ClearML Hosted Service** workspace.
2021-10-21 06:42:11 +00:00
![Profile page](../img/webapp_profile.png)
## Setting User Preferences
2021-05-13 23:48:51 +00:00
2021-10-21 06:42:11 +00:00
## Setting user preferences
2021-05-23 20:17:12 +00:00
The **HiDPI browser scale override** adjusts scaling on High-DPI monitors to improve the Web UI experience. It is enabled
by default, but can be disabled.
2021-05-13 23:48:51 +00:00
Users that use their own **ClearML Server** can choose whether to send anonymous usage data to Allegro AI.
## Providing Cloud Storage Access for the ClearML Web UI
**To provide Cloud Storage access for the ClearML Web UI:**
* In the **Cloud Access** section, enter the following credentials:
* **Bucket** - The name of a Cloud bucket.
* **Key** - The access key.
* **Secret / SAS** - The secret key or shared access signature for Azure Storage.
* **Region** - The region for AWS S3.
* **Host (Endpoint)** - The host for non-AWS S3 servers.
2021-05-23 20:17:12 +00:00
## Creating ClearML Credentials
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
**ClearML** credentials include:
2021-05-13 23:48:51 +00:00
* Access key
2021-05-23 20:17:12 +00:00
* Secret key
* Web server
* API server
2021-05-13 23:48:51 +00:00
* File servers host URLs
2021-05-23 20:17:12 +00:00
**ClearML Hosted Service** users need credentials for each workspace they use. Users with their own self-hosted **ClearML Server**
2021-05-13 23:48:51 +00:00
need only one set of credentials.
2021-05-23 20:17:12 +00:00
**ClearML** credentials can be created for a current workspace. To create **ClearML** credentials for another workspace,
2021-05-13 23:48:51 +00:00
switch to it.
**To create ClearML credentials:**
2021-05-23 20:17:12 +00:00
1. Click the Profile button <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />
2021-05-13 23:48:51 +00:00
(upper right corner).
1. In **WORKSPACES**, use the current workspace or select another (self-hosted **ClearML Server** users have one workspace).
1. In **App Credentials** **>** **+ Create new credentials**.
2021-10-21 06:42:11 +00:00
## Configuration Vault
:::note Feature Support
The configuration vault is only supported by the **ClearML Enterprise Server**
:::
![Configuration vault](../img/webapp_profile_configuration_vault.png)
Use the configuration vault to enter global ClearML configuration entries in any of ClearML supported configuration
formats: HOCON / JSON / YAML. When the vault is enabled, the inputted configurations will be used by ClearML Agents and the ClearML SDK running with the user's credentials.
New entries will extend the configuration in the ClearML [configuration file](../configs/clearml_conf.md), and
existing configurations will be overridden.
**To edit vault contents:**
* Click **EDIT** or double click the vault box
* Insert / edit the configurations in the vault
* Press **OK**
**To apply vault contents:**
* Click the toggle atop the vault to enable / disable the configurations
* Once enabled, the configurations will be merged to the configuration file during ClearML and ClearML Agent usage
## Switching Workspaces
2021-05-13 23:48:51 +00:00
2021-10-21 06:42:11 +00:00
:::note Feature Support
2021-05-23 20:17:12 +00:00
Switching workspaces does not apply to users of a self-hosted **ClearML Server**
2021-05-13 23:48:51 +00:00
:::
2021-05-23 20:17:12 +00:00
**ClearML Hosted Service** users who are members of multiple teams can switch from one workspace to another.
2021-05-13 23:48:51 +00:00
**Switch workspaces in one of the following ways:**
2021-05-23 20:17:12 +00:00
* Profile button - Click <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" /> (upper right corner on any page) **>**
2021-05-13 23:48:51 +00:00
Click the workspace to switch to.
* Profile page - In the **WORKSPACES** section, click **SWITCH TO WORKSPACE** **>** Click the workspace to switch to.
2021-10-21 06:42:11 +00:00
## Inviting New Teammates
2021-05-13 23:48:51 +00:00
2021-10-21 06:42:11 +00:00
:::note Feature Support
2021-05-13 23:48:51 +00:00
Inviting new teammates does not apply to users of a self-hosted **ClearML Server**.
:::
2021-05-23 20:17:12 +00:00
**ClearML Hosted Service** users can invite other users to collaborate in their workspace. On the Profile page, the **WORKSPACES**
2021-05-13 23:48:51 +00:00
section shows the current members of the team, and whether the team has reached its maximum number of members.
**To invite a user to collaborate in your workspace:**
1. Create an invitation hyperlink with one of these options:
2021-05-23 20:17:12 +00:00
* Profile button - Click <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />
2021-05-13 23:48:51 +00:00
**>** **Invite a User** **>** Copy the invitation hyperlink.
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
* Profile page - In **WORKSPACES** **>** **Members** **>** Click **INVITE USER** **>** Copy the invitation hyperlink.
1. Send the invitation hyperlink to an invitee.
## Leaving a Workspace
2021-05-13 23:48:51 +00:00
A member of a workspace can leave the workspace and no longer be a member of that team.
**To leave a workspace:**
1. On the Profile page, in **WORKSPACES**, select the workspace to leave.
1. In **Members** **>** **Leave workspace**.