Hugging Face's logo

Datasets:
vessl
/
vessl-docs

Dataset card Files
xet
Community
vessl-docs
File size: 4,386 Bytes 
76d9c4f
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
---
title: vessl model
version: EN
---

### Overview

Run `vessl model-repository --help` to view the list of commands related to model repositories, or `vessl model-repository [COMMAND] --help` to view individual command instructions.

Run `vessl model --help` to view the list of commands related to models, or `vessl model [COMMAND] --help` to view individual command instructions.

### Create a model repository

```
vessl model-repository [OPTIONS] NAME
```

| Argument | Description           |
| -------- | --------------------- |
| `NAME`   | Model repository name |

| Option                | Description                  |
| --------------------- | ---------------------------- |
| `-m`, `--description` | Model repository description |

### List all model repositories

```
vessl model-repository list
```

### View information on the model repository

```
vessl model-repository read NAME
```

| Argument | Description           |
| -------- | --------------------- |
| `NAME`   | Model repository name |

### Create a model

```
vessl model create [OPTIONS] REPOSITORY_NAME
```

| Argument          | Description           |
| ----------------- | --------------------- |
| `REPOSITORY_NAME` | Model repository name |

| Option            | Description                             |
| ----------------- | --------------------------------------- |
| `--model-name`    | Model name                              |
| `--source`        | Model source (experiment or local)      |
| `--experiment-id` | Experiment id to create a model         |
| `--paths`         | Paths to create model. Default: `["/"]` |

### Delete a file within a model

```
vessl model delete-file [OPTIONS] REPOSITORY_NAME MODEL_NUMBER PATH
```

| Argument          | Description           |
| ----------------- | --------------------- |
| `REPOSITORY_NAME` | Model repository name |
| `MODEL_NUMBER`    | Model number          |
| `PATH`            | File path             |

| Option            | Description                     |
| ----------------- | ------------------------------- |
| `-r, --recursive` | Required if file is a directory |

### Download the model

```
vessl model download REPOSITORY_NAME MODEL_NUMBER SOURCE DEST
```

| Argument          | Description                  |
| ----------------- | ---------------------------- |
| `REPOSITORY_NAME` | Model repository name        |
| `MODEL_NUMBER`    | Model number                 |
| `SOURCE`          | Source path within the model |
| `DEST`            | Local destination path       |

### List all models <a href="#usd-savvihub-image-list" id="usd-savvihub-image-list"></a>

```
vessl model list
```

### List model files

```
vessl model list-files [OPTIONS] REPOSITORY_NAME MODEL_NUMBER
```

| Argument          | Description           |
| ----------------- | --------------------- |
| `REPOSITORY_NAME` | Model repository name |
| `MODEL_NUMBER`    | Model number          |

| Option            | Description                               |
| ----------------- | ----------------------------------------- |
| `-p, --path`      | Directory path to list (defaults to root) |
| `-r, --recursive` | List files recursively                    |

### View information on the model

```
vessl model read REPOSITORY_NAME MODEL_NUMBER
```

| Argument          | Description           |
| ----------------- | --------------------- |
| `REPOSITORY_NAME` | Model repository name |
| `MODEL_NUMBER`    | Model number          |

### Deploy a model for serving locally

```
vessl model serve REPOSITORY_NAME MODEL_NUMBER
```

| Argument          | Description           |
| ----------------- | --------------------- |
| `REPOSITORY_NAME` | Model repository name |
| `MODEL_NUMBER`    | Model number          |

| Option           | Description                         |
| ---------------- | ----------------------------------- |
| `--install-reqs` | Install requirements before serving |

### Upload files to a model

```
vessl model upload REPOSITORY_NAME MODEL_NUMBER SOURCE DEST
```

| Argument          | Description                        |
| ----------------- | ---------------------------------- |
| `REPOSITORY_NAME` | Model repository name              |
| `MODEL_NUMBER`    | Model number                       |
| `SOURCE`          | Local source path                  |
| `DEST`            | Destinataion path within the model |