File size: 36,518 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 |
"""Implementation of launch agent."""
import asyncio
import logging
import os
import pprint
import threading
import time
import traceback
from dataclasses import dataclass
from multiprocessing import Event
from typing import Any, Dict, List, Optional, Tuple, Union
import yaml
import wandb
from wandb.apis.internal import Api
from wandb.errors import CommError
from wandb.sdk.launch._launch_add import launch_add
from wandb.sdk.launch.runner.local_container import LocalSubmittedRun
from wandb.sdk.launch.runner.local_process import LocalProcessRunner
from wandb.sdk.launch.sweeps.scheduler import Scheduler
from wandb.sdk.launch.utils import LAUNCH_CONFIG_FILE, resolve_build_and_registry_config
from wandb.sdk.lib import runid
from .. import loader
from .._project_spec import LaunchProject
from ..errors import LaunchDockerError, LaunchError
from ..utils import (
LAUNCH_DEFAULT_PROJECT,
LOG_PREFIX,
PROJECT_SYNCHRONOUS,
event_loop_thread_exec,
)
from .job_status_tracker import JobAndRunStatusTracker
from .run_queue_item_file_saver import RunQueueItemFileSaver
AGENT_POLLING_INTERVAL = 10
RECEIVED_JOB_POLLING_INTERVAL = 0.0 # more frequent when we know we have jobs
AGENT_POLLING = "POLLING"
AGENT_RUNNING = "RUNNING"
AGENT_KILLED = "KILLED"
HIDDEN_AGENT_RUN_TYPE = "sweep-controller"
MAX_RESUME_COUNT = 5
RUN_INFO_GRACE_PERIOD = 60
DEFAULT_STOPPED_RUN_TIMEOUT = 60
DEFAULT_PRINT_INTERVAL = 5 * 60
VERBOSE_PRINT_INTERVAL = 20
_env_timeout = os.environ.get("WANDB_LAUNCH_START_TIMEOUT")
if _env_timeout:
try:
RUN_START_TIMEOUT = float(_env_timeout)
except ValueError:
raise LaunchError(
f"Invalid value for WANDB_LAUNCH_START_TIMEOUT: {_env_timeout}"
)
else:
RUN_START_TIMEOUT = 60 * 30 # default 30 minutes
_logger = logging.getLogger(__name__)
@dataclass
class JobSpecAndQueue:
job: Dict[str, Any]
queue: str
def _convert_access(access: str) -> str:
"""Convert access string to a value accepted by wandb."""
access = access.upper()
assert (
access == "PROJECT" or access == "USER"
), "Queue access must be either project or user"
return access
def _max_from_config(
config: Dict[str, Any], key: str, default: int = 1
) -> Union[int, float]:
"""Get an integer from the config, or float.inf if -1.
Utility for parsing integers from the agent config with a default, infinity
handling, and integer parsing. Raises more informative error if parse error.
"""
try:
val = config.get(key)
if val is None:
val = default
max_from_config = int(val)
except ValueError as e:
raise LaunchError(
f"Error when parsing LaunchAgent config key: ['{key}': "
f"{config.get(key)}]. Error: {str(e)}"
)
if max_from_config == -1:
return float("inf")
if max_from_config < 0:
raise LaunchError(
f"Error when parsing LaunchAgent config key: ['{key}': "
f"{config.get(key)}]. Error: negative value."
)
return max_from_config
class InternalAgentLogger:
def __init__(self, verbosity=0):
self._print_to_terminal = verbosity >= 2
def error(self, message: str):
if self._print_to_terminal:
wandb.termerror(f"{LOG_PREFIX}{message}")
_logger.error(f"{LOG_PREFIX}{message}")
def warn(self, message: str):
if self._print_to_terminal:
wandb.termwarn(f"{LOG_PREFIX}{message}")
_logger.warning(f"{LOG_PREFIX}{message}")
def info(self, message: str):
if self._print_to_terminal:
wandb.termlog(f"{LOG_PREFIX}{message}")
_logger.info(f"{LOG_PREFIX}{message}")
def debug(self, message: str):
if self._print_to_terminal:
wandb.termlog(f"{LOG_PREFIX}{message}")
_logger.debug(f"{LOG_PREFIX}{message}")
def construct_agent_configs(
launch_config: Optional[Dict] = None,
build_config: Optional[Dict] = None,
) -> Tuple[Optional[Dict[str, Any]], Dict[str, Any], Dict[str, Any]]:
registry_config = None
environment_config = None
if launch_config is not None:
build_config = launch_config.get("builder")
registry_config = launch_config.get("registry")
default_launch_config = None
if os.path.exists(os.path.expanduser(LAUNCH_CONFIG_FILE)):
with open(os.path.expanduser(LAUNCH_CONFIG_FILE)) as f:
default_launch_config = (
yaml.safe_load(f) or {}
) # In case the config is empty, we want it to be {} instead of None.
environment_config = default_launch_config.get("environment")
build_config, registry_config = resolve_build_and_registry_config(
default_launch_config, build_config, registry_config
)
return environment_config, build_config, registry_config
class LaunchAgent:
"""Launch agent class which polls run given run queues and launches runs for wandb launch."""
_instance = None
def __new__(cls, *args: Any, **kwargs: Any) -> "LaunchAgent":
"""Create a new instance of the LaunchAgent.
This method ensures that only one instance of the LaunchAgent is created.
This is done so that information about the agent can be accessed from
elsewhere in the library.
"""
if cls._instance is None:
cls._instance = super().__new__(cls)
return cls._instance
@classmethod
def name(cls) -> str:
"""Return the name of the agent."""
if cls._instance is None:
raise LaunchError("LaunchAgent has not been initialized")
name = cls._instance._name
if isinstance(name, str):
return name
raise LaunchError(f"Found invalid name for agent {name}")
@classmethod
def initialized(cls) -> bool:
"""Return whether the agent is initialized."""
return cls._instance is not None
def __init__(self, api: Api, config: Dict[str, Any]):
"""Initialize a launch agent.
Arguments:
api: Api object to use for making requests to the backend.
config: Config dictionary for the agent.
"""
self._entity = config["entity"]
self._project = LAUNCH_DEFAULT_PROJECT
self._api = api
self._base_url = self._api.settings().get("base_url")
self._ticks = 0
self._jobs: Dict[int, JobAndRunStatusTracker] = {}
self._jobs_lock = threading.Lock()
self._jobs_event = Event()
self._jobs_event.set()
self._cwd = os.getcwd()
self._namespace = runid.generate_id()
self._access = _convert_access("project")
self._max_jobs = _max_from_config(config, "max_jobs")
self._max_schedulers = _max_from_config(config, "max_schedulers")
self._secure_mode = config.get("secure_mode", False)
self._verbosity = config.get("verbosity", 0)
self._internal_logger = InternalAgentLogger(verbosity=self._verbosity)
self._last_status_print_time = 0.0
self.default_config: Dict[str, Any] = config
self._stopped_run_timeout = config.get(
"stopped_run_timeout", DEFAULT_STOPPED_RUN_TIMEOUT
)
self._known_warnings: List[str] = []
# Get agent version from env var if present, otherwise wandb version
self.version: str = "wandb@" + wandb.__version__
env_agent_version = os.environ.get("WANDB_AGENT_VERSION")
if env_agent_version and env_agent_version != "wandb-launch-agent":
self.version = env_agent_version
# serverside creation
self.gorilla_supports_agents = (
self._api.launch_agent_introspection() is not None
)
self._gorilla_supports_fail_run_queue_items = (
self._api.fail_run_queue_item_introspection()
)
self._queues: List[str] = config.get("queues", ["default"])
# remove project field from agent config before sending to back end
# because otherwise it shows up in the config in the UI and confuses users
sent_config = config.copy()
if "project" in sent_config:
del sent_config["project"]
create_response = self._api.create_launch_agent(
self._entity,
self._project,
self._queues,
sent_config,
self.version,
self.gorilla_supports_agents,
)
self._id = create_response["launchAgentId"]
if self._api.entity_is_team(self._entity):
wandb.termwarn(
f"{LOG_PREFIX}Agent is running on team entity ({self._entity}). Members of this team will be able to run code on this device."
)
agent_response = self._api.get_launch_agent(
self._id, self.gorilla_supports_agents
)
self._name = agent_response["name"]
self._init_agent_run()
def _is_scheduler_job(self, run_spec: Dict[str, Any]) -> bool:
"""Determine whether a job/runSpec is a sweep scheduler."""
if not run_spec:
self._internal_logger.debug(
"Received runSpec in _is_scheduler_job that was empty"
)
if run_spec.get("uri") != Scheduler.PLACEHOLDER_URI:
return False
if run_spec.get("resource") == "local-process":
# Any job pushed to a run queue that has a scheduler uri is
# allowed to use local-process
if run_spec.get("job"):
return True
# If a scheduler is local-process and run through CLI, also
# confirm command is in format: [wandb scheduler <sweep>]
cmd = run_spec.get("overrides", {}).get("entry_point", [])
if len(cmd) < 3:
return False
if cmd[:2] != ["wandb", "scheduler"]:
return False
return True
async def fail_run_queue_item(
self,
run_queue_item_id: str,
message: str,
phase: str,
files: Optional[List[str]] = None,
) -> None:
if self._gorilla_supports_fail_run_queue_items:
fail_rqi = event_loop_thread_exec(self._api.fail_run_queue_item)
await fail_rqi(run_queue_item_id, message, phase, files)
def _init_agent_run(self) -> None:
# TODO: has it been long enough that all backends support agents?
self._wandb_run = None
if self.gorilla_supports_agents:
settings = wandb.Settings(
silent=True, disable_git=True, disable_job_creation=True
)
self._wandb_run = wandb.init(
project=self._project,
entity=self._entity,
settings=settings,
id=self._name,
job_type=HIDDEN_AGENT_RUN_TYPE,
)
@property
def thread_ids(self) -> List[int]:
"""Returns a list of keys running thread ids for the agent."""
with self._jobs_lock:
return list(self._jobs.keys())
@property
def num_running_schedulers(self) -> int:
"""Return just the number of schedulers."""
with self._jobs_lock:
return len([x for x in self._jobs if self._jobs[x].is_scheduler])
@property
def num_running_jobs(self) -> int:
"""Return the number of jobs not including schedulers."""
with self._jobs_lock:
return len([x for x in self._jobs if not self._jobs[x].is_scheduler])
async def pop_from_queue(self, queue: str) -> Any:
"""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.
"""
try:
pop = event_loop_thread_exec(self._api.pop_from_run_queue)
ups = await pop(
queue,
entity=self._entity,
project=self._project,
agent_id=self._id,
)
return ups
except Exception as e:
print("Exception:", e)
return None
def print_status(self) -> None:
"""Prints the current status of the agent."""
self._last_status_print_time = time.time()
output_str = "agent "
if self._name:
output_str += f"{self._name} "
if self.num_running_jobs < self._max_jobs:
output_str += f"polling on queues {','.join(self._queues)}, "
output_str += (
f"running {self.num_running_jobs} out of a maximum of {self._max_jobs} jobs"
)
wandb.termlog(f"{LOG_PREFIX}{output_str}")
if self.num_running_jobs > 0:
output_str += f": {','.join(str(job_id) for job_id in self.thread_ids)}"
_logger.info(output_str)
async def update_status(self, status: str) -> None:
"""Update the status of the agent.
Arguments:
status: Status to update the agent to.
"""
_update_status = event_loop_thread_exec(self._api.update_launch_agent_status)
update_ret = await _update_status(
self._id, status, self.gorilla_supports_agents
)
if not update_ret["success"]:
wandb.termerror(f"{LOG_PREFIX}Failed to update agent status to {status}")
def _check_run_exists_and_inited(
self, entity: str, project: str, run_id: str, rqi_id: str
) -> bool:
"""Checks the stateof the run to ensure it has been inited. Note this will not behave well with resuming."""
# Checks the _wandb key in the run config for the run queue item id. If it exists, the
# submitted run definitely called init. Falls back to checking state of run.
# TODO: handle resuming runs
# Sweep runs exist but are in pending state, normal launch runs won't exist
# so will raise a CommError.
try:
run_state = self._api.get_run_state(entity, project, run_id)
if run_state.lower() != "pending":
return True
except CommError:
self._internal_logger.info(
f"Run {entity}/{project}/{run_id} with rqi id: {rqi_id} did not have associated run",
)
return False
async def finish_thread_id(
self,
thread_id: int,
exception: Optional[Union[Exception, LaunchDockerError]] = None,
) -> None:
"""Removes the job from our list for now."""
with self._jobs_lock:
job_and_run_status = self._jobs[thread_id]
if (
job_and_run_status.entity is not None
and job_and_run_status.entity != self._entity
):
self._internal_logger.info(
"Skipping check for completed run status because run is on a different entity than agent",
)
elif exception is not None:
tb_str = traceback.format_exception(
type(exception), value=exception, tb=exception.__traceback__
)
fnames = job_and_run_status.saver.save_contents(
"".join(tb_str), "error.log", "error"
)
await self.fail_run_queue_item(
job_and_run_status.run_queue_item_id,
str(exception),
job_and_run_status.err_stage,
fnames,
)
elif job_and_run_status.project is None or job_and_run_status.run_id is None:
self._internal_logger.info(
f"called finish_thread_id on thread whose tracker has no project or run id. RunQueueItemID: {job_and_run_status.run_queue_item_id}",
)
wandb.termerror(
"Missing project or run id on thread called finish thread id"
)
await self.fail_run_queue_item(
job_and_run_status.run_queue_item_id,
"submitted job was finished without assigned project or run id",
"agent",
)
elif job_and_run_status.run is not None:
called_init = False
# We do some weird stuff here getting run info to check for a
# created in run in W&B.
#
# We retry for 60 seconds with an exponential backoff in case
# upsert run is taking a while.
logs = None
interval = 1
while True:
called_init = self._check_run_exists_and_inited(
self._entity,
job_and_run_status.project,
job_and_run_status.run_id,
job_and_run_status.run_queue_item_id,
)
if called_init or interval > RUN_INFO_GRACE_PERIOD:
break
if not called_init:
# Fetch the logs now if we don't get run info on the
# first try, in case the logs are cleaned from the runner
# environment (e.g. k8s) during the run info grace period.
if interval == 1:
logs = await job_and_run_status.run.get_logs()
await asyncio.sleep(interval)
interval *= 2
if not called_init:
fnames = None
if job_and_run_status.completed_status == "finished":
_msg = "The submitted job exited successfully but failed to call wandb.init"
else:
_msg = "The submitted run was not successfully started"
if logs:
fnames = job_and_run_status.saver.save_contents(
logs, "error.log", "error"
)
await self.fail_run_queue_item(
job_and_run_status.run_queue_item_id, _msg, "run", fnames
)
else:
self._internal_logger.info(
f"Finish thread id {thread_id} had no exception and no run"
)
wandb._sentry.exception(
"launch agent called finish thread id on thread without run or exception"
)
# TODO: keep logs or something for the finished jobs
with self._jobs_lock:
del self._jobs[thread_id]
# update status back to polling if no jobs are running
if len(self.thread_ids) == 0:
await self.update_status(AGENT_POLLING)
async def run_job(
self, job: Dict[str, Any], queue: str, file_saver: RunQueueItemFileSaver
) -> None:
"""Set up project and run the job.
Arguments:
job: Job to run.
"""
_msg = f"{LOG_PREFIX}Launch agent received job:\n{pprint.pformat(job)}\n"
wandb.termlog(_msg)
_logger.info(_msg)
# update agent status
await self.update_status(AGENT_RUNNING)
# parse job
self._internal_logger.info("Parsing launch spec")
launch_spec = job["runSpec"]
# Abort if this job attempts to override secure mode
self._assert_secure(launch_spec)
job_tracker = JobAndRunStatusTracker(job["runQueueItemId"], queue, file_saver)
asyncio.create_task(
self.task_run_job(
launch_spec,
job,
self.default_config,
self._api,
job_tracker,
)
)
def _assert_secure(self, launch_spec: Dict[str, Any]) -> None:
"""If secure mode is set, make sure no vulnerable keys are overridden."""
if not self._secure_mode:
return
k8s_config = launch_spec.get("resource_args", {}).get("kubernetes", {})
pod_secure_keys = ["hostPID", "hostIPC", "hostNetwork", "initContainers"]
pod_spec = k8s_config.get("spec", {}).get("template", {}).get("spec", {})
for key in pod_secure_keys:
if key in pod_spec:
raise ValueError(
f'This agent is configured to lock "{key}" in pod spec '
"but the job specification attempts to override it."
)
container_specs = pod_spec.get("containers", [])
for container_spec in container_specs:
if "command" in container_spec:
raise ValueError(
'This agent is configured to lock "command" in container spec '
"but the job specification attempts to override it."
)
if launch_spec.get("overrides", {}).get("entry_point"):
raise ValueError(
'This agent is configured to lock the "entrypoint" override '
"but the job specification attempts to override it."
)
async def loop(self) -> None:
"""Loop infinitely to poll for jobs and run them.
Raises:
KeyboardInterrupt: if the agent is requested to stop.
"""
self.print_status()
if self._verbosity == 0:
print_interval = DEFAULT_PRINT_INTERVAL
else:
print_interval = VERBOSE_PRINT_INTERVAL
try:
while True:
job = None
self._ticks += 1
agent_response = self._api.get_launch_agent(
self._id, self.gorilla_supports_agents
)
if agent_response["stopPolling"]:
# shutdown process and all jobs if requested from ui
raise KeyboardInterrupt # noqa: TRY301
if self.num_running_jobs < self._max_jobs:
# only check for new jobs if we're not at max
job_and_queue = await self.get_job_and_queue()
# these will either both be None, or neither will be None
if job_and_queue is not None:
job = job_and_queue.job
queue = job_and_queue.queue
try:
file_saver = RunQueueItemFileSaver(
self._wandb_run, job["runQueueItemId"]
)
if self._is_scheduler_job(job.get("runSpec", {})):
# If job is a scheduler, and we are already at the cap, ignore,
# don't ack, and it will be pushed back onto the queue in 1 min
if self.num_running_schedulers >= self._max_schedulers:
wandb.termwarn(
f"{LOG_PREFIX}Agent already running the maximum number "
f"of sweep schedulers: {self._max_schedulers}. To set "
"this value use `max_schedulers` key in the agent config"
)
continue
await self.run_job(job, queue, file_saver)
except Exception as e:
wandb.termerror(
f"{LOG_PREFIX}Error running job: {traceback.format_exc()}"
)
wandb._sentry.exception(e)
# always the first phase, because we only enter phase 2 within the thread
files = file_saver.save_contents(
contents=traceback.format_exc(),
fname="error.log",
file_sub_type="error",
)
await self.fail_run_queue_item(
run_queue_item_id=job["runQueueItemId"],
message=str(e),
phase="agent",
files=files,
)
if self._ticks % 2 == 0:
if len(self.thread_ids) == 0:
await self.update_status(AGENT_POLLING)
else:
await self.update_status(AGENT_RUNNING)
if time.time() - self._last_status_print_time > print_interval:
self.print_status()
if self.num_running_jobs == self._max_jobs or job is None:
# all threads busy or did not receive job
await asyncio.sleep(AGENT_POLLING_INTERVAL)
else:
await asyncio.sleep(RECEIVED_JOB_POLLING_INTERVAL)
except KeyboardInterrupt:
await self.update_status(AGENT_KILLED)
wandb.termlog(f"{LOG_PREFIX}Shutting down, active jobs:")
self.print_status()
finally:
self._jobs_event.clear()
# Threaded functions
async def task_run_job(
self,
launch_spec: Dict[str, Any],
job: Dict[str, Any],
default_config: Dict[str, Any],
api: Api,
job_tracker: JobAndRunStatusTracker,
) -> None:
rqi_id = job["runQueueItemId"]
assert rqi_id
exception: Optional[Union[LaunchDockerError, Exception]] = None
try:
with self._jobs_lock:
self._jobs[rqi_id] = job_tracker
await self._task_run_job(
launch_spec, job, default_config, api, rqi_id, job_tracker
)
except LaunchDockerError as e:
wandb.termerror(
f"{LOG_PREFIX}agent {self._name} encountered an issue while starting Docker, see above output for details."
)
exception = e
wandb._sentry.exception(e)
except LaunchError as e:
wandb.termerror(f"{LOG_PREFIX}Error running job: {e}")
exception = e
wandb._sentry.exception(e)
except Exception as e:
wandb.termerror(f"{LOG_PREFIX}Error running job: {traceback.format_exc()}")
exception = e
wandb._sentry.exception(e)
finally:
await self.finish_thread_id(rqi_id, exception)
async def _task_run_job(
self,
launch_spec: Dict[str, Any],
job: Dict[str, Any],
default_config: Dict[str, Any],
api: Api,
thread_id: int,
job_tracker: JobAndRunStatusTracker,
) -> None:
project = LaunchProject.from_spec(launch_spec, api)
self._set_queue_and_rqi_in_project(project, job, job_tracker.queue)
ack = event_loop_thread_exec(api.ack_run_queue_item)
await ack(job["runQueueItemId"], project.run_id)
# don't launch sweep runs if the sweep isn't healthy
await self.check_sweep_state(launch_spec, api)
job_tracker.update_run_info(project)
self._internal_logger.info("Fetching and validating project...")
project.fetch_and_validate_project()
self._internal_logger.info("Fetching resource...")
resource = launch_spec.get("resource") or "local-container"
backend_config: Dict[str, Any] = {
PROJECT_SYNCHRONOUS: False, # agent always runs async
}
self._internal_logger.info("Loading backend")
override_build_config = launch_spec.get("builder")
_, build_config, registry_config = construct_agent_configs(
default_config, override_build_config
)
image_uri = project.docker_image or project.job_base_image
entrypoint = project.get_job_entry_point()
environment = loader.environment_from_config(
default_config.get("environment", {})
)
registry = loader.registry_from_config(registry_config, environment)
builder = loader.builder_from_config(build_config, environment, registry)
backend = loader.runner_from_config(
resource, api, backend_config, environment, registry
)
if not (
project.docker_image
or project.job_base_image
or isinstance(backend, LocalProcessRunner)
):
assert entrypoint is not None
image_uri = await builder.build_image(project, entrypoint, job_tracker)
self._internal_logger.info("Backend loaded...")
if isinstance(backend, LocalProcessRunner):
run = await backend.run(project, image_uri)
else:
assert image_uri
run = await backend.run(project, image_uri)
if self._is_scheduler_job(launch_spec):
with self._jobs_lock:
self._jobs[thread_id].is_scheduler = True
wandb.termlog(
f"{LOG_PREFIX}Preparing to run sweep scheduler "
f"({self.num_running_schedulers}/{self._max_schedulers})"
)
if not run:
with self._jobs_lock:
job_tracker.failed_to_start = True
return
with self._jobs_lock:
job_tracker.run = run
start_time = time.time()
stopped_time: Optional[float] = None
while self._jobs_event.is_set():
# If run has failed to start before timeout, kill it
state = (await run.get_status()).state
if state == "starting" and RUN_START_TIMEOUT > 0:
if time.time() - start_time > RUN_START_TIMEOUT:
await run.cancel()
raise LaunchError(
f"Run failed to start within {RUN_START_TIMEOUT} seconds. "
"If you want to increase this timeout, set WANDB_LAUNCH_START_TIMEOUT "
"to a larger value."
)
if await self._check_run_finished(job_tracker, launch_spec):
return
if await job_tracker.check_wandb_run_stopped(self._api):
if stopped_time is None:
stopped_time = time.time()
else:
if time.time() - stopped_time > self._stopped_run_timeout:
await run.cancel()
await asyncio.sleep(AGENT_POLLING_INTERVAL)
# temp: for local, kill all jobs. we don't yet have good handling for different
# types of runners in general
if isinstance(run, LocalSubmittedRun) and run._command_proc is not None:
run._command_proc.kill()
async def check_sweep_state(self, launch_spec: Dict[str, Any], api: Api) -> None:
"""Check the state of a sweep before launching a run for the sweep."""
if launch_spec.get("sweep_id"):
try:
get_sweep_state = event_loop_thread_exec(api.get_sweep_state)
state = await get_sweep_state(
sweep=launch_spec["sweep_id"],
entity=launch_spec["entity"],
project=launch_spec["project"],
)
except Exception as e:
self._internal_logger.debug(f"Fetch sweep state error: {e}")
state = None
if state != "RUNNING" and state != "PAUSED":
raise LaunchError(
f"Launch agent picked up sweep job, but sweep ({launch_spec['sweep_id']}) was in a terminal state ({state})"
)
async def _check_run_finished(
self, job_tracker: JobAndRunStatusTracker, launch_spec: Dict[str, Any]
) -> bool:
if job_tracker.completed_status:
return True
# the run can be done before the run has started
# but can also be none if the run failed to start
# so if there is no run, either the run hasn't started yet
# or it has failed
if job_tracker.run is None:
if job_tracker.failed_to_start:
return True
return False
known_error = False
try:
run = job_tracker.run
status = await run.get_status()
state = status.state
for warning in status.messages:
if warning not in self._known_warnings:
self._known_warnings.append(warning)
success = self._api.update_run_queue_item_warning(
job_tracker.run_queue_item_id,
warning,
"Kubernetes",
[],
)
if not success:
_logger.warning(
f"Error adding warning {warning} to run queue item {job_tracker.run_queue_item_id}"
)
self._known_warnings.remove(warning)
if state == "preempted" and job_tracker.entity == self._entity:
config = launch_spec.copy()
config["run_id"] = job_tracker.run_id
config["_resume_count"] = config.get("_resume_count", 0) + 1
with self._jobs_lock:
job_tracker.completed_status = state
if config["_resume_count"] > MAX_RESUME_COUNT:
wandb.termlog(
f"{LOG_PREFIX}Run {job_tracker.run_id} has already resumed {MAX_RESUME_COUNT} times."
)
return True
wandb.termlog(
f"{LOG_PREFIX}Run {job_tracker.run_id} was preempted, requeuing..."
)
if "sweep_id" in config:
# allow resumed runs from sweeps that have already completed by removing
# the sweep id before pushing to queue
del config["sweep_id"]
launch_add(
config=config,
project_queue=self._project,
queue_name=job_tracker.queue,
)
return True
# TODO change these statuses to an enum
if state in ["stopped", "failed", "finished", "preempted"]:
if job_tracker.is_scheduler:
wandb.termlog(f"{LOG_PREFIX}Scheduler finished with ID: {run.id}")
if state == "failed":
# on fail, update sweep state. scheduler run_id should == sweep_id
try:
self._api.set_sweep_state(
sweep=job_tracker.run_id,
entity=job_tracker.entity,
project=job_tracker.project,
state="CANCELED",
)
except Exception as e:
raise LaunchError(f"Failed to update sweep state: {e}")
else:
wandb.termlog(f"{LOG_PREFIX}Job finished with ID: {run.id}")
with self._jobs_lock:
job_tracker.completed_status = state
return True
return False
except LaunchError as e:
wandb.termerror(
f"{LOG_PREFIX}Terminating job {run.id} because it failed to start: {str(e)}"
)
known_error = True
with self._jobs_lock:
job_tracker.failed_to_start = True
# TODO: make get_status robust to errors for each runner, and handle them
except Exception as e:
wandb.termerror(f"{LOG_PREFIX}Error getting status for job {run.id}")
wandb.termerror(traceback.format_exc())
_logger.info("---")
_logger.info("Caught exception while getting status.")
_logger.info(f"Job ID: {run.id}")
_logger.info(traceback.format_exc())
_logger.info("---")
wandb._sentry.exception(e)
return known_error
async def get_job_and_queue(self) -> Optional[JobSpecAndQueue]:
for queue in self._queues:
job = await self.pop_from_queue(queue)
if job is not None:
self._queues.remove(queue)
self._queues.append(queue)
return JobSpecAndQueue(job, queue)
return None
def _set_queue_and_rqi_in_project(
self, project: LaunchProject, job: Dict[str, Any], queue: str
) -> None:
project.queue_name = queue
# queue entity currently always matches the agent
project.queue_entity = self._entity
project.run_queue_item_id = job["runQueueItemId"]
|