Skip to content

Commit

Permalink
Add Dagger to docs
Browse files Browse the repository at this point in the history
* Added links to Daggerverse modules to docs
* Fixed a rendering issue
  • Loading branch information
bmicklea committed Nov 4, 2024
1 parent 32aa23e commit fcf6970
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 7 deletions.
6 changes: 5 additions & 1 deletion docs/src/docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ After entering your username and password, you'll see `Log in successful`. If yo

Let's use the [unpack command](./cli/cli-reference.md#kit-unpack) to pull a [sample ModelKit from Jozu Hub](https://jozu.ml/browse) to our machine that we can play with. In this case, we'll unpack the whole thing, but one of the great things about Kit is that you can also selectively unpack only the artifacts you need: just the model, the model and dataset, the code, the configuration...whatever you want. Check out the `unpack` [command reference](./cli/cli-reference.md#kit-unpack) for details.

If you have a model already on your machine you can use that instead.

You can grab <a href="https://jozu.ml/discover"
v-ga-track="{
category: 'link',
Expand Down Expand Up @@ -137,6 +139,8 @@ If you'd like to learn more about using Kit, try our [Next Steps with Kit](./nex
* Tagging ModelKits
* Keeping your registry tidy

Or, if you want to run an LLM-based ModelKit locally try our [dev mode](./dev-mode.md)
Or, if you want to run an LLM-based ModelKit locally try our [dev mode](./dev-mode.md).

Finally, if you're building workflows using Dagger you can use KitOps through our [Daggerverse modules](https://daggerverse.dev/mod/github.com/jozu-ai/daggerverse/kit).

Thanks for taking some time to play with Kit. We'd love to hear what you think. Feel free to drop us an [issue in our GitHub repository](https://github.com/jozu-ai/kitops/issues) or join [our Discord server](https://discord.gg/Tapeh8agYy).
20 changes: 15 additions & 5 deletions docs/src/docs/modelkit/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,14 @@ ModelKit packages can be pushed to any OCI 1.1-compliant registry, whether in th

ModelKits themselves use standards like JSON, YAML, and TAR files so whatever MLOps or DevOps tools you're using...they'll work with ModelKits.

If you've tried using Kit with your favorite tool and are having trouble, please [open an issue](https://github.com/jozu-ai/kitops/issues/new/choose) in our GitHub repository.

If you've used KitOps with a product or project we've missed, please open a pull request updating this file.

## Compliant OCI Registries

The most fully-featured repository for ModelKits is the [Jozu Hub](https://jozu.ml/), however, many users find it easiest to store their ModelKits in an existing enterprise container registry:

* Amazon Elastic Container Registry (ECR)
* Azure Container Registry
* Docker Hub
Expand All @@ -15,7 +21,16 @@ ModelKits themselves use standards like JSON, YAML, and TAR files so whatever ML
* Harbor
* IBM Cloud Container Registry
* JFrog Artifactory
* Jozu Hub
* Red Hat Quay.io
* Sonatype Nexus

## CI/CD & Pipline Tools

### Pre-Built Workflows

* Dagger: see [Kit modules for Dagger](https://daggerverse.dev/mod/github.com/jozu-ai/daggerverse/kit) in the Daggerverse
* GitHub Actions: Kit CLI for [GitHub Actions](https://github.com/marketplace/actions/setup-kit-cli)

## Other Compatible Tools

Expand Down Expand Up @@ -61,12 +76,7 @@ ModelKits themselves use standards like JSON, YAML, and TAR files so whatever ML
* Red Hat OpenShift
* Red Hat OpenShift AI
* Seldon
* Sonatype Nexus
* Tensorflow Hub
* VMware
* Weights & Biases
* ZenML

If you've tried using Kit with your favorite tool and are having trouble, please [open an issue](https://github.com/jozu-ai/kitops/issues/new/choose) in our GitHub repository.

If you've used KitOps with a product or project we've missed, please open a pull request updating this file.
4 changes: 3 additions & 1 deletion docs/src/docs/modelkit/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

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.

<!-- Start with a [ModelKit Quick Start](TBD), -->See the [ModelKit spec](./spec.md), or look over the [tool compatibility list](./compatibility.md).
[Get started with ModelKits](../get-started.md) in less than 15 minutes.

See the [ModelKit spec](./spec.md), or look over the [tool compatibility list](./compatibility.md).

## Key Features of ModelKit:

Expand Down

0 comments on commit fcf6970

Please sign in to comment.