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
document update for modelkit overview #67
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# ModelKit Overview | ||
|
||
ModelKit revolutionizes the way AI/ML artifacts are shared and managed throughout the lifecycle of AI/ML projects. As an OCI-compliant packaging format, ModelKit encapsulates datasets, code, configurations, and models into a single, standardized unit. This approach not only streamlines the development process but also ensures broad compatibility and integration with a vast array of tools and platforms. | ||
|
||
## Key Features of ModelKit: | ||
|
||
**Seamless Sharing and Collaboration:** ModelKit's standardized format fosters a collaborative environment, enabling teams to share and manage AI/ML artifacts effortlessly across different stages of development. | ||
|
||
**Wide Compatibility:** Being OCI-compliant, ModelKits can be stored, versioned, and tagged using existing infrastructure like DockerHub or GitHub Packages, leveraging familiar workflows for AI/ML artifacts and streamlining infrastructure costs. | ||
|
||
**Efficient Artifact Management:** Unlike traditional container images, ModelKits allow for direct addressing of included artifacts. This means tools can selectively unpack only the required datasets or code at any given stage, optimizing resource usage and speeding up development. | ||
|
||
**Enhanced Efficiency for Shared Artifacts:** ModelKits are designed to efficiently handle shared artifacts across multiple versions. When the same dataset, for instance, are used by several ModelKits, this approach significantly reduces duplication and storage overhead. | ||
|
||
**Built-in Versioning and Tagging:** Leveraging existing container registry infrastructure, ModelKits support sophisticated versioning and tagging strategies out of the box, something that requires additional tooling or manual management with traditional storage. | ||
|
||
**Optimized for AI/ML Workflows:** ModelKits are tailor-made for AI/ML projects, addressing specific needs such as versioning and environment configuration. | ||
|
||
ModelKit is not just a packaging format; it's a building block for innovation, simplifying the complexities of AI/ML development and deployment. By adopting ModelKit, teams can focus more on creating value and less on managing the intricacies of artifact storage and sharing. |
2 changes: 1 addition & 1 deletion
2
...rc/docs/manifest/model-kit.excalidraw.svg → ...rc/docs/modelkit/model-kit.excalidraw.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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.
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.
This is just to store the image here? i dont see it being used in the md content?
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.
Yes, we need a version that goes with the site design.