diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 491d4471..28300bec 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -64,7 +64,8 @@ export default defineConfig({ { text: 'Kitfile', items: [ - { text: 'Structure', link: '/docs/kitfile/structure' }, + { text: 'Overview', link: '/docs/kitfile/kf-overview' }, + { text: 'Format', link: '../pkg/artifact/kit-file.md' }, { text: 'Benefits', link: '/docs/kitfile/benefits' }, ] }, diff --git a/docs/src/docs/cli/usage.md b/docs/src/docs/cli/usage.md index 8d710d6e..7ae30b85 100644 --- a/docs/src/docs/cli/usage.md +++ b/docs/src/docs/cli/usage.md @@ -19,16 +19,16 @@ Available Commands: | `dev` | Run the serialized model | | `fetch` | Updating the local respository for a ModelKit from the remote | | `help` | Help about any command | +| `list` | List ModelKits | | `login` | Login to the remote repository | | `logout` | Logout to the remote repository | -| `list` | List ModelKits | | `pull` | Pull one or more of the model, dataset, code, and Kitfile into a destination folder | | `push` | Push ModelKit to respository | | `remove` | Removed the ModelKit from the local repository | | `tag` | Tags a ModelKit | | `version` | Display the version information for Kit | -## Example +## A Few Examples To list your available ModelKit: @@ -36,7 +36,7 @@ To list your available ModelKit: $ ./kit list ``` -To build a ModelKit for your model: +To build a ModelKit for your model and tag it with `example-tag`: ```sh $ ./kit build ../examples/onnx -t localhost:5050/example-repo:example-tag" @@ -48,27 +48,30 @@ Then you can push it to your registry: $ ./kit push localhost:5050/example-repo:example-tag --http ``` -After you finish calling all your friends and telling them about Kit they can fetch your ModelKit and run it: +After you finish calling all your friends and telling them about Kit, they will want to fetch your ModelKit and run it. The `fetch` command is used to bring everything in the ModelKit to your local machine - the model, dataset(s), code, and the [Kitfile](../kitfile/overview.md) manifest. ```sh $ ./kit fetch localhost:5050/test-repo:test-tag --http -$ ./kit dev ``` -Maybe one of your friends only wants the dataset you used: +However, Kit is a *modular package* so if someone only needs the model they can `pull` only that part: ```sh -$ ./kit pull -filter dataset +$ ./kit pull -filter model ``` -Another friend only needs the model so they can integrate it with their application: +Or just the dataset: ```sh -$ ./kit pull -filter model +$ ./kit pull -filter dataset ``` -To see the Kitfile associated with a ModelKit: +You can also use `pull` to filer for the `code` or the Kitfile `manifest`. When you pull any filtered part of a ModelKit you always get the Kitfile as well. + +The `dev` command will automatically generate a RESTful API for the model and then run the model and API locally so anyone can use the model: ```sh -$ ./kit pull -filter kitfile +$ ./kit dev ``` + +So with a few easy commands you've been able to package up a model, share it with others, and run it locally...and you never needed to learn Dockerfile syntax or how to deal with a Helm chart or other proprietary packaging method. \ No newline at end of file diff --git a/docs/src/docs/kitfile/kf-overview.md b/docs/src/docs/kitfile/kf-overview.md new file mode 100644 index 00000000..0a85d708 --- /dev/null +++ b/docs/src/docs/kitfile/kf-overview.md @@ -0,0 +1,3 @@ +# Kitfiles + +A Kitfile is a manifest showing what is in \ No newline at end of file diff --git a/docs/src/docs/kitfile/overview.md b/docs/src/docs/kitfile/overview.md deleted file mode 100644 index c4145974..00000000 --- a/docs/src/docs/kitfile/overview.md +++ /dev/null @@ -1,18 +0,0 @@ -# Manifest - -## Kitfiles - -Ea modi dolore ut et sunt voluptates perferendis fuga dignissimos. Excepturi dolor dolor. Fuga est odit recusandae expedita aut adipisci recusandae. Ea facilis similique quibusdam illo adipisci quis nihil et. Sint at est commodi voluptatem. - -Repellendus deserunt natus harum dolorem ducimus quae quasi. Voluptate ipsa voluptatem beatae maxime possimus. Pariatur nemo aut dolorem dolor dignissimos quaerat tempore commodi quisquam. Aperiam voluptates aut. - -Iusto asperiores dolor voluptas. Quidem molestiae praesentium rerum similique recusandae eum placeat optio. Et rem expedita aliquid a minus magni tenetur sapiente. - -## Format - -Sequi sunt laboriosam quia error sequi et quibusdam. Similique rem perferendis reprehenderit distinctio voluptatum voluptatem officiis. Autem illum quod sit. Ut debitis accusantium numquam quisquam velit repellendus facilis est. Maiores voluptatem dolores qui qui quo provident dicta dolores quam. - -Nihil quod expedita adipisci deserunt rem sint. Recusandae dolorem est magnam assumenda rerum dolores rerum. Velit dolores soluta laborum blanditiis ipsum aspernatur sed harum autem. Quaerat velit tenetur error asperiores harum. Repellat veritatis ut enim et odio. - -Eum enim ea nesciunt illum et. Accusantium sit voluptate aspernatur quasi et eos. Quia voluptatem tempore dolores alias qui magni quod. Corrupti est laboriosam deserunt autem nulla quibusdam qui aut. -