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 schemas for model configs #525

Merged
merged 7 commits into from
Sep 23, 2024
Merged

Add schemas for model configs #525

merged 7 commits into from
Sep 23, 2024

Conversation

alexdewar
Copy link
Contributor

This PR adds JSON schemas for both static and dynamic model configuration files. I've used the files in healthgps-examples as a reference, which means that the schemas are currently slightly out of step with the model parsing code in HealthGPS (see #521). I don't intend to enforce these schemas for now though -- I just want them as a reference for when we make a release for healthgps-examples. Once we've done that, I'll start on some v2 schemas that we can actually enforce (though I'll probably still need some example config files to work from).

All the config files in healthgps-examples validate successfully with these schemas 🥳.

There is one small unrelated fix: I noticed that the schema for the index.json file doesn't allow the user to omit the random seed (which they can do by providing an empty array: #487) so I've changed that.

Closes #450. Closes #451.

Copy link
Contributor

@jamesturner246 jamesturner246 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Probably for the best not to enforce these just yet, like you say. The latest model changes add yet more fields, but they can be done in another PR. 👍

@alexdewar alexdewar merged commit 88ef3ce into main Sep 23, 2024
5 checks passed
@alexdewar alexdewar deleted the model-schemas branch September 23, 2024 07:44
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

Successfully merging this pull request may close these issues.

Add JSON schemas for dynamic risk factor models Add JSON schemas for static risk factor models
2 participants