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

Add schema for configurations #40

Open
jopetty opened this issue Jan 1, 2021 · 1 comment
Open

Add schema for configurations #40

jopetty opened this issue Jan 1, 2021 · 1 comment
Assignees
Labels
enhancement New feature or request v2 Version 2 (with Hydra) wishlist New ideas that are "nice to haves"

Comments

@jopetty
Copy link
Member

jopetty commented Jan 1, 2021

Use the @dataclass annotation to create a defined schema for all the YAML configs we use. This will make it easier to type-check configs and provide clear documentation on what needs to be included in each.

See the Hydra example for more information.

@jopetty jopetty self-assigned this Jan 1, 2021
@jopetty jopetty added enhancement New feature or request v2 Version 2 (with Hydra) labels Jan 1, 2021
@jopetty jopetty changed the title Add scheme for configurations Add schema for configurations Jan 1, 2021
@jopetty jopetty added this to the Stable 1.0 milestone Jan 4, 2021
@jopetty jopetty added the wishlist New ideas that are "nice to haves" label Jan 9, 2021
@jopetty jopetty removed this from the Stable 1.0 milestone Jan 9, 2021
@jopetty
Copy link
Member Author

jopetty commented Jan 9, 2021

I don't think this makes sense for the 1.0 release. The nature of the configurations is so in flux right now that adding structured configs for most things seems like it won't bring much benefit yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v2 Version 2 (with Hydra) wishlist New ideas that are "nice to haves"
Projects
None yet
Development

No branches or pull requests

1 participant