ClearML/clearml-agent
1
0
Fork 0
mirror of https://github.com/clearml/clearml-agent synced 2025-01-31 09:06:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve configuration examples

Browse Source
This commit is contained in:
allegroai 2022-12-05 11:17:27 +02:00
parent 76c533a2e8
commit 18612aac4d
1 changed files with 39 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/clearml.conf
View File

@ -444,17 +444,23 @@ sdk {
# Apply top-level environment section from configuration into os.environ # Apply top-level environment section from configuration into os.environ
apply_environment: true apply_environment: true
# Top-level environment section is in the form of:
# environment {
# key: value
# ...
# }
# and is applied to the OS environment as `key=value` for each key/value pair
# Apply top-level files section from configuration into local file system # Apply top-level files section from configuration into local file system
apply_files: true apply_files: true
# Top-level files section allows auto-generating files at designated paths with a predefined contents }
# and target format. Options include:
# Environment section (top-level) is applied to the OS environment as `key=value` for each key/value pair
# * enable/disable with `agent.apply_environment` OR `sdk.apply_environment`
# Example:
#
# environment {
# key_a: value_a
# key_b: value_b
# }
# Files section (top-level) allows auto-generating files at designated paths with
# predefined content and target format.
# * enable/disable with `agent.apply_files` OR `sdk.apply_files`
# Files content options include:
# contents: the target file's content, typically a string (or any base type int/float/list/dict etc.) # contents: the target file's content, typically a string (or any base type int/float/list/dict etc.)
# format: a custom format for the contents. Currently supported value is `base64` to automatically decode a # format: a custom format for the contents. Currently supported value is `base64` to automatically decode a
# base64-encoded contents string, otherwise ignored # base64-encoded contents string, otherwise ignored
@ -481,5 +487,3 @@ sdk {
# target_format: json # target_format: json
# } # }
# } # }
}