Add jobs to your queue

Add W&B Jobs to your Launch Queue. Launch queues possess one or more W&B Jobs that are executed when you start a W&B Launch agent. A launch queue has a compute resource associated to that queue. Launch queues are entity-scoped. This means that anyone who has access to the entity can use the queue to launch jobs.

For example, suppose a team has a queue configured to a Kubernetes cluster. Anyone on that team, or who has access to that entity, can send jobs to that cluster with the W&B App or W&B CLI.

Add jobs to your queue

Add jobs to your queue interactively with the W&B App or programmatically with the CLI.

W&B App

Add a job to your queue with the W&B App.

info

In this example we demonstrate how to create a “Starter queue”. This starter queue is designed for local testing and demonstrative purposes only.

1. Navigate to your W&B Project Page.
2. Select the Jobs icon on the left panel:

3. The Jobs page displays a list of W&B Jobs that were created from previously executed W&B Runs.

4. Select the Launch button next to the name of the Job name. A modal will appear on the right side of the page.
5. Within the modal select the:
   • Job version you want to add to your queue from the Job version dropdown. In this example we only have one version, so we select v0.
   • Select the Paste from… button to automatically propagate hyperparameters used from a specific W&B Run. In the following image, we have two runs to choose from.

6. Next, select Starter queue from the Queue dropdown to create a queue.
7. Select the Launch now button.

CLI

Use the wandb launch command to add jobs to a queue. Create a JSON configuration with hyperparameter overrides. For example, using the script from the Getting Started guide, we create a JSON file with the following overrides:

// config.json
{
    "args": [],
    "run_config": {
        "learning_rate": 0,
        "epochs": 0
    },
    "entry_point": []
}

W&B Launch will use the default parameters if you do not provide a JSON configuration file.

Provide the name of the queue for the queue(-q) flag, the name of the job for the job(-j) flag, and the path to the configuration file for the config(-c) flag.

wandb launch -j <job> -q <queue-name> -e <entity-name> -c path/to/config.json

If you work within a W&B Team, we suggest you specify the entity flag (-e) to indicate which entity the queue will use.

View queues

View queues associated with a W&B entity with the W&B App.

1. Navigate to the W&B App at https://wandb.ai/home.
2. Select Launch within the Applications section of the left sidebar.
3. Select the All entities dropdown and select the entity to filter with.

A list of queues will appear in the Launch workspace. From left to right, each queue listed shows the name of the queue, the entity the queue belongs to, the compute resource configured for that queue and the state of the queue.

For example, in the following image, we have a queue called Starter queue. It belongs the the wandb entity. The queue is configured to use Docker. And the queue is in an inactive (Not running) state.

A queue is either Active or Not running (inactive).

• Active: A queue is active if at least one agent is either polling or executing jobs for that queue.
• Not running: A queue is not running if there is no agent polling or executing jobs for that queue.

View queued jobs

View jobs added to a queue with the W&B App.

1. Navigate to the W&B App at https://wandb.ai/home.
2. Select Launch within the Applications section of the left sidebar.
3. Select the All entities dropdown and select the entity to filter with.
4. Expand the collapsible queue UI from the Launch Application page to view jobs added to a specific queue.

Each run listed corresponds to a job that was was added to that queue. For example, the following image shows there are two jobs listed in a queue called Starter queue. One is called resilient-snowball and the other is called earthy-energy-165:

Find additional information about the jobs such as the:

• Run: The name of the W&B Run assigned to that job.
• Job ID: The name of the job. See Job naming conventions page for information on the default naming assigned to a job.
• Project: The name of the project the run belongs to.
• Status: The status of the queued run.
• Author: The W&B entity that created the run.
• Creation date: The time stamp when the queue was created.
• Start time: The timestamp when the job started.
• Duration: Time, in seconds, it took to complete the job’s run.

View agents

Select the Agents tab to view active and inactive agents assigned to the queue. Within this tab you can view the:

• Agent ID: Unique agent identification
• Status: The statue of the agent. An agent can have a Killed or Polling status.
• Start date: The date the agent was activated.
• Host: The machine the agent is polling on.