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

doc tweaks #54

Merged
merged 1 commit into from
Feb 29, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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' },
]
},
Expand Down
25 changes: 14 additions & 11 deletions docs/src/docs/cli/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,24 @@ Available Commands:
| `dev` | Run the serialized model | <!-- starts a server on a given port and drops the model in there for inference -->
| `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:

```sh
$ ./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"
Expand All @@ -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.
3 changes: 3 additions & 0 deletions docs/src/docs/kitfile/kf-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Kitfiles

A Kitfile is a manifest showing what is in
18 changes: 0 additions & 18 deletions docs/src/docs/kitfile/overview.md

This file was deleted.