diff --git a/docs/img/integrations_hydra_configs.png b/docs/img/integrations_hydra_configs.png index 3aaeeed5..d60cd4ec 100644 Binary files a/docs/img/integrations_hydra_configs.png and b/docs/img/integrations_hydra_configs.png differ diff --git a/docs/integrations/hydra.md b/docs/integrations/hydra.md index 85674ef1..5eaa41e0 100644 --- a/docs/integrations/hydra.md +++ b/docs/integrations/hydra.md @@ -26,6 +26,16 @@ ClearML logs the OmegaConf as a blob and can be viewed in the ## 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). 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 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).