reference/cli/sweep.md

metadata

title: vessl sweep
version: EN

Overview

Run vessl sweep --help to view the list of commands, or vessl sweep [COMMAND] --help to view individual command instructions.

Create a sweep

vessl sweep create [OPTIONS]

Option	Description
-T, --objective-type	minimize or maximize
-G, --objective-goal	Objective goal ex. 0.99
-M, --objective-metric	Objective metric ex. val_accuracy
--num-experiments	Maximum number of experiments
--num-parallel	Number of experiments to be run in parallel
--num-failed	Maximum number of experiments to allow to fail
-a, --algorithm	grid, random, or bayesian
-p, --parameter (multiple)	Search space parameters in the form of [name] [type] [range_type] [values...]. [type] must be one of categorical, int, or double. [range_type] must be either space or list. If space, [values...] is a 3-tuple of [min] [max] [step]. If list , [values...] is a list of values to search. ex. -p epochs int space 100 1000 50
-c, --cluster	Cluster name (must be specified before other options)
-x, --command	Start command to execute in experiment container
-r, --resource	Resource type to run an experiment (for managed cluster only)
--processor	CPU or GPU (for custom cluster only)
--cpu-limit	Number of vCPUs (for custom cluster only)
--memory-limit	Memory limit in GiB (for custom cluster only)
--gpu-type	GPU type (for custom cluster only) ex. Tesla-K80
--gpu-limit	Number of GPU cores (for custom cluster only)
-i, --image-url	Kernel docker image URL ex. vessl/kernels:py36.full-cpu
--early-stopping-name	Early stopping algorithm name
--early-stopping-settings	Early stopping algorithm settings in the format of [key] [value]ex. --early-stopping-settings start_step 4
--message	Message
-h, --hyperparameter (multiple)	Hyperparameters in the form of [key]=[value] ex. -h lr=0.01 -h epochs=100
--dataset (multiple)	Dataset mounts in the form of [mount_path] [dataset_name] ex. --dataset /input mnist
--root-volume-size	Root volume size (defaults to 20Gi)
--working-dir	Working directory path (defaults to /work/[project_name])
--output-dir	Output directory path (defaults to /output
--local-project	Local project file URL

List all sweeps

vessl sweep list

View logs of the sweep container

vessl sweep logs [OPTIONS] NAME

Argument	Description
NAME	Sweep name

Option	Description
--tail	Number of lines to display from the end (defaults to 200)

View information on the sweep

vessl sweep read NAME

Argument	Description
NAME	sweep name

Terminate the sweep

vessl sweep terminate NAME

Argument	Description
NAME	sweep name

Find the best sweep experiment

vessl sweep best-experiment

Argument	Description
NAME	sweep name