RFC: hydra.compose() decoration

[omry]

Initial API idea:

@hydra.compose(config_path="path/file.yaml", overrides=["foo=bar", "db=mysql"])
def foo(cfg, userarg):
    pass

result = foo(userarg)

[withsmilo]

It looks good! It seems to be similar to what I had proposed before(#215). What is userarg? user-defined ArgumentParser, or another something?

[omry]

Thanks!
Not quiet the same.
This is a way to access the composition power of Hydra in a regular function call.
User arg is just an example of something else the user is passing to the function (pass through).

[withsmilo]

I understood. New hydra.compose decorator also seems to be useful in various place. I have a question. Will new decorator return something according to your initial design? As you know, hydra.main decorator doesn’t return anything.

[omry]

Yes, the new decorator will be able to return results.
In fact, so can the current hydra.main() although nothing is using it as of now.

[omry]

Done, this will be available with the next 0.11.0 release candidate.

[hrchu]

Glad to see you hear the user voice!

[omry]

Actually this is not quiet what you asked for, the compose API does not support anything in the command line.
I am planning on supporting something like what you wanted #274 is implemented.
There is a reasonable workaround for allowing users to specify a config file in the comments there.