kitfile overview #70
kitfile overview #70
Conversation
also rearranges the modelkit spec. Updates and removes a few unused files
There was a problem hiding this comment.
awesome! TIL that you dont even need an <img src="..." /> tag, #nice
| ] | ||
| } | ||
| ``` | ||
| <!--@include: ../../../../pkg/artifact/spec.md--> |
There was a problem hiding this comment.
FWIW Vitepress imports also supports importing just a range of lines, like:
<!--@include: ../../../../pkg/artifact/spec.md{2, 10}-->
that would only import from line 2 to line 10. Not sure how helpful that is but is good to know.
There was a problem hiding this comment.
Out of curiosity, is there a reason why this (and the other pkg md's) lives outside the docs folder? is this reused in the github repo like some sort of "readme" or something?
There was a problem hiding this comment.
It is just close to where those spec are implemented. Makes it convenient for anyone who needs to modify or understand those implementations
| The artifacts and their media types are | ||
| * Serialized Model: `application/vnd.kitops.modelkit.model.v1.tar+gzip` | ||
| * Datasets: `application/vnd.kitops.modelkit.dataset.v1.tar+gzip` | ||
| * Code: `application/vnd.kitops.modelkit.code.v1.tar+gzip` |
There was a problem hiding this comment.
We're somewhat overloading the term artifact here. The overall ModelKit is an OCI artifact, and the model, datasets, and code are stored as layers within that artifact (since we're reusing the OCI image manifest spec). Referring to the layers as artifacts as well is a little confusing -- is there another word that works (or is "layers" sufficient)?
There was a problem hiding this comment.
Layers are confusing too becuase they suggest model kit is built incrementally with layers. I agree that artifact is overused on this context but I could not find a better word to describe
There was a problem hiding this comment.
We could refer to them as packages which would fit with pack and unpack commands. Although that might get confusing since code libraries are often referred to as packages, maybe especially in Python... Could we call them "parcels" - that's also something you can pack/unpack...
| * Datasets: `application/vnd.kitops.modelkit.dataset.v1.tar+gzip` | ||
| * Code: `application/vnd.kitops.modelkit.code.v1.tar+gzip` | ||
|
|
||
| **ModelKit File (Kitfile)** Acts as a record detailing the properties, relationships, and intended uses of the included artifacts. The Kitfile is central to understanding the structure and purpose of a ModelKit. It adopts the `application/vnd.kitops.modelkit.config.v1+json` media type for easy access and interpretation by tools.See the seperate kitfile specification on details |
There was a problem hiding this comment.
| **ModelKit File (Kitfile)** Acts as a record detailing the properties, relationships, and intended uses of the included artifacts. The Kitfile is central to understanding the structure and purpose of a ModelKit. It adopts the `application/vnd.kitops.modelkit.config.v1+json` media type for easy access and interpretation by tools.See the seperate kitfile specification on details | |
| **ModelKit File (Kitfile)** Acts as a record detailing the properties, relationships, and intended uses of the included artifacts. The Kitfile is central to understanding the structure and purpose of a ModelKit. It adopts the `application/vnd.kitops.modelkit.config.v1+json` media type for easy access and interpretation by tools. See the seperate kitfile specification on details |
Also, should we merge the kitfile specification and spec.md into one document? There's a fair bit of overlap.
There was a problem hiding this comment.
This document makes no reference to the OCI spec -- do we want to include mention there? Otherwise, it might be confusing to see schemaVersion: 2 in the manifest JSON file.
There was a problem hiding this comment.
Yes, we should refer to the OCI spec for this section.
Co-authored-by: Angel Misevski <amisevsk@gmail.com>
Co-authored-by: Angel Misevski <amisevsk@gmail.com>
There was a problem hiding this comment.
I'm approving this although I would like us to try and find a better word for the parts of the ModelKit than artifact. I've made a couple of suggestions in a comment. However, I don't see the overloaded use of artifact as a blocker for merging so if we can't decide on something quickly let's go ahead and merge if everything else is good.
| The artifacts and their media types are | ||
| * Serialized Model: `application/vnd.kitops.modelkit.model.v1.tar+gzip` | ||
| * Datasets: `application/vnd.kitops.modelkit.dataset.v1.tar+gzip` | ||
| * Code: `application/vnd.kitops.modelkit.code.v1.tar+gzip` |
There was a problem hiding this comment.
We could refer to them as packages which would fit with pack and unpack commands. Although that might get confusing since code libraries are often referred to as packages, maybe especially in Python... Could we call them "parcels" - that's also something you can pack/unpack...
Rearranges the modelkit spec. Updates and removes a few unused files