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

1 feature improved configuration and data structures #79

Draft
wants to merge 89 commits into
base: develop
Choose a base branch
from

Conversation

theissenhelen
Copy link
Collaborator

Currently, the configurations are passed via hydra from yaml files. This PR adds structured configs (or schemas) and basic config validation via Pydantic base models.

Some advantageous are:

  • validation and feedback to the user before starting a training run
  • syntax highlighting and auto-complete
  • data transformations
  • decluttering the configs by introducing defaults in the schemas
  • better documentation of the configs
  • deprecation management
  • easier to define configs for unit testing

Main changes are:

  • schemas that mimic the current structure of the configs
  • a new command Anemoi-training config validate --name debug.yaml
  • For developers: If you make changes to the configs, these need to be represented in the structured configs/schemas.

ToDo:

  • support python versions 3.9 - 3.11
  • test special use cases such as LAM
  • autodocs
  • check for missing config entries
  • no-validate flag

theissenhelen and others added 28 commits December 6, 2024 12:02
…e-improved-configuration-and-data-structures
@FussyDuck
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ theissenhelen
❌ chebertpinard
You have signed the CLA already but the status is still pending? Let us recheck it.

@theissenhelen theissenhelen linked an issue Jan 16, 2025 that may be closed by this pull request
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Now In Progress
Development

Successfully merging this pull request may close these issues.

[FEATURE] improved configuration and data structures
3 participants