dev-environment¶
The dev-environment configuration type allows running dev environments.
Configuration files must have a name ending with
.dstack.yml(e.g.,.dstack.ymlordev.dstack.ymlare both acceptable) and can be located in the project's root directory or any nested folder. Any configuration can be run viadstack run . -f PATH.
Examples¶
Python version¶
If you don't specify image, dstack uses the default Docker image pre-configured with
python, pip, conda (Miniforge), and essential CUDA drivers.
The python property determines which default Docker image is used.
type: dev-environment
python: "3.11"
ide: vscode
nvcc
Note that the default Docker image doesn't bundle nvcc, which is required for building custom CUDA kernels.
To install it, use conda install cuda.
Docker image¶
type: dev-environment
image: ghcr.io/huggingface/text-generation-inference:latest
ide: vscode
Private registry
Use the registry_auth property to provide credentials for a private Docker registry.
type: dev-environment
image: ghcr.io/huggingface/text-generation-inference:latest
registry_auth:
username: peterschmidt85
password: ghp_e49HcZ9oYwBzUbcSk2080gXZOU2hiT9AeSR5
ide: vscode
Resources¶
If you specify memory size, you can either specify an explicit size (e.g. 24GB) or a
range (e.g. 24GB.., or 24GB..80GB, or ..80GB).
type: dev-environment
ide: vscode
resources:
# 200GB or more RAM
memory: 200GB..
# 4 GPUs from 40GB to 80GB
gpu: 40GB..80GB:4
# Shared memory
shm_size: 16GB
disk: 500GB
The gpu property allows specifying not only memory size but also GPU names
and their quantity. Examples: A100 (one A100), A10G,A100 (either A10G or A100),
A100:80GB (one A100 of 80GB), A100:2 (two A100), 24GB..40GB:2 (two GPUs between 24GB and 40GB),
A100:40GB:2 (two A100 GPUs of 40GB).
Shared memory
If you are using parallel communicating processes (e.g., dataloaders in PyTorch), you may need to configure
shm_size, e.g. set it to 16GB.
Environment variables¶
type: dev-environment
env:
- HUGGING_FACE_HUB_TOKEN
- HF_HUB_ENABLE_HF_TRANSFER=1
ide: vscode
If you don't assign a value to an environment variable (see HUGGING_FACE_HUB_TOKEN above),
dstack will require the value to be passed via the CLI or set in the current process.
For instance, you can define environment variables in a .env file and utilize tools like direnv.
Default environment variables¶
The following environment variables are available in any run and are passed by dstack by default:
| Name | Description |
|---|---|
DSTACK_RUN_NAME |
The name of the run |
DSTACK_REPO_ID |
The ID of the repo |
DSTACK_GPUS_NUM |
The total number of GPUs in the run |
Spot policy¶
You can choose whether to use spot instances, on-demand instances, or any available type.
type: dev-environment
ide: vscode
spot_policy: auto
The spot_policy accepts spot, on-demand, and auto. The default for dev environments is on-demand.
Backends¶
By default, dstack provisions instances in all configured backends. However, you can specify the list of backends:
type: dev-environment
ide: vscode
backends: [aws, gcp]
Regions¶
By default, dstack uses all configured regions. However, you can specify the list of regions:
type: dev-environment
ide: vscode
regions: [eu-west-1, eu-west-2]
The dev-environment configuration type supports many other options. See below.