Hydra is using the command line for two things:
- Configuring your application (See Override Grammar)
- Telling Hydra what to do.
Any argparse argument that is prefixed by
'- is telling Hydra what to do.
The rest of the parameters are used to configure your application.
You can view the Hydra specific flags via
Shows the application's help. This can be customized.
Show Hydra's version and exit
Show config instead of running. Takes as parameter one of
Used in conjunction with --cfg. -p select a specific config package to show.
Run is the default mode and is not normally needed.
Install or Uninstall shell tab completion.
Overrides the config_path specified in hydra.main(). The config_path is relative to the Python file declaring @hydra.main()
Overrides the config_name specified in hydra.main()
Adds an additional config directory to the config search path. This is useful for installed apps that want to allow their users to provide additional configs.
Print Hydra information. This includes installed plugins, search path, composition trace, generated config and more.