[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
  • Prerequisites
  • Workflows
  1. GETTING STARTED

End-to-end Guides

PreviousQuickstartNextCLI-driven Workflow

Last updated 3 years ago

Overview

VESSL AI provides end-to-end machine learning services for dataset mount, machine learning experiment training, hyperparameter sweep, and model managing. This document will guide you to the general end-to-end workflow of how to use those features using VESSL CLI and SDK thoroughly.

Prerequisites

In the tutorials below, an organization and a project on VESSL are required. We recommend creating an organization and a project in VESSL Web Console. For convenience, the organization name will be YOUR_ORGANIZATION_NAME and the project name will be YOUR_PROJECT_NAME. Just replace them with the organization name and project name you created, respectively.

1. Create an organization

Once you have created a VESSL account, the first thing you need to do is create an organization. Refer to the page in the VESSL Web Console to create an organization.

2. Create a project

After the organization setup is complete, you need to create a machine learning project. Similarly, refer to the page in the Web Console and create a project with a cool project name.

3. Install VESSL Client

To use VESSL CLI or SDK, you need to install VESSL Client. Execute the following command in your terminal.

pip install vessl

For more information on installing the VESSL Client, see .

Workflows

After successfully creating the organization and project in VESSL Web Console and installing VESSL Client, let's start the machine learning journey with VESSL.

create an organization
create a project
What is the VESSL CLI/SDK?
CLI-driven Workflow
SDK-driven Workflow