wandb launch

GitHub source

Usage

wandb launch [OPTIONS]

Description

Launch or queue a W&B Job. See https://wandb.me/launch

Options

Flag	Type	Description
--uri, -u	STR	Local path or git repo uri to launch. If provided this command will create a job from the specified uri. Default: None
--job, -j	STR	Name of the job to launch. If passed in, launch does not require a uri. Default: None
--entry-point, -E	STR	Entry point within project. [default: main]. If the entry point is not found,
attempts to run the project file with the specified name as a script,
using ‘python’ to run .py files and the default shell (specified by
environment variable $SHELL) to run .sh files. If passed in, will override the entrypoint value passed in using a config file. Default: None
--git-version, -g	STR	Version of the project to run, as a Git commit reference for Git projects. Default: None
--build-context	STR	Path to the build context within the source code. Defaults to the root of the source code. Compatible only with -u. Default: None
--job-name, -J	STR	Name for the job created if the -u,—uri flag is passed in. Default: None
--name	STR	Name of the run under which to launch the run. If not
specified, a random run name will be used to launch run. If passed in, will override the name passed in using a config file. Default: None
--entity, -e	STR	Name of the target entity which the new run will be sent to. Defaults to using the entity set by local wandb/settings folder.
If passed in, will override the entity value passed in using a config file. Default: None
--project, -p	STR	Name of the target project which the new run will be sent to. Defaults to using the project name given by the source uri
or for github runs, the git repo name. If passed in, will override the project value passed in using a config file. Default: None
--resource, -r	STR	Execution resource to use for run. Supported values: ‘local-process’, ‘local-container’, ‘kubernetes’, ‘sagemaker’, ‘gcp-vertex’.
This is now a required parameter if pushing to a queue with no resource configuration.
If passed in, will override the resource value passed in using a config file. Default: None
--docker-image, -d	STR	Specific docker image you’d like to use. In the form name:tag.
If passed in, will override the docker image value passed in using a config file. Default: None
--base-image, -B	STR	Docker image to run job code in. Incompatible with —docker-image. Default: None
--config, -c	STR	Path to JSON file (must end in ‘.json’) or JSON string which will be passed
as a launch config. Dictation how the launched run will be configured. Default: None
--set-var, -v	STR	Set template variable values for queues with allow listing enabled,
as key-value pairs e.g. --set-var key1=value1 --set-var key2=value2 Default: None
--queue, -q	STR	Name of run queue to push to. If none, launches single run directly. If supplied without
an argument (--queue), defaults to queue ‘default’. Else, if name supplied, specified run queue must exist under the
project and entity supplied. Default: None
--async	BOOL Flag	Flag to run the job asynchronously. Defaults to false, i.e. unless —async is set, wandb launch will wait for
the job to finish. This option is incompatible with —queue; asynchronous options when running with an agent should be
set on wandb launch-agent. Default: False
--resource-args, -R	STR	Path to JSON file (must end in ‘.json’) or JSON string which will be passed
as resource args to the compute resource. The exact content which should be
provided is different for each execution backend. See documentation for layout of this file. Default: None
--build, -b	BOOL Flag	Flag to build an associated job and push to queue as an image job. Default: False
--repository, -rg	STR	Name of a remote repository. Will be used to push a built image to. Default: None
--project-queue, -pq	STR	Name of the project containing the queue to push to. If none, defaults to entity level queues. Default: None
--dockerfile, -D	STR	Path to the Dockerfile used to build the job, relative to the job’s root Default: None
--priority, -P	Choice	When —queue is passed, set the priority of the job. Launch jobs with higher priority
are served first. The order, from highest to lowest priority, is: critical, high, medium, low Default: None