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

spec: add initial model config definition #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bergwolf
Copy link
Contributor

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.

When we have agreed on the contents, I'll add a config.md to describe details of each field especially whether it is REQUIRED or OPTIONAL in 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

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]>
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.

Defining the diffID Generation Order in the Model Spec [RFC] Model annotation and config guidelines
1 participant