mirror of
https://github.com/clearml/clearml-docs
synced 2025-01-31 22:48:40 +00:00
100 lines
4.1 KiB
Markdown
100 lines
4.1 KiB
Markdown
---
|
|
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
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
## Creating ClearML credentials
|
|
|
|
**ClearML** credentials include:
|
|
* Access key
|
|
* Secret key
|
|
* Web server
|
|
* API server
|
|
* File servers host URLs
|
|
|
|
**ClearML Hosted Service** users need credentials for each workspace they use. Users with their own self-hosted **ClearML Server**
|
|
need only one set of credentials.
|
|
|
|
**ClearML** credentials can be created for a current workspace. To create **ClearML** credentials for another workspace,
|
|
switch to it.
|
|
|
|
**To create ClearML credentials:**
|
|
|
|
1. Click the Profile button <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />
|
|
(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
|
|
|
|
:::note
|
|
Switching workspaces does not apply to users of a self-hosted **ClearML Server**
|
|
:::
|
|
|
|
**ClearML Hosted Service** users who are members of multiple teams can switch from one workspace to another.
|
|
|
|
**Switch workspaces in one of the following ways:**
|
|
|
|
* 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) **>**
|
|
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
|
|
|
|
:::note
|
|
Inviting new teammates does not apply to users of a self-hosted **ClearML Server**.
|
|
:::
|
|
|
|
**ClearML Hosted Service** users can invite other users to collaborate in their workspace. On the Profile page, the **WORKSPACES**
|
|
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:
|
|
|
|
* Profile button - Click <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />
|
|
**>** **Invite a User** **>** Copy the invitation hyperlink.
|
|
|
|
* Profile page - In **WORKSPACES** **>** **Members** **>** Click **INVITE USER** **>** Copy the invitation hyperlink.
|
|
|
|
1. Send the invitation hyperlink to an invitee.
|
|
|
|
## Leaving a workspace
|
|
|
|
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**.
|