LaunchAgent

  2 minute read  

View the source code

Launch agent class which polls run given run queues and launches runs for wandb launch.

LaunchAgent(
    api: Api,
    config: Dict[str, Any]
)
Python
Arguments
api Api object to use for making requests to the backend.
config Config dictionary for the agent.
Attributes
num_running_jobs Return the number of jobs not including schedulers.
num_running_schedulers Return just the number of schedulers.
thread_ids Returns a list of keys running thread ids for the agent.

Methods

check_sweep_state

View source

check_sweep_state(
    launch_spec, api
)
Python

Check the state of a sweep before launching a run for the sweep.

fail_run_queue_item

View source

fail_run_queue_item(
    run_queue_item_id, message, phase, files=None
)
Python

finish_thread_id

View source

finish_thread_id(
    thread_id, exception=None
)
Python

Removes the job from our list for now.

get_job_and_queue

View source

get_job_and_queue()
Python

initialized

View source

@classmethod
initialized() -> bool
Python

Return whether the agent is initialized.

loop

View source

loop()
Python

Loop infinitely to poll for jobs and run them.

Raises
KeyboardInterrupt if the agent is requested to stop.

name

View source

@classmethod
name() -> str
Python

Return the name of the agent.

pop_from_queue

View source

pop_from_queue(
    queue
)
Python

Pops an item off the runqueue to run as a job.

Arguments
queue Queue to pop from.
Returns
Item popped off the queue.
Raises
Exception if there is an error popping from the queue.

View source

print_status() -> None
Python

Prints the current status of the agent.

run_job

View source

run_job(
    job, queue, file_saver
)
Python

Set up project and run the job.

Arguments
job Job to run.

task_run_job

View source

task_run_job(
    launch_spec, job, default_config, api, job_tracker
)
Python

update_status

View source

update_status(
    status
)
Python

Update the status of the agent.

Arguments
status Status to update the agent to.

Last modified April 21, 2025