clearml-docs/docs/webapp/webapp_profile.md

100 lines
4.1 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).
* [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.
## Setting User Preferences
2021-05-13 23:48:51 +00:00
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**.
## Switching Workspaces
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
:::note
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.
## Inviting New Teammates
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
:::note
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**.