diff --git a/docs/clearml_agent.md b/docs/clearml_agent.md index c12d127a..39d8d15d 100644 --- a/docs/clearml_agent.md +++ b/docs/clearml_agent.md @@ -129,6 +129,12 @@ Install ClearML Agent as a system Python package and not in a Python virtual env * Windows - `\User\\clearml.conf` 1. Optionally, configure **ClearML** options for **ClearML Agent** (default docker, package manager, etc.). See the [ClearML Configuration Reference](configs/clearml_conf.md). + +:::note +The ClearML Enterprise server provides a [configuration vault](webapp/webapp_profile.md#configuration-vault), the contents +of which are categorically applied on top of the agent-local configuration +::: + ### Adding ClearML Agent to a Configuration File diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md index c4c1d377..6220a71e 100644 --- a/docs/configs/clearml_conf.md +++ b/docs/configs/clearml_conf.md @@ -991,3 +991,16 @@ will not exceed the value of `matplotlib_untitled_history_size` * Specify a list of direct access objects using glob patterns which matches sets of files using wildcards. Direct access objects are not downloaded or cached, and any download request will return a direct reference. + +## Configuration vault + +:::note +This feature is only supported by the **ClearML Enterprise Server** +::: + +The ClearML Enterprise Server includes the configuration vault. Users can add configuration sections to the vault and, once +the vault is enabled, the configurations will be merged into the ClearML and ClearML Agent configurations upon code execution and / or agent launch. + +These configurations override the configurations written in the configuration file. + +See [configuration vault](../webapp/webapp_profile.md#configuration-vault). \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index 53d181cd..32122974 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -489,7 +489,7 @@ experiment info panel > EXECUTION tab. **I read there is a feature for centralized model storage. How do I use it?** -When calling [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), +When calling [Task.init](references/sdk/task.md#taskinit), providing the `output_uri` parameter allows you to specify the location in which model checkpoints (snapshots) will be stored. For example, to store model checkpoints (snapshots) in `/mnt/shared/folder`: @@ -551,7 +551,7 @@ Yes! You can run ClearML in Jupyter Notebooks using either of the following: pip install clearml -1. Use the [Task.set_credentials](references/sdk/task.md#classmethod-set_credentialsapi_hostnone-web_hostnone-files_hostnone-keynone-secretnone-store_conf_filefalse) +1. Use the [Task.set_credentials](references/sdk/task.md#taskset_credentials) method to specify the host, port, access key and secret key (see step 1). # Set your credentials using the trains apiserver URI and port, access_key, and secret_key. diff --git a/docs/guides/reporting/image_reporting.md b/docs/guides/reporting/image_reporting.md index b8626e18..75912127 100644 --- a/docs/guides/reporting/image_reporting.md +++ b/docs/guides/reporting/image_reporting.md @@ -10,8 +10,8 @@ demonstrates reporting (uploading) images in several formats, including: * PIL Image objects * Local files. -**ClearML** uploads images to the bucket specified in the **ClearML** configuration file, or **ClearML** can be configured -for image storage, see [Logger.set_default_upload_destination](../../references/sdk/logger.md#set_default_upload_destination) +**ClearML** uploads images to the bucket specified in the **ClearML** configuration file +or **ClearML** can be configured for image storage, see [Logger.set_default_upload_destination](../../references/sdk/logger.md#set_default_upload_destination) (storage for [artifacts](../../fundamentals/artifacts.md#setting-upload-destination) is different). Set credentials for storage in the **ClearML** configuration file. diff --git a/docs/guides/reporting/media_reporting.md b/docs/guides/reporting/media_reporting.md index afb37c23..e5be3465 100644 --- a/docs/guides/reporting/media_reporting.md +++ b/docs/guides/reporting/media_reporting.md @@ -9,8 +9,7 @@ method to upload from: * BytesIO stream * URL of media already uploaded to some storage -**ClearML** uploads media to the bucket specified in the **ClearML** configuration file, or **ClearML** can be configured -for image storage, see [Logger.set_default_upload_destination](../../references/sdk/logger.md#set_default_upload_destination) +**ClearML** uploads media to the bucket specified in the **ClearML** configuration file or **ClearML** can be configured for image storage, see [Logger.set_default_upload_destination](../../references/sdk/logger.md#set_default_upload_destination) (storage for [artifacts](../../fundamentals/artifacts#setting-upload-destination) is different). Set credentials for storage in the **ClearML** [configuration file](../../configs/clearml_conf.md). diff --git a/docs/img/webapp_profile.png b/docs/img/webapp_profile.png new file mode 100644 index 00000000..e4a7bb29 Binary files /dev/null and b/docs/img/webapp_profile.png differ diff --git a/docs/img/webapp_profile_configuration_vault.png b/docs/img/webapp_profile_configuration_vault.png new file mode 100644 index 00000000..770e93d6 Binary files /dev/null and b/docs/img/webapp_profile_configuration_vault.png differ diff --git a/docs/webapp/webapp_exp_tuning.md b/docs/webapp/webapp_exp_tuning.md index 2c170fea..b3d4308b 100644 --- a/docs/webapp/webapp_exp_tuning.md +++ b/docs/webapp/webapp_exp_tuning.md @@ -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). ::: diff --git a/docs/webapp/webapp_profile.md b/docs/webapp/webapp_profile.md index 010ac3fd..f4f4d72d 100644 --- a/docs/webapp/webapp_profile.md +++ b/docs/webapp/webapp_profile.md @@ -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**. :::