Skip to content

Commit bd6dd5f

Browse files
authored
doc tweaks (#54)
* Updated the CLI usage doc for clarity * Renamed the kitfile overview doc so it has a different name than the KitOps overview doc * updated the nav
1 parent 29b0f3e commit bd6dd5f

File tree

4 files changed

+19
-30
lines changed

4 files changed

+19
-30
lines changed

docs/.vitepress/config.mts

+2-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ export default defineConfig({
6464
{
6565
text: 'Kitfile',
6666
items: [
67-
{ text: 'Structure', link: '/docs/kitfile/structure' },
67+
{ text: 'Overview', link: '/docs/kitfile/kf-overview' },
68+
{ text: 'Format', link: '../pkg/artifact/kit-file.md' },
6869
{ text: 'Benefits', link: '/docs/kitfile/benefits' },
6970
]
7071
},

docs/src/docs/cli/usage.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@ Available Commands:
1919
| `dev` | Run the serialized model | <!-- starts a server on a given port and drops the model in there for inference -->
2020
| `fetch` | Updating the local respository for a ModelKit from the remote |
2121
| `help` | Help about any command |
22+
| `list` | List ModelKits |
2223
| `login` | Login to the remote repository |
2324
| `logout` | Logout to the remote repository |
24-
| `list` | List ModelKits |
2525
| `pull` | Pull one or more of the model, dataset, code, and Kitfile into a destination folder |
2626
| `push` | Push ModelKit to respository |
2727
| `remove` | Removed the ModelKit from the local repository |
2828
| `tag` | Tags a ModelKit |
2929
| `version` | Display the version information for Kit |
3030

31-
## Example
31+
## A Few Examples
3232

3333
To list your available ModelKit:
3434

3535
```sh
3636
$ ./kit list
3737
```
3838

39-
To build a ModelKit for your model:
39+
To build a ModelKit for your model and tag it with `example-tag`:
4040

4141
```sh
4242
$ ./kit build ../examples/onnx -t localhost:5050/example-repo:example-tag"
@@ -48,27 +48,30 @@ Then you can push it to your registry:
4848
$ ./kit push localhost:5050/example-repo:example-tag --http
4949
```
5050
51-
After you finish calling all your friends and telling them about Kit they can fetch your ModelKit and run it:
51+
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.
5252
5353
```sh
5454
$ ./kit fetch localhost:5050/test-repo:test-tag --http
55-
$ ./kit dev
5655
```
5756
58-
Maybe one of your friends only wants the dataset you used:
57+
However, Kit is a *modular package* so if someone only needs the model they can `pull` only that part:
5958
6059
```sh
61-
$ ./kit pull -filter dataset
60+
$ ./kit pull -filter model
6261
```
6362
64-
Another friend only needs the model so they can integrate it with their application:
63+
Or just the dataset:
6564
6665
```sh
67-
$ ./kit pull -filter model
66+
$ ./kit pull -filter dataset
6867
```
6968
70-
To see the Kitfile associated with a ModelKit:
69+
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.
70+
71+
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:
7172
7273
```sh
73-
$ ./kit pull -filter kitfile
74+
$ ./kit dev
7475
```
76+
77+
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.

docs/src/docs/kitfile/kf-overview.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Kitfiles
2+
3+
A Kitfile is a manifest showing what is in

docs/src/docs/kitfile/overview.md

-18
This file was deleted.

0 commit comments

Comments
 (0)