mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
This commit is contained in:
@@ -34,7 +34,12 @@ Access privileges can be viewed, defined, and edited in the **Access Rules** tab
|
||||
button
|
||||
1. Click **SAVE**
|
||||
|
||||

|
||||
<div class="max-w-50">
|
||||
|
||||

|
||||

|
||||
|
||||
</div>
|
||||
|
||||
Access is inherited according to resource hierarchy. For example, if a user is given access to a project, the user will
|
||||
also have access to the project's contents (tasks, models, etc.). A user who is granted access to a specific task will
|
||||
|
||||
@@ -67,4 +67,5 @@ The **Administrator Vaults** table lists all currently defined vaults, and the f
|
||||
|
||||
Hover over a vault in the table to **Download**, **Edit**, or **Delete** a vault.
|
||||
|
||||

|
||||

|
||||

|
||||
@@ -145,4 +145,5 @@ The **Provider Connections** table lists all currently defined connections, and
|
||||
|
||||
Hover over a connection in the table to **Edit** or **Delete** it.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
@@ -60,7 +60,8 @@ ClearML Hosted Service users can be members of multiple workspaces, which are li
|
||||
To switch to another workspace, click on the **SWITCH TO WORKSPACE** button next to the name of the workspace you want
|
||||
to switch to.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### ClearML App Credentials
|
||||
|
||||
@@ -80,7 +81,12 @@ You can create credentials for any workspace that you are a member of.
|
||||
The dialog displays new credentials, formatted as a ready-to-copy configuration file section (including server configuration
|
||||
information).
|
||||
|
||||

|
||||
<div class="max-w-75">
|
||||
|
||||

|
||||

|
||||
|
||||
</div>
|
||||
|
||||
You can edit the labels of credentials in your own workspace, or credentials that you created in other workspaces.
|
||||
|
||||
@@ -161,4 +167,5 @@ Fill in values using any of ClearML supported configuration formats: HOCON / JSO
|
||||
* 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
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
@@ -8,7 +8,8 @@ reservations for different user groups to prioritize workload usage across avail
|
||||
Under the **Resource Configuration** section, administrators define the available resources and the way in which they
|
||||
will be allocated to different workloads.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
The Resource Configuration settings page shows the [currently provisioned](#applying-resource-configuration) configuration:
|
||||
the defined resource pools, resource profiles, and the resource allocation architecture.
|
||||
@@ -25,7 +26,12 @@ versa).
|
||||
The resource pool cards are displayed on the top of the Resource Configuration settings page. Each card displays the
|
||||
following information:
|
||||
|
||||

|
||||
<div class="max-w-50">
|
||||
|
||||

|
||||

|
||||
|
||||
</div>
|
||||
|
||||
* Pool name
|
||||
* Number of resources currently in use out of the total available resources
|
||||
@@ -45,7 +51,17 @@ R&D team and DevOps team both have pending jobs - run the R&D team's jobs first
|
||||
The resource profile cards are displayed on the bottom of the Resource Configuration settings page. Each card displays
|
||||
the following information:
|
||||
|
||||

|
||||
<div class="max-w-50">
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
|
||||
<div class="max-w-50">
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
|
||||
* Profile name
|
||||
* <img src="/docs/latest/icons/ico-resource-number.svg" alt="Number of resources" className="icon size-md space-sm" /> - Number
|
||||
@@ -61,18 +77,21 @@ You have GPUs spread across a local H100 and additional bare metal servers, as w
|
||||
by an autoscaler). Assume that currently most of your resources are already assigned to jobs, and only 16 resources are available: 8 in the
|
||||
H100 resource pool and 8 in the Bare Metal pool:
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Teams' jobs have varying resource requirements of 0.5, 2, 4, and 8 GPUs. Resource profiles are defined to reflect these:
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
The different jobs will be routed to different resource pools by connecting the profiles to the resource pools. Jobs
|
||||
enqueued through the profiles will be run in the pools where there are available resources in order of their priority.
|
||||
For example, the H100 pool will run jobs with the following precedence: 2 GPU jobs first, then 4 GPU ones, then 8 GPU,
|
||||
and lastly 0.5 GPU.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Resource policies are implemented for two teams:
|
||||
* Dev team
|
||||
@@ -81,21 +100,33 @@ Resource policies are implemented for two teams:
|
||||
Each team has a resource policy configured with 8 reserved resources and a 16 resource limit. Both teams make use of the
|
||||
4xGPU profile (i.e. each job running through this profile requires 4 resources).
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
The Dev team is prioritized over the Research team by placing it higher in the Resource Profile's Policies Priority list:
|
||||
|
||||

|
||||
<div class="max-w-75">
|
||||
|
||||

|
||||

|
||||
|
||||
</div>
|
||||
|
||||
Both the Dev team and the Research team enqueue four 4-resource jobs each: Dev team jobs will be allocated resources
|
||||
first. The `4xGPU` resource profile is connected to two resource pools: `Bare Metal Low END GPUs` (with the
|
||||
`4 GPU Low End` link) and `H100 Half a Superpod` (with the `4 GPU H100 link`).
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Resources are assigned from the `Bare Metal` pool first (precedence set on the resource profile card):
|
||||
|
||||

|
||||
<div class="max-w-50">
|
||||
|
||||

|
||||

|
||||
|
||||
</div>
|
||||
|
||||
If the first pool cannot currently satisfy the profile’s resource requirements, resources are assigned from the next
|
||||
listed pool. Let's look at the first pool in the image below. Notice that the pool has 8 available resources, therefore
|
||||
@@ -103,7 +134,8 @@ it can run two 4-resource jobs.
|
||||
|
||||
<div class="max-w-50">
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@@ -7,7 +7,8 @@ To enable ClearML to delete task artifacts stored in cloud storage when a task i
|
||||
* [AWS S3 Storage](#aws-s3-storage)
|
||||
* [Azure](#azure)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## Google Cloud Storage
|
||||
Set up credentials for Google Cloud buckets:
|
||||
|
||||
@@ -7,7 +7,8 @@ The **Billing & Usage** section displays your ClearML workspace usage informatio
|
||||
* Available storage
|
||||
* Number of monthly API calls
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
To add users to your workspace, click **INVITE USERS** in the **USERS** section. This will redirect you to the
|
||||
**USER MANAGEMENT** page, where you can invite users (see details [here](webapp_settings_users.md#inviting-new-teammates)).
|
||||
@@ -20,7 +21,8 @@ for additional plans information.
|
||||
With the ClearML Pro plan, the **Billing & Usage** page additionally shows estimated charges for the current billing
|
||||
period and provides access to billing information.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
**To Upgrade your account to ClearML Pro**, click **UPGRADE** in the top right corner of the page. This will open a
|
||||
wizard where you will be able to read the terms and conditions and input your billing information.
|
||||
|
||||
@@ -19,7 +19,8 @@ Each row of the table includes:
|
||||
* If the user's invitation is pending, the date the user was added
|
||||
* [User groups](#user-groups) (ClearML Enterprise feature)
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Inviting New Teammates
|
||||
|
||||
@@ -69,7 +70,8 @@ Each row of the table includes:
|
||||
|
||||
Hover over a service account in the table to **Edit** or **Delete** it.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Creating a Service Account
|
||||
|
||||
@@ -133,7 +135,8 @@ In addition to the service account-specific configuration vault, [administrator
|
||||
be applied to service accounts. See all the vaults applied to the account in the **Applied administrator vaults** below
|
||||
the configuration vault.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Deleting Service Account
|
||||
Deleting a service account will revoke its credentials, causing agents using the account's credentials to fail.
|
||||
@@ -161,7 +164,8 @@ The system includes three pre-configured groups that can't be removed:
|
||||
|
||||
The user group table lists all the active user groups. Each row includes a group's name, description, member list, and ID.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Creating a User Group
|
||||
|
||||
@@ -173,7 +177,12 @@ The user group table lists all the active user groups. Each row includes a group
|
||||
the <img src="/docs/latest/icons/ico-trash.svg" alt="Trash can" className="icon size-md" /> button
|
||||
1. Click **SAVE**
|
||||
|
||||

|
||||
<div class="max-w-50">
|
||||
|
||||

|
||||

|
||||
|
||||
</div>
|
||||
|
||||
### Editing a User Group
|
||||
|
||||
|
||||
Reference in New Issue
Block a user