-
Notifications
You must be signed in to change notification settings - Fork 69
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
Slim kitfile spec #389
Slim kitfile spec #389
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need docs update to accompy this but otherwise looks good.
Turns out I had some copy-paste typos in the integration tests and this caught them, so we're already ahead :D |
I was kind of heading the other direction, I was considering turning the package-level license field into a list, so you could have package:
license: ["MIT", "CC BY-SA 4.0"] or similar. At the end of the day, unpacking any of the layers should unpack a LICENSE file as well. I'll update it to revert the license change (and then re-update #395 to match) |
78f7b73
to
e642dec
Compare
Alright all license changes are reverted. We want licenses on models/datasets/code sections, and have to keep the package-level license field too since most existing modelkits use it. |
Docs changes are in #395 |
* Remove 'license' fields from each part, leaving only the top-level license * Remove dataset references from model, since there's only one model now * Remove preprocessing field from datasets * Rename fields internally to match their name in the kitfile (package instead of kitfile, etc.)
Turns out restricting kitfiles to only known fields was useful for showing some invalid Kitfiles.
e642dec
to
aba8411
Compare
Description
Trim down the kitfile spec for simplicity (removed fields can be re-added later if we find a need for them):
Remove license field frommodel
,dataset
, andcode
, leaving only the top-level package licenseTrainedModel -> Model
)This PR also changes how Kitfiles are parsed to print an error if an unknown field is present:
(This could be cleaned up but the yaml package does not give us many easy options to do so right now)
Linked issues
Closes #239