Clear up what optimizers/schedulers are supported

[SeanNaren]

📚 Documentation

It would be nice to know from the documentation rather than going through the configs.

@omry is there a way I can do:

python train.py optimizer --help

# prints
# optimizer: adadelta, adagrad, adam, adamax, adamw, asgd, rmsprop, rprop, sgd
# optimizer/deepspeed: adam, adamw, cpu_adam, onebitadam

To find all the options for a specific group? I know I can python train.py --help and see all options, but it would be nice to do the above!

[omry]

Hydra supports showing all the application's config groups in the help (you can't select just a subset):
You can configure your help to show it, something like:

$ python my_app.py 'hydra.help.template=$APP_CONFIG_GROUPS' --help
db: mysql, postgresql
schema: school, support, warehouse
ui: full, view

You can read a bit more about customizing the help here.
In the above example I am customizing it in an ad-hoc way just for that run.

Another thing I often do is intentionally leave the choice empty and see the response:

$ python my_app.py db=
In 'config': Could not find 'db/'

Available options in 'db':
        mysql
        postgresql
Config search path:
  ...

Finally, Hydra's tab completion will complete config groups.

[SeanNaren]

Late response, but thank you @omry! This is very helpful :)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.