lightning-hydra-template icon indicating copy to clipboard operation
lightning-hydra-template copied to clipboard

According to hydra documentation config names should not have .yaml extension

Open yermandy opened this issue 2 years ago • 1 comments

Hello. Taken from the official documentation of Hydra 1.2:

CONFIG_NAME: The name of a config, without the file system extension. e.g. mysql and not mysql.yaml.

https://github.com/ashleve/lightning-hydra-template/blob/5034fca4e59dd3b1dff4797cb313886ee4daba54/configs/train.yaml#L5-L14

There are more places with this inconsistency

yermandy avatar Aug 18 '22 14:08 yermandy

@yermandy Thank you for pointing this out! Sure, we can change this.

As far as I'm aware it doesn't affect functionality.

The reason for attaching the .yaml extension was to make it more clear what is happening for new users.

I remember on my first contact with hydra, I didn't grasp immediately that the defaults list elements were referring to yaml files from subfolders. Since the template purpose is also educational, attaching the extensions felt like it makes it more explicit. Making things more explicit for educational purpose was kind of a design principle behind this project.

That being said, if this is a standard recommended by hydra then we should probably comply.

ashleve avatar Aug 25 '22 13:08 ashleve