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 hierarchy clarification (#103)

Browse Source
This commit is contained in:
pollfly
2021-11-07 10:58:22 +02:00
committed by GitHub
parent 64629010b7
commit 4e65045f3b
4 changed files with 37 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/configs/clearml_conf.md
View File

@@ -12,9 +12,14 @@ This reference page is organized by configuration file section:
* [sdk](#sdk-section) - Contains **ClearML** and **ClearML Agent** configuration options for **ClearML Python Package** and **ClearML Server**.
An example configuration file is located [here](https://github.com/allegroai/clearml-agent/blob/master/docs/clearml.conf),
in the **ClearML** GitHub repositories
in the **ClearML Agent** GitHub repository.
## Editing Your Configuration File
:::info
The values in the ClearML configuration file can be overridden by environment variables, the [configuration vault](../webapp/webapp_profile.md#configuration-vault),
and command-line arguments.
:::
# Editing Your Configuration File
To add, change, or delete options, edit your configuration file.
@@ -97,7 +102,7 @@ Supported from Docker 0.6.5
* The following variables can be used:
* `task_id`
* `worker_id`
* `rand_string` - random lower-case letters string, up to 32 characters)
* `rand_string` - random lower-case letters string (up to 32 characters)
* The resulting name must start with an alphanumeric character, while the rest of the name may contain alphanumeric characters,
underscores (`_`), dots (`.`) and / or dashes (`-`)
@@ -218,7 +223,7 @@ Supported from Docker 0.6.5
* The values are:
* `true` - ignore any requested python version
* `false` - if a task was using a specific python version and the system supports multiple versions, the agent will
* `false` - if a task was using a specific python version, and the system supports multiple versions, the agent will
use the requested python version (default)
___
@@ -1045,7 +1050,7 @@ 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
## Configuration Vault
:::note
This feature is only supported by the **ClearML Enterprise Server**
@@ -1056,4 +1061,4 @@ the vault is enabled, the configurations will be merged into the ClearML and Cle
These configurations override the configurations written in the configuration file.
See [configuration vault](../webapp/webapp_profile.md#configuration-vault).
See [configuration vault](../webapp/webapp_profile.md#configuration-vault).