Skip to main content
Update an existing autoscale worker group.

Signature

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

Parameters

id
int
required
id
min_load
Optional[float]
min_load
target_util
Optional[float]
target_util
cold_mult
Optional[float]
cold_mult
cold_workers
Optional[int]
cold_workers
test_workers
Optional[int]
test_workers
gpu_ram
Optional[float]
gpu_ram
template_hash
Optional[str]
template_hash
template_id
Optional[int]
template_id
search_params
Optional[str]
search_params
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

Returns

str — Result from the API call.

Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.update_workergroup(id=12345)
print(result)