[DEV] VESSL Docs
  • Welcome to VESSL Docs!
  • GETTING STARTED
    • Overview
    • Quickstart
    • End-to-end Guides
      • CLI-driven Workflow
      • SDK-driven Workflow
  • USER GUIDE
    • Organization
      • Creating an Organization
      • Organization Settings
        • Add Members
        • Set Notifications
        • Configure Clusters
        • Add Integrations
        • Billing Information
    • Project
      • Creating a Project
      • Project Overview
      • Project Repository & Project Dataset
    • Clusters
      • Cluster Integrations
        • Fully Managed Cloud
        • Personal Laptops
        • On-premise Clusters
        • Private Cloud (AWS)
      • Cluster Monitoring
      • Cluster Administration
        • Resource Specs
        • Access Control
        • Quotas and Limits
        • Remove Cluster
    • Dataset
      • Adding New Datasets
      • Managing Datasets
      • Tips & Limitations
    • Experiment
      • Creating an Experiment
      • Managing Experiments
      • Experiment Results
      • Distributed Experiments
      • Local Experiments
    • Model Registry
      • Creating a Model
      • Managing Models
    • Sweep
      • Creating a Sweep
      • Sweep Results
    • Workspace
      • Creating a Workspace
      • Exploring Workspaces
      • SSH Connection
      • Downloading / Attaching Datasets
      • Running a Server Application
      • Tips & Limitations
      • Building Custom Images
    • Serve
      • Quickstart
      • Serve Web Workflow
        • Monitoring Dashboard
        • Service Logs
        • Service Revisions
        • Service Rollouts
      • Serve YAML Workflow
        • YAML Schema Reference
    • Commons
      • Running Spot Instances
      • Volume Mount
  • API REFERENCE
    • What is the VESSL CLI/SDK?
    • CLI
      • Getting Started
      • vessl run
      • vessl cluster
      • vessl dataset
      • vessl experiment
      • vessl image
      • vessl model
      • vessl organization
      • vessl project
      • vessl serve
      • vessl ssh-key
      • vessl sweep
      • vessl volume
      • vessl workspace
    • Python SDK
      • Integrations
        • Keras
        • TensorBoard
      • Utilities API
        • configure
        • vessl.init
        • vessl.log
          • vessl.Image
          • vessl.Audio
        • vessl.hp.update
        • vessl.progress
        • vessl.upload
        • vessl.finish
      • Dataset API
      • Experiment API
      • Cluster API
      • Image API
      • Model API
        • Model Serving API
      • Organization API
      • Project API
      • Serving API
      • SSH Key API
      • Sweep API
      • Volume API
      • Workspace API
    • Rate Limits
  • TROUBLESHOOTING
    • GitHub Issues
    • VESSL Flare
Powered by GitBook
On this page
  • Overview
  • Create a model repository
  • List all model repositories
  • View information on the model repository
  • Create a model
  • Delete a file within a model
  • Download the model
  • List all models
  • List model files
  • View information on the model
  • Deploy a model for serving locally
  • Upload files to a model
  1. API REFERENCE
  2. CLI

vessl model

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

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

Previousvessl imageNextvessl organization

Last updated 2 years ago