spec: add initial model config definition #25
Conversation
Right now we define a lot of model general information as annotations. They should be defined as a field of model config. We use the guidelines below to decide if a model artifact description should be an annotation or in a structured config file: * If a description belongs to a specific layer, it SHOULD be an annotation * If a description describes a general property of the model, it SHOULD be in a config Also a `ModelFS` structure is introduced to describe the ordering of multiple layers. Fixes: CloudNativeAI#19 Fixes: CloudNativeAI#22 Signed-off-by: Peng Tao <[email protected]>
bergwolf
force-pushed
the
add-model-config
branch
from
7955ca7 to
5714784
Compare
| Descriptor ModelDescriptor `json:"descriptor"` | ||
|
|
||
| // The model describes a layer content addresses | ||
| ModelFS ModelFS `json:"modelfs"` |
There was a problem hiding this comment.
Would it be better to import the ModelFS type from github.com/opencontainers/image-spec/specs-go/v1.RootFS instead of defining it ourselves?
The benefit is that it just demonstrates a clear alignment with the image-spec standard.
However, the downside is that it may cause confusion, as people might wonder why there is a RootFS in an OCI Artifacts Config.
There was a problem hiding this comment.
Yeah, the RootFS name is confusing. Let's define it here ;)
|
Currently, we define ModelFS in a manner similar to that of RootFS within an image config. Does this mean that the container runtime must be able to parse the "application/vnd.cnai.model.config.v1+json" format to handle layers correctly? like reading the (I'm not sure whether container runtime will parse the image config when pulling a normal OCI image) |
|
lgtm |
Right now we define a lot of model general information as annotations. They should be defined as a field of model config.
We use the guidelines below to decide if a model artifact description should be an annotation or in a structured config file:
Also, a
ModelFSstructure is introduced to describe the ordering of multiple layers.When we have agreed on the contents, I'll add a
config.mdto describe details of each field especially whether it isREQUIREDorOPTIONALin a separate PR.What's more, there is a slight conflict with #24. Will solve it if #24 gets merged first.
Fixes: #19
Fixes: #22