Skip to main content
Create a new autoscale worker group.

​
Signature

VastAI.create_workergroup(
    template_hash: Optional[str] = None,
    template_id: Optional[int] = None,
    no_default: bool = False,
    launch_args: Optional[str] = None,
    endpoint_name: Optional[str] = None,
    endpoint_id: Optional[int] = None,
    test_workers: int = 3,
    gpu_ram: Optional[float] = None,
    search_params: Optional[str] = None,
    min_load: Optional[float] = None,
    target_util: Optional[float] = None,
    cold_mult: Optional[float] = None,
    cold_workers: Optional[int] = None
) -> str

​
Parameters

​
template_hash
Optional[str]
template_hash
​
template_id
Optional[int]
template_id
​
no_default
bool
default:"False"
no_default
​
launch_args
Optional[str]
launch_args
​
endpoint_name
Optional[str]
endpoint_name
​
endpoint_id
Optional[int]
endpoint_id
​
test_workers
int
default:"3"
test_workers
​
gpu_ram
Optional[float]
gpu_ram
​
search_params
Optional[str]
search_params
​
min_load
Optional[float]
min_load
​
target_util
Optional[float]
target_util
​
cold_mult
Optional[float]
cold_mult
​
cold_workers
Optional[int]
cold_workers

​
Returns

str — Result from the API call.

​
Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.create_workergroup()
print(result)