Usage
Description
Run your code in a docker container. Run your program inside a Docker image with W&B configured. Set theWANDB_DOCKER and WANDB_API_KEY environment variables in the
container and mount the current working directory at /app by
default.
Pass additional arguments to insert them into docker run before the
image name. If you do not specify an image, select a default image
automatically.
wandb is
installed. If you pass --jupyter, ensure Jupyter is installed and
start JupyterLab on port 8888.
If NVIDIA Docker is available, use the NVIDIA runtime automatically.
To set W&B environment variables for an existing docker run
command without modifying the entrypoint, use wandb docker-run.
Arguments
| Name | Default | Type |
|---|---|---|
docker_run_args | None | STR |
docker_image | None | STR |
Options
| Flag | Type | Description |
|---|---|---|
--nvidia / --no-nvidia | BOOL Flag | Use the nvidia runtime, defaults to nvidia if nvidia-docker is present Default: False |
--digest | BOOL Flag | Output the image digest and exit Default: False |
--jupyter / --no-jupyter | BOOL Flag | Run jupyter lab in the container Default: False |
--dir | STR | Which directory to mount the code in the container Default: /app |
--no-dir | BOOL Flag | Don’t mount the current directory Default: False |
--shell | STR | The shell to start the container with Default: /bin/bash |
--port | STR | The host port to bind jupyter on Default: 8888 |
--cmd | STR | The command to run in the container Default: None |
--no-tty | BOOL Flag | Run the command without a tty Default: False |