File size: 17,065 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 |
---
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` | <p>Objective goal ex. 0.99</p> |
| `-M`, `--objective-metric` | <p>Objective metric ex. <code>val_accuracy</code></p> |
| `--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)_ | <p>Search space parameters in the form of <code>[name] [type] [range_type] [values...]</code>. <code>[type]</code> must be one of <code>categorical</code>, <code>int</code>, or <code>double</code>. <code>[range_type]</code> must be either <code>space</code> or <code>list</code>. If <code>space</code>, <code>[values...]</code> is a 3-tuple of <code>[min] [max] [step]</code>. If <code>list</code> , <code>[values...]</code> is a list of values to search.</p><p>ex. <code>-p epochs int space 100 1000 50</code> </p> |
| `-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` | <p>GPU type (for custom cluster only)</p><p>ex. <code>Tesla-K80</code></p> |
| `--gpu-limit` | Number of GPU cores (for custom cluster only) |
| `-i`, `--image-url` | <p>Kernel docker image URL</p><p>ex. <code>vessl/kernels:py36.full-cpu</code></p> |
| `--early-stopping-name` | Early stopping algorithm name |
| `--early-stopping-settings` | <p>Early stopping algorithm settings in the format of <code>[key] [value]</code>ex. <code>--early-stopping-settings start_step 4</code></p> |
| `--message` | Message |
| `-h`, `--hyperparameter` (_multiple_) | <p>Hyperparameters in the form of <code>[key]=[value]</code></p><p>ex. <code>-h lr=0.01 -h epochs=100</code></p> |
| `--dataset` (_multiple_) | <p>Dataset mounts in the form of <code>[mount_path] [dataset_name]</code></p><p>ex. <code>--dataset /input mnist</code></p> |
| `--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 |
|