ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add configuration vault docs (#91)

Browse Source
This commit is contained in:
pollfly
2021-10-21 09:42:11 +03:00
committed by GitHub
parent f2162ba9e5
commit 63e3ff1f9c
9 changed files with 58 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/webapp/webapp_exp_tuning.md
View File

@@ -95,10 +95,11 @@ and formats for specifying locations include:
* In **EXECUTION** **>** **OUTPUT** > **DESTINATION** **>** hover **>** **EDIT** **>** edit **>** **SAVE**.
:::note
:::note Set Output Destination for Artifacts
Also set the output destination for artifacts in code (see the `output_uri` parameter of the
[Task.init](../references/sdk/task.md#classmethod-initproject_namenone-task_namenone-task_typetasktypestraining-training-tagsnone-reuse_last_task_idtrue-continue_last_taskfalse-output_urinone-auto_connect_arg_parsertrue-auto_connect_frameworkstrue-auto_resource_monitoringtrue-auto_connect_streamstrue)
method), and in the **ClearML** configuration file for all experiments (see [default_output_uri](../configs/clearml_conf#config_default_output_uri)
[Task.init](../references/sdk/task.md#taskinit)
method), and in the **ClearML** configuration file
for all experiments (see [default_output_uri](../configs/clearml_conf#config_default_output_uri)
on the **ClearML** Configuration Reference page).
:::

32
docs/webapp/webapp_profile.md
View File

@@ -7,11 +7,16 @@ 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).
* [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).
* [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.
![Profile page](../img/webapp_profile.png)
## Setting User Preferences
## 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.
@@ -53,9 +58,31 @@ switch to it.
1. In **App Credentials** **>** **+ Create new credentials**.
## 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
:::note
:::note Feature Support
Switching workspaces does not apply to users of a self-hosted **ClearML Server**
:::
@@ -67,9 +94,10 @@ Switching workspaces does not apply to users of a self-hosted **ClearML Server**
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
:::note Feature Support
Inviting new teammates does not apply to users of a self-hosted **ClearML Server**.
:::