LaunchAgent - Weights & Biases Documentation

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]
)

Arguments	Description
`api`	Api object to use for making requests to the backend.
`config`	Config dictionary for the agent.

Attributes	Description
`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
)

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
)

`finish_thread_id`

View source

finish_thread_id(
    thread_id, exception=None
)

Removes the job from our list for now.

`get_job_and_queue`

View source

get_job_and_queue()

`initialized`

View source

@classmethod
initialized() -> bool

Return whether the agent is initialized.

`loop`

View source

loop()

Loop infinitely to poll for jobs and run them.

Raises	Description
`KeyboardInterrupt`	if the agent is requested to stop.

`name`

View source

@classmethod
name() -> str

Return the name of the agent.

`pop_from_queue`

View source

pop_from_queue(
    queue
)

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

Arguments	Description
`queue`	Queue to pop from.

Returns	Description
Item popped off the queue.

Raises	Description
`Exception`	if there is an error popping from the queue.

`print_status`

View source

print_status() -> None

Prints the current status of the agent.

`run_job`

View source

run_job(
    job, queue, file_saver
)

Set up project and run the job.

Arguments	Description
`job`	Job to run.

`task_run_job`

View source

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

`update_status`

View source

update_status(
    status
)

Update the status of the agent.

Arguments	Description
`status`	Status to update the agent to.

launch_add

⌘I

View the source code

​Methods

​check_sweep_state

​fail_run_queue_item

​finish_thread_id

​get_job_and_queue

​initialized

​loop

​name

​pop_from_queue

​print_status

​run_job

​task_run_job

​update_status

Methods

`check_sweep_state`

`fail_run_queue_item`

`finish_thread_id`

`get_job_and_queue`

`initialized`

`loop`

`name`

`pop_from_queue`

`print_status`

`run_job`

`task_run_job`

`update_status`