File size: 8,133 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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
---
title: Model
version: EN
---
### read_model_repository
```python
vessl.read_model_repository(
repository_name: str, **kwargs
)
```
Read model repository in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
**Example**
```python
vessl.read_model_repository(
repository_name="Transformer-ImageNet",
)
```
----
## list_model_repositories
```python
vessl.list_model_repositories(
**kwargs
)
```
List model repositories in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Example**
```python
vessl.list_model_repositories()
```
----
## create_model_repository
```python
vessl.create_model_repository(
name: str, description: str = None, **kwargs
)
```
Create model repository in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `name` (str) : Model repository name.
* `description` (str) : Model repository description. Defaults to None.
**Example**
```python
vessl.create_model_repository(
name="Transformer-ImageNet",
description="Transformer model trained on ImageNet",
)
```
----
## update_model_repository
```python
vessl.update_model_repository(
name: str, description: str, **kwargs
)
```
Update model repository in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `name` (str) : Model repository name.
* `description` (str) : Model repository description to update.
**Example**
```python
vessl.update_model_repository(
name="Transformer-ImageNet",
description="Update description to this",
)
```
----
## delete_model_repository
```python
vessl.delete_model_repository(
name: str, **kwargs
)
```
Delete model repository in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `name` (str) : Model repository name.
**Example**
```python
vessl.delete_model_repository(
name="Transformer-ImageNet",
)
```
----
## read_model
```python
vessl.read_model(
repository_name: str, model_number: int, **kwargs
)
```
Read model in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
* `model_number` (int) : Model number.
**Example**
```python
vessl.read_model(
repository_name="Transformer-ImageNet",
model_number=1,
)
```
----
## list_models
```python
vessl.list_models(
repository_name: str, **kwargs
)
```
List models in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
**Example**
```python
vessl.list_models(
repository_name="Transformer-ImageNet",
)
```
----
## create_model
```python
vessl.create_model(
repository_name: str, repository_description: str = None, experiment_id: int = None,
model_name: str = None, paths: List[str] = None, **kwargs
)
```
Create model in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`. If the
given model repository name does not exist, then create one with the given
repository_description. Otherwise, create a model in the existing model
repository.
**Args**
* `repository_name` (str) : Model repository name.
* `repository_description` (str) : Model repository description. Defaults to
None
* `experiment_id` (int) : Pass experiment ID if the model is sourced from the
experiment outputs. Defaults to None.
* `model_name` (str) : Model name is unique and optional. Defaults to None.
* `paths` (List[str]) : Paths for creating model. Paths could be sub paths of
experiment output files or local file paths. Defaults to root.
**Example**
```python
vessl.create_model(
repository_name="Transformer-ImageNet",
repository_description="Transformer model trained on ImageNet",
experiment_id=123456,
model_name="v0.0.1",
)
```
----
## update_model
```python
vessl.update_model(
repository_name: str, model_number: int, name: str, **kwargs
)
```
Update model in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
* `model_number` (int) : Model number.
* `name` (str) : Model name to update.
**Example**
```python
vessl.update_model(
repository_name="Transformer-ImageNet",
model_number=1,
name="v0.0.2",
)
```
----
## delete_model
```python
vessl.delete_model(
repository_name: str, model_number: int, **kwargs
)
```
Delete model in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
* `model_number` (int) : Model number.
**Example**
```python
vessl.delete_model(
repository_name="Transformer-ImageNet",
model_number=1,
)
```
----
## list_model_volume_files
```python
vessl.list_model_volume_files(
repository_name: str, model_number: int, need_download_url: bool = False,
path: str = '', recursive: bool = False, **kwargs
)
```
List model files in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
* `model_number` (int) : Model number.
* `need_download_url` (bool) : True if you need a download URL, False
otherwise. Defaults to False.
* `path` (str) : Directory path to list. Defaults to root.
* `recursive` (bool) : True if file is a directory, False otherwise. Defaults
to False.
**Example**
```python
vessl.list_model_volume_files(
repository_name="Transformer-ImageNet",
model_number=1,
recursive=True,
)
```
----
## upload_model_volume_file
```python
vessl.upload_model_volume_file(
repository_name: str, model_number: int, source_path: str, dest_path: str,
**kwargs
)
```
Upload file to the model in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
* `model_number` (int) : Model number.
* `source_path` (str) : Local source path.
* `dest_path` (str) : Destination path within the model.
**Example**
```python
vessl.upload_model_volume_file(
repository_name="Transformer-ImageNet",
model_number=1,
source_path="model_best.pth",
dest_path="model_best.pth",
)
```
----
## download_model_volume_file
```python
vessl.download_model_volume_file(
repository_name: str, model_number: int, source_path: str, dest_path: str,
**kwargs
)
```
Download a model in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
* `model_number` (int) : Model number.
* `source_path` (str) : Source path within the model
* `dest_path` (str) : Local destination path
**Example**
```python
vessl.download_model_volume_file(
repository_name="Transformer-ImageNet",
model_number=1,
source_path="model_best.pth",
dest_path="models",
)
```
----
## delete_model_volume_file
```python
vessl.delete_model_volume_file(
repository_name: str, model_number: int, path: str, **kwargs
)
```
Delete the model volume file in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `repository_name` (str) : Model repository name.
* `model_number` (int) : Model number.
* `path` (str) : File path within the model
**Example**
```python
vessl.delete_model_volume_file(
repository_name="Transformer-ImageNet",
model_number=1,
source_path="models",
recursive=True,
)
```
|