Enable --cfg=job --resolve with ${hydra:...} resolver #1696

Jasha10 · 2021-06-24T20:55:16Z

This PR closes #1681, so that resolved references to HydraConfig can appear
in the output from the --cfg=job flag. It is now possible to call
python my_app.py --cfg job --resolve
when the user config contains the ${hydra:...} resolver.

To implement this, several changes are made to the
hydra._internal.hydra.Hydra class:

In the Hydra._get_cfg method, we now call
HydraConfig.instance().set_config(cfg) on the composed cfg object,
enabling the ${hydra:...} resolver.
Previously, the Hydra._get_cfg method would delete the cfg["hydra"]
package immediately. We now delay the deletion until after
OmegaConf.resolve can be called. This is done by factoring out a
Hydra.get_sanitized_cfg method.
Since the HydraConfig.set_config method sets a 'readonly' flag, it is
now necessary to use a read_write/flag_override context manager when
calling OmegaConf.resolve and when deleting the cfg["hydra"] package.
We also call HydraConfig.instance().set_config(cfg) in the
Hydra.app_help method. This allows for
python my_app.py --help --resolve
to work even if the help template references the user's $CONFIG and the
${hydra:...} resolver appears in that user config.

lgtm-com · 2021-06-24T21:09:22Z

This pull request introduces 1 alert when merging ecaba57 into 8fa67de - view on LGTM.com

new alerts:

1 for Unused local variable

omry

nice. See comment.

omry · 2021-06-28T21:44:56Z

hydra/_internal/hydra.py

        cfg = self.compose_config(
            config_name=config_name,
            overrides=overrides,
            run_mode=RunMode.RUN,
            with_log_configuration=with_log_configuration,
        )
+        HydraConfig.instance().set_config(cfg)


I would prefer not to introduce a side effect to a getter function.
Can the caller do this instead?

I inlined the _get_cfg method in 6828fcc.

omry · 2021-06-28T21:45:49Z

hydra/_internal/hydra.py

+                with read_write(cfg.hydra):
+                    OmegaConf.resolve(ret)


This seems unrelated. What is the motivation for this? (Is there a missing test?)

The HydraConfig.set_config method sets a readonly flag on cfg.hydra, so OmegaConf.resolve fails unless the flag is turned off.

We could unset the readonly flag in show_cfg and show_help.

Done in 57452d5. I only needed to unset the flag in show_cfg. In show_help, a readonly flag is no problem because we are using OmegaConf.to_yaml(..., resolve=...) instead of OmegaConf.resolve(...).

lgtm-com · 2021-06-29T22:19:24Z

This pull request introduces 1 alert when merging 6828fcc into 437e20d - view on LGTM.com

new alerts:

1 for Unused local variable

hydra/_internal/hydra.py

omry · 2021-06-30T17:06:21Z

hydra/_internal/hydra.py

+                with read_write(cfg.hydra):
+                    OmegaConf.resolve(ret)


We could unset the readonly flag in show_cfg and show_help.

tests/test_hydra.py

omry · 2021-06-30T17:10:28Z

news/1681.bugfix

@@ -0,0 +1 @@
+Fix the --cfg=job --resolve flags so that the ${hydra:...} resolver now prints properly


This fixes --help as well?

Yes. I updated the news fragment in 751653f.

omry · 2021-06-30T17:14:39Z

tests/test_apps/interpolation_to_hydra_config/my_app.py

+@hydra.main(config_path=".", config_name="config")
+def my_app(cfg: DictConfig) -> None:
+    pass


Can you reuse simple_app here?
You can place the config next to it or somewhere else and override the used config like:

python tests/test_apps/simple_app/my_app.py --config-name=config --config-dir=tests/test_apps/app_with_cfg

Done in 1d7bdd2.

omry · 2021-06-30T17:16:01Z

tests/test_hydra.py

+            "examples/tutorials/basic/your_first_hydra_app/2_config_file/my_app.py",
+            ["--help", "--resolve"],
+            ["hydra.help.template=$CONFIG", "db.user=${hydra:job.name}"],
+            dedent(
+                """\
+                db:
+                  driver: mysql
+                  user: my_app
+                  password: secret
+                """
+            ),
+            id="overriding_help_template:$CONFIG,resolve_interp_to_hydra_config",


generally speaking, avoid testing with the tutorial apps except in tests/test_examples. (I know the code is not being consistent about it).

Made the change in 27052cf.

Co-authored-by: Omry Yadan <omry@fb.com>

lgtm-com · 2021-06-30T21:54:39Z

This pull request introduces 1 alert when merging 1b4af22 into 437e20d - view on LGTM.com

new alerts:

1 for Unused local variable

lgtm-com · 2021-06-30T22:39:06Z

This pull request introduces 1 alert when merging 57452d5 into 437e20d - view on LGTM.com

new alerts:

1 for Unused local variable

Jasha10 · 2021-06-30T23:01:38Z

hydra/_internal/hydra.py

+    def sanitize_hydra_cfg(cfg: DictConfig) -> None:
+        """
+        Mutate the input cfg:
+          - delete all toplevel keys except "hydra".
+          - delete `hydra.help` and `hydra.hydra_help`.
+        """


3c87309 is a refactoring:

get_sanitized_hydra_cfg -> sanitize_hydra_cfg

get_sanitized_cfg -> sanitize_cfg

Before, these methods were making a deepcopy in some branches, and not making a deepcopy in other branches.
Now, they never make a deepcopy (i.e. they mutate their input directly). This refactoring should resolve the LGTM alerts that are posted in the PR's main thread.

Looks like get_sanitized_hydra_cfg was always copying and get_sanitized_cfg was composing (so no need to copy).
Not sure what alerts you are referring to.

def get_sanitized_hydra_cfg(src_cfg: DictConfig) -> DictConfig: cfg = copy.deepcopy(src_cfg)

Looking at the warning, the refactoring sounds like way too big a hammer.

Fair enough. I reverted the refactoring in f0fa6cd and then did a simpler fix in 06258d2.

…uts" This reverts commit 3c87309.

omry

Looking good.

Use HydraConfig.set_config

41a8652

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jun 24, 2021

add news fragment

ecaba57

omry reviewed Jun 28, 2021

View reviewed changes

inline Hydra._get_cfg

6828fcc

omry reviewed Jun 30, 2021

View reviewed changes

Jasha10 and others added 2 commits June 30, 2021 16:44

Update hydra/_internal/hydra.py

32d5476

Co-authored-by: Omry Yadan <omry@fb.com>

improved black formatting in test_hydra.py

1b4af22

unset readonly flag

57452d5

make sanitize_cfg and sanitize_hydra_cfg mutate their inputs

3c87309

Jasha10 commented Jun 30, 2021

View reviewed changes

Jasha10 added 5 commits June 30, 2021 18:15

news fragment: mention the --help flag.

751653f

Revert "make sanitize_cfg and sanitize_hydra_cfg mutate their inp…

f0fa6cd

…uts" This reverts commit 3c87309.

call get_sanitized_cfg earlier

06258d2

use test_apps/app_with_cfg instead of tutorial app

27052cf

reuse simple_app for testing interpolation to hydra config

1d7bdd2

omry approved these changes Jul 17, 2021

View reviewed changes

Jasha10 merged commit 27ab477 into facebookresearch:master Jul 17, 2021

Jasha10 deleted the closes1681 branch September 15, 2021 20:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable --cfg=job --resolve with ${hydra:...} resolver #1696

Enable --cfg=job --resolve with ${hydra:...} resolver #1696

Jasha10 commented Jun 24, 2021

lgtm-com bot commented Jun 24, 2021

omry left a comment

omry Jun 28, 2021

Jasha10 Jun 29, 2021

omry Jun 28, 2021

Jasha10 Jun 29, 2021

omry Jun 30, 2021

Jasha10 Jun 30, 2021

lgtm-com bot commented Jun 29, 2021

omry Jun 30, 2021

omry Jun 30, 2021

Jasha10 Jun 30, 2021

omry Jun 30, 2021

Jasha10 Jul 15, 2021

omry Jun 30, 2021

Jasha10 Jul 15, 2021

lgtm-com bot commented Jun 30, 2021

lgtm-com bot commented Jun 30, 2021

Jasha10 Jun 30, 2021 •

edited

Loading

omry Jul 1, 2021

omry Jul 1, 2021

Jasha10 Jul 14, 2021 •

edited

Loading

omry left a comment

		@@ -0,0 +1 @@
		Fix the --cfg=job --resolve flags so that the ${hydra:...} resolver now prints properly

Enable --cfg=job --resolve with ${hydra:...} resolver #1696

Enable --cfg=job --resolve with ${hydra:...} resolver #1696

Conversation

Jasha10 commented Jun 24, 2021

lgtm-com bot commented Jun 24, 2021

omry left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lgtm-com bot commented Jun 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lgtm-com bot commented Jun 30, 2021

lgtm-com bot commented Jun 30, 2021

Jasha10 Jun 30, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jasha10 Jul 14, 2021 • edited Loading

Choose a reason for hiding this comment

omry left a comment

Choose a reason for hiding this comment

Jasha10 Jun 30, 2021 •

edited

Loading

Jasha10 Jul 14, 2021 •

edited

Loading