VastAI.launch_instance

Launch the top instance from search offers matching the given criteria.

Signature

VastAI.launch_instance(
    gpu_name: str,
    num_gpus: str,
    image: str,
    region: Optional[str] = None,
    disk: float = 10,
    order: str = 'score-',
    limit: Optional[int] = None,
    env: Optional[Union[str, dict]] = None,
    label: Optional[str] = None,
    extra: Optional[str] = None,
    onstart_cmd: Optional[str] = None,
    login: Optional[str] = None,
    python_utf8: bool = False,
    lang_utf8: bool = False,
    jupyter_lab: bool = False,
    jupyter_dir: Optional[str] = None,
    cancel_unavail: bool = False,
    template_hash: Optional[str] = None,
    runtype: Optional[str] = None,
    args: Optional[list] = None,
    query: Optional[dict] = None,
    ssh: bool = False,
    jupyter: bool = False,
    direct: bool = False
) -> dict

Parameters

str

required

Name of the GPU model, replace spaces with underscores

str

required

Number of GPUs required

str

required

Name of the image to use for instance

Optional[str]

Geographical location of the instance

float

default:"10"

Disk space required in GB

str

default:"score-"

Comma-separated list of fields to sort on. postfix field with - to sort desc. ex: -o ‘num_gpus,total_flops-’. default=‘score-’

Optional[int]

Optional[Union[str, dict]]

env variables and port mapping options, surround with ”

Optional[str]

label to set on the instance

Optional[str]

contents of onstart script as single argument

docker login arguments for private repo authentication, surround with ”

bool

Workaround for images with locale problems: set python’s locale to C.UTF-8

bool

Workaround for images with locale problems: install and generate locales before instance launch, and set locale to C.UTF-8

bool

For runtype ‘jupyter’, Launch instance with jupyter lab

Optional[str]

For runtype ‘jupyter’, directory in instance to use to launch jupyter. Defaults to image’s working directory

bool

Return error if scheduling fails (rather than creating a stopped instance)

Optional[str]

template hash which contains all relevant information about an instance. This can be used as a replacement for other parameters describing the instance configuration

Optional[str]

Optional[list]

list of arguments passed to container ENTRYPOINT. Onstart is recommended for this purpose. (must be last argument)

Optional[dict]

bool

Launch as an ssh instance type

bool

Launch as a jupyter instance instead of an ssh instance

bool

Use (faster) direct connections for jupyter & ssh

Returns

dict

Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.launch_instance(gpu_name="value", num_gpus="value", image="value")
print(result)

CLI

SDK

Signature

Parameters

Returns

Example

​Signature

​Parameters

​Returns

​Example

Signature

Parameters

Returns

Example