Skip to main content

wandb launch

Usage

wandb launch [OPTIONS] [URI]

Summary

Launch or queue a job from a uri (Experimental). A uri can be either a wandb uri of the form https://wandb.ai/entity/project/runs/run_id, or a git uri pointing to a remote repository, or path to a local directory.

Options

OptionDescription
-j, --jobName of the job to launch. If passed in, launch does not require a uri.
--entry-pointEntry 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
-g, --git-versionVersion of the project to run, as a Git commit reference for Git projects.
-a, --args-listAn argument for the run, of the form -a name=value. Provided arguments that are not in the list of arguments for an entry point
--nameName 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
-e, --entityName of the target entity which the new run will be sent to. Defaults to using the entity set by local wandb/settings folder.If
-p, --projectName 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
-r, --resourceExecution 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
-d, --docker-imageSpecific docker image you'd like to use. In the form name:tag. If passed in, will override the docker image value passed in
-c, --configPath to JSON file (must end in '.json') or JSON string which will be passed as a launch config. Dictation how the launched run will
-q, --queueName of run queue to push to. If none, launches single run directly. If supplied without an argument (--queue), defaults to
--asyncFlag 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
--resource-argsPath 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
--cudaFlag to build an image with CUDA enabled. If reproducing a previous wandb run that ran on a CUDA-enabled image will be built by
-b, --buildFlag to build an associated job and push to queue as an image job.
-rg, --repositoryName of a remote repository. Will be used to push a built image to.
-pq, --project-queueName of the project containing the queue to push to. If none, defaults to entity level
--helpShow this message and exit.
Was this page helpful?๐Ÿ‘๐Ÿ‘Ž