There are few ways to create a VESSL Run with YAML files. The easiest way to run YAML file is using VESSL CLI.


Before starting, make sure you have:

  • A VESSL account
  • Python installed on you machine
  • Pip package mangager
  • YAML file

Creating a Run

First, install the VESSL CLI using pip and configure VESSL by running:

pip install vessl
vessl configure

Prepare a YAML file, for example, stable_diffusion.yaml as follows in your local machine.

name: stable-diffusion
description: "An streamlit app of stable-diffusion inference."
  cluster: aws-apne2
  preset: v1.v100-1.mem-52
  /root/examples/: git://
  - workdir: /root/examples/stable-diffusion
    command: |
      bash ./ && streamlit run
  max_runtime: 24h
    idle_timeout: 120m
  - 8501

Run the file with the following command:

vessl run create -f stable_diffusion.yaml

You can access the run with the link. You can also list runs and read run with the CLI.

  • List Runs

  • Read Run

vessl run list

Web Console

Log in to the VESSL Web Console, and navigate to the Projects > [PROJECT_NAME] > Runs section. If you click + New run, you can find “Configure from a yaml file” section on the right-hand side of the interface. Either upload your YAML file or drag-and-drop it into the designated area.


For more advanced configurations and examples, you can visit VESSL Hub. The hub offers a variatey of YAML examples that you can use as references.


Export YAML

Exporting YAML files from your VESSL Web Console allows for effortless reproducibility and version control of your work. With a portable YAML, you cna use its configuration across different oragnizations and projects within VESSL.

Navigate to Projects > [PROJECT_NAME] > Runs section in the VESSL Web Console. Click the Export YAML action button as below. export_yaml_2

Navigate to a specific run page you are interested in. On the right-hand side of the top of the page, you can find Export YAML action button as the following image. export_yaml_1