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

23
docs/configs/configuring_clearml.md Normal file
View File

@@ -0,0 +1,23 @@
---
title: Configuring ClearML
---
ClearML can be tailored to your requirements by setting configurations in a variety of methods. All ClearML and ClearML
Agent configurations can be set in the `clearml.conf` file, which serves as the baseline configuration of both packages.
For detailed information about the configurable options in ClearML and ClearML Agent, see the
[Configuration File](clearml_conf.md) reference page.
ClearML supports reading configuration values from environment variables. Configuration entries specified
in this manner override values specified in the `clearml.conf` file. See [Environment Variables](env_vars.md) for parameter
specification.
Enterprise users can insert configuration snippets into the configuration vault. When enabled, configuration entries
from the vault are applied on top of the configuration specified in `clearml.conf`. New definitions will extend the
`clearml.conf` configurations, and existing definitions will be overridden. For more information, see [Configuration vault](../webapp/webapp_profile.md#configuration-vault).
The different ClearML configuration methods take precedence as summarized in the following list (higher ordered methods
override the lower ones):
1. Command-line arguments
1. Environment variables
1. Configuration vault
1. Configuration file