Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove config.yaml #109

Open
meiertgrootes opened this issue Aug 20, 2024 · 3 comments
Open

remove config.yaml #109

meiertgrootes opened this issue Aug 20, 2024 · 3 comments

Comments

@meiertgrootes
Copy link
Member

No description provided.

@meiertgrootes
Copy link
Member Author

@SarahAlidoost @vmgaribay @vanlankveldthijs During our meeting we discussed removing the config.yaml file, because the default values (which are what is generally being used) are implemented in config.py.

However, we have retained the ability to initialize from a yaml file. This makes sense, certainly in the case of running different scenarios/models.

Maybe we should rename config.yaml to config_template.yaml and highlight this in documentation

@vanlankveldthijs
Copy link

This makes sense.

However, while implementing the recent save state functionality, I didn't really like having all the default config parameters duplicated in config.py and config.yaml.
Any time a config parameter is renamed, or moved between the main config and the steering parameters, it had to be updated in both places.

If we want to keep a config template file, we may want to make it a deliberately slimmed down set of parameters.

@SarahAlidoost
Copy link
Member

To avoid maintaining two separate sets of configurations (config.py and config.yaml), we could allow users to generate the config template file as needed. For example, util.get_config_template(cfg_filename) could be used to generate a template based on the values in config.py. The functionality to_yaml() already exists; see the example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants