Skip to main content
Create a job from a source, without a wandb run. Jobs can be of three types, git, code, or image. git: A git source, with an entrypoint either in the path or provided explicitly pointing to the main python executable. code: A code path, containing a requirements.txt file. image: A docker image.

Usage

wandb job create [OPTIONS] {git|code|image} PATH

Options

project

The project you want to list jobs from.
FlagDefaultType
-p, --projectNoneSTRING

entity

The entity the jobs belong to
FlagDefaultType
-e, --entityNoneSTRING

name

Name for the job
FlagDefaultType
-n, --nameNoneSTRING

description

Description for the job
FlagDefaultType
-d, --descriptionNoneSTRING

aliases

Alias for the job
FlagDefaultType
-a, --alias()STRING

entrypoint

Entrypoint to the script, including an executable and an entrypoint file. Required for code or repo jobs. If —build-context is provided, paths in the entrypoint command will be relative to the build context.
FlagDefaultType
-E, --entry-pointNoneSTRING

git_hash

Commit reference to use as the source for git jobs
FlagDefaultType
-g, --git-hashNoneSTRING

runtime

Python runtime to execute the job
FlagDefaultType
-r, --runtimeNoneSTRING

build_context

Path to the build context from the root of the job source code. If provided, this is used as the base path for the Dockerfile and entrypoint.
FlagDefaultType
-b, --build-contextNoneSTRING

base_image

Base image to use for the job. Incompatible with image jobs.
FlagDefaultType
-B, --base-imageNoneSTRING

dockerfile

Path to the Dockerfile for the job. If —build-context is provided, the Dockerfile path will be relative to the build context.
FlagDefaultType
-D, --dockerfileNoneSTRING

services

Service configurations in format serviceName=policy. Valid policies: always, never
FlagDefaultType
-s, --serviceNoneSTRING

schema

Path to the schema file for the job.
FlagDefaultType
--schemaNoneSTRING

help

Show this message and exit.
FlagDefaultType
--helpFalseBOOL

CLI Help

Usage: job create [OPTIONS] {git|code|image} PATH

  Create a job from a source, without a wandb run.

  Jobs can be of three types, git, code, or image.

  git: A git source, with an entrypoint either in the path or provided
  explicitly pointing to the main python executable. code: A code path,
  containing a requirements.txt file. image: A docker image.

Options:
  -p, --project TEXT        The project you want to list jobs from.
  -e, --entity TEXT         The entity the jobs belong to
  -n, --name TEXT           Name for the job
  -d, --description TEXT    Description for the job
  -a, --alias TEXT          Alias for the job
  -E, --entry-point TEXT    Entrypoint to the script, including an executable
                            and an entrypoint file. Required for code or repo
                            jobs. If --build-context is provided, paths in the
                            entrypoint command will be relative to the build
                            context.
  -g, --git-hash TEXT       Commit reference to use as the source for git jobs
  -r, --runtime TEXT        Python runtime to execute the job
  -b, --build-context TEXT  Path to the build context from the root of the job
                            source code. If provided, this is used as the base
                            path for the Dockerfile and entrypoint.
  -B, --base-image TEXT     Base image to use for the job. Incompatible with
                            image jobs.
  -D, --dockerfile TEXT     Path to the Dockerfile for the job. If --build-
                            context is provided, the Dockerfile path will be
                            relative to the build context.
  --help                    Show this message and exit.