Update Model Kit Specification #44
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bmicklea
requested changes
Feb 26, 2024
pkg/artifact/spec.md
Outdated
|
|
||
| **Model Manifest:** Each model artifact has an associated JSON structure which describes some basic information about the model such as date created, author, format as well as inference time configuration.The JSON structure also references a cryptographic hash of each layer used by the model artifact, This JSON is considered to be immutable, because changing it would change the computed modelID. Changing it means creating a new derived model package, instead of changing the existing model image. | ||
| **Artifacts:** The building blocks of a model kit. Artifacts can be models, datasets, or code, each stored and addressed individually. This modular approach facilitates direct access via tools. Artifact metadata is encapsulated within the kit configuration file, ensuring comprehensive documentation of each component. |
There was a problem hiding this comment.
Change "model kit" to "ModelKit". Also is the "kit configuration file" the manifest, the Kitfile, or both? I think we should be specific.
pkg/artifact/spec.md
Outdated
|
|
||
| **Model Kit Manifest:** This JSON document provides essential information about the model, including creation date, authorship, and a cryptographic hash of each artifact and the Kitfile. The manifest is immutable to preserve the integrity of the ModelKitID, ensuring any modification results in the derivation of a new model kit rather than altering the existing one. |
There was a problem hiding this comment.
Replace "derivation" with "creation". You can say "...results in the creation of a new derived ModelKit..." if the fact that it's a derivative is important.
bmicklea
approved these changes
Feb 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the model kit specification with the current state