-
Notifications
You must be signed in to change notification settings - Fork 51
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 support for docs layers #386
Conversation
Add 'docs' top-level field to Kitfile, which is intended to store documentation for the model. Paths specified under docs are stored as separate layer types, allowing for them to be unpacked and/or parsed independently from the rest of the model.
I think it could make sense to allow for any arbitrary doc "type" to give finer control on what to unpack. Perhaps all On the license type, I think the single field for the license in the Kitfile should suffice in most cases, but the ability to single that out for unpacking could make sense. |
@Burhan-Q Thanks for your feedback! I like the idea of versioning docs layers, though it might be slightly tricky on the packing side -- when you run One workaround for that might be to use tags for versioning the modelkit, e.g. tag versions On the unpacking side, @gorkem has some ideas about making the flags for unpack work as filters, so that you could specify something like |
ModelKits themselves are versioned. If only a document changes between two versions of a ModelKit the cost of storage and network for that ModelKit is just the changed layer. The built-in versioning of ModelKits is probably enough for most cases. |
If I understand correctly, the ModelKit is a self-contained "full-history" of changes, so if someone wished to grab a specific document version, they could do so by calling the unpack for that particular version and only grab docs (if that's all they want/need). Then it makes sense that nothing extra would be needed. |
Correct. the |
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.
Code looks good and it works as expected. I think this is a good starting point for this feature. It is missing documentation updates that needs to be completed before we merge it.
Docs changes are in #395 |
Description
Adds a new field to Kitfiles:
Currently, docs are stored identically to other layers (code, datasets, model) -- i.e. as tarballs with (optional) compression.
Some considerations before merging:
docs
entry are preliminary -- do we want name/type/etc., or some way to determine what the doc should be used for (e.g. license vs readme vs ???)?Linked issues
Closes #84