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

Add Hydra information (#708)

Browse Source
This commit is contained in:
pollfly 2023-11-15 12:05:38 +02:00 committed by GitHub
parent 856c5c8ca8
commit 778769f37a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/img/integrations_hydra_configs.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 59 KiB

14
docs/integrations/hydra.md
View File

@ -26,6 +26,16 @@ ClearML logs the OmegaConf as a blob and can be viewed in the
## Modifying Hydra Values ## Modifying Hydra Values
### Via Command Line
You can use Hydra's command line syntax to modify your OmegaConf: override, append, or remove config values:
* Override config value: `foo.bar=value`
* Append config value: `+foo.bar=value`
* Remove config value: `~foo.bar` or `~foo.bar=value`
See the [Hydra documentation](https://hydra.cc/docs/advanced/override_grammar/basic/#basic-override-syntax) for more information.
### Via UI
In the UI, you can clone a task multiple times and modify it for execution by the [ClearML Agent](../clearml_agent.md). In the UI, you can clone a task multiple times and modify it for execution by the [ClearML Agent](../clearml_agent.md).
The agent executes the code with the modifications you made in the UI, even overriding hardcoded values. The agent executes the code with the modifications you made in the UI, even overriding hardcoded values.
@ -54,4 +64,6 @@ Enqueue the customized experiment for execution. The task will use the new value
second option mentioned above, notice that the OmegaConf in **CONFIGURATION > CONFIGURATION OBJECTS > OmegaConf** changes second option mentioned above, notice that the OmegaConf in **CONFIGURATION > CONFIGURATION OBJECTS > OmegaConf** changes
according to your added parameters. according to your added parameters.
See code example [here](https://github.com/allegroai/clearml/blob/master/examples/frameworks/hydra/hydra_example.py). ## Code Example
See example which demonstrates integrating ClearML into script that uses Hydra [here](https://github.com/allegroai/clearml/blob/master/examples/frameworks/hydra/hydra_example.py).