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

document update for modelkit overview #67

Merged
merged 1 commit into from Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
Expand Up @@ -59,6 +59,7 @@ export default defineConfig({
text: 'ModelKit',
items: [
{ text: 'Introduction', link: '/docs/modelkit/intro' },
{ text: 'Specification', link: 'docs/modelkit/spec.md' },
]
},
{
Expand Down
19 changes: 19 additions & 0 deletions docs/src/docs/modelkit/intro.md
@@ -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.
Copy link
Contributor

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?

Copy link
Contributor Author

@gorkem gorkem Mar 6, 2024

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.

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions pkg/artifact/spec.md → docs/src/docs/modelkit/spec.md
Expand Up @@ -4,7 +4,7 @@ A **ModelKit** represents a comprehensive bundle of AI/ML artifacts, including m

## Terminology and Structure

![ModelKit](../../docs/src/docs/manifest/model-kit.excalidraw.svg)


**Artifacts:** The building blocks of a ModelKit. 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 kitfile, ensuring comprehensive documentation of each component.

Expand Down Expand Up @@ -46,4 +46,4 @@ Example of a ModelKit manifest with a single serialized model and kitfile.
}
]
}
```
```