Skip to main content
Create a new autoscale group

Usage

vastai create workergroup [OPTIONS]

Options

--template_hash
string
template hash (required, but Note: if you use this field, you can skip search_params, as they are automatically inferred from the template)
--template_id
integer
template id (optional)
-n
boolean
Disable default search param query args (alias: --no-default)
--launch_args
string
launch args string for create instance ex: “--onstart onstart_wget.sh --env ‘-e ONSTART_PATH=https://s3.amazonaws.com/vast.ai/onstart_OOBA.sh--image atinoda/text-generation-webui:default-nightly --disk 64”
--endpoint_name
string
deployment endpoint name (allows multiple workergroups to share same deployment endpoint)
--endpoint_id
integer
deployment endpoint id (allows multiple workergroups to share same deployment endpoint)
--test_workers
integer
default:"3"
number of workers to create to get an performance estimate for while initializing workergroup (default 3)
--gpu_ram
number
estimated GPU RAM req (independent of search string)
--search_params
string
search param string for search offers ex: “gpu_ram>=23 num_gpus=2 gpu_name=RTX_4090 inet_down>200 direct_port_count>2 disk_space>=64”
--min_load
number
[NOTE: this field isn’t currently used at the workergroup level] minimum floor load in perf units/s (token/s for LLms)
--target_util
number
[NOTE: this field isn’t currently used at the workergroup level] target capacity utilization (fraction, max 1.0, default 0.9)
--cold_mult
number
[NOTE: this field isn’t currently used at the workergroup level]cold/stopped instance capacity target as multiple of hot capacity target (default 2.0)
--cold_workers
integer
min number of workers to keep ‘cold’ for this workergroup

Description

Create a new autoscaling group to manage a pool of worker instances. Example: vastai create workergroup --template_hash HASH --endpoint_name “LLama” --test_workers 5

Examples

vastai create workergroup

Global Options

The following options are available for all commands:
OptionDescription
--url URLServer REST API URL
--retry NRetry limit
--rawOutput machine-readable JSON
--explainVerbose explanation of API calls
--api-key KEYAPI key (defaults to ~/.config/vastai/vast_api_key)