VastAI.create_instances

Create multiple instances from a list of offer IDs.

Signature

VastAI.create_instances(
    ids: List[int],
    image: Optional[str] = None,
    disk: float = 10,
    env: Optional[Union[str, dict]] = None,
    price: Optional[float] = 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,
    force: bool = False,
    cancel_unavail: bool = False,
    template_hash: Optional[str] = None,
    user: Optional[str] = None,
    runtype: Optional[str] = None,
    args: Optional[list] = None,
    volume_info: Optional[dict] = None,
    bid_price: Optional[float] = None,
    ssh: bool = False,
    jupyter: bool = False,
    direct: bool = False,
    create_volume: Optional[int] = None,
    link_volume: Optional[int] = None,
    volume_size: Optional[float] = None,
    mount_path: Optional[str] = None,
    volume_label: Optional[str] = None
) -> dict

Parameters

List[int]

required

ids of instance types to launch (returned from search offers)

Optional[str]

docker container image to launch

float

default:"10"

size of local disk partition in GB

Optional[Union[str, dict]]

env variables and port mapping options, surround with ”

Optional[float]

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

Skip sanity checks when creating from an existing instance

bool

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

Optional[str]

Create instance from template info

Optional[str]

User to use with docker create. This breaks some images, so only use this if you are certain you need it.

Optional[str]

Optional[list]

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

Optional[dict]

Optional[float]

(OPTIONAL) create an INTERRUPTIBLE instance with per machine bid price in $/hour

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

Optional[int]

Create a new local volume using an ID returned from the “search volumes” command and link it to the new instance

Optional[int]

ID of an existing rented volume to link to the instance during creation. (returned from “show volumes” cmd)

Optional[float]

Size of the volume to create in GB. Only usable with —create-volume (default 15GB)

Optional[str]

The path to the volume from within the new instance container. e.g. /root/volume

Optional[str]

(optional) A name to give the new volume. Only usable with —create-volume

Returns

dict

Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.create_instances(ids=12345)
print(result)

CLI

SDK

Signature

Parameters

Returns

Example

​Signature

​Parameters

​Returns

​Example

Signature

Parameters

Returns

Example