"""Global W&B library state. This module manages global state, which for wandb includes: - Settings configured through `wandb.setup()` - The list of active runs - A subprocess ("the internal service") that asynchronously uploads metrics This module is fork-aware: in a forked process such as that spawned by the `multiprocessing` module, `wandb.singleton()` returns a new object, not the one inherited from the parent process. This requirement comes from backward compatibility with old design choices: the hardest one to fix is that wandb was originally designed to have a single run for the entire process that `wandb.init()` was meant to return. Back then, the only way to create multiple simultaneous runs in a single script was to run subprocesses, and since the built-in `multiprocessing` module forks by default, this required a PID check to make `wandb.init()` ignore the inherited global run. Another reason for fork-awareness is that the process that starts up the internal service owns it and is responsible for shutting it down, and child processes shouldn't also try to do that. This is easier to redesign. """ from __future__ import annotations import logging import os import pathlib import sys import threading from typing import TYPE_CHECKING, Any, Union import wandb import wandb.integration.sagemaker as sagemaker from wandb.env import CONFIG_DIR from wandb.errors import UsageError from wandb.sdk.lib import asyncio_manager, import_hooks, wb_logging from .lib import config_util, server if TYPE_CHECKING: from wandb.sdk import wandb_run from wandb.sdk.lib.service.service_connection import ServiceConnection from wandb.sdk.wandb_settings import Settings class _EarlyLogger: """Early logger which captures logs in memory until logging can be configured.""" def __init__(self) -> None: self._log: list[tuple] = [] self._exception: list[tuple] = [] # support old warn() as alias of warning() self.warn = self.warning def debug(self, msg: str, *args: Any, **kwargs: Any) -> None: self._log.append((logging.DEBUG, msg, args, kwargs)) def info(self, msg: str, *args: Any, **kwargs: Any) -> None: self._log.append((logging.INFO, msg, args, kwargs)) def warning(self, msg: str, *args: Any, **kwargs: Any) -> None: self._log.append((logging.WARNING, msg, args, kwargs)) def error(self, msg: str, *args: Any, **kwargs: Any) -> None: self._log.append((logging.ERROR, msg, args, kwargs)) def critical(self, msg: str, *args: Any, **kwargs: Any) -> None: self._log.append((logging.CRITICAL, msg, args, kwargs)) def exception(self, msg: str, *args: Any, **kwargs: Any) -> None: self._exception.append((msg, args, kwargs)) def log(self, level: str, msg: str, *args: Any, **kwargs: Any) -> None: self._log.append((level, msg, args, kwargs)) def _flush(self, new_logger: Logger) -> None: assert self is not new_logger for level, msg, args, kwargs in self._log: new_logger.log(level, msg, *args, **kwargs) for msg, args, kwargs in self._exception: new_logger.exception(msg, *args, **kwargs) Logger = Union[logging.Logger, _EarlyLogger] class _WandbSetup: """W&B library singleton.""" def __init__(self, pid: int) -> None: self._asyncer = asyncio_manager.AsyncioManager() self._asyncer.start() self._connection: ServiceConnection | None = None self._active_runs: list[wandb_run.Run] = [] self._active_runs_lock = threading.Lock() self._sweep_config: dict | None = None self._server: server.Server | None = None self._pid = pid # TODO(jhr): defer strict checks until settings are fully initialized # and logging is ready self._logger: Logger = _EarlyLogger() self._settings: Settings | None = None self._settings_environ: dict[str, str] | None = None @property def asyncer(self) -> asyncio_manager.AsyncioManager: """The internal asyncio thread used by wandb.""" return self._asyncer def add_active_run(self, run: wandb_run.Run) -> None: """Append a run to the active runs list. This must be called when a run is initialized. Args: run: A newly initialized run. """ with self._active_runs_lock: if run not in self._active_runs: self._active_runs.append(run) def remove_active_run(self, run: wandb_run.Run) -> None: """Remove the run from the active runs list. This must be called when a run is finished. Args: run: A run that is finished or crashed. """ try: with self._active_runs_lock: self._active_runs.remove(run) except ValueError: pass # Removing a run multiple times is not an error. @property def most_recent_active_run(self) -> wandb_run.Run | None: """The most recently initialized run that is not yet finished.""" with self._active_runs_lock: if not self._active_runs: return None return self._active_runs[-1] def finish_all_active_runs(self) -> None: """Finish all unfinished runs. NOTE: This is slightly inefficient as it finishes runs one at a time. This only exists to support using the `reinit="finish_previous"` setting together with `reinit="create_new"` which does not seem to be a useful pattern. Since `"create_new"` should eventually become the default and only behavior, it does not seem worth optimizing. """ # Take a snapshot as each call to `finish()` modifies `_active_runs`. with self._active_runs_lock: runs_copy = list(self._active_runs) for run in runs_copy: run.finish() def did_environment_change(self) -> bool: """Check if os.environ has changed since settings were initialized.""" if not self._settings_environ: return False exclude_env_vars = {"WANDB_SERVICE", "WANDB_KUBEFLOW_URL"} singleton_env = { k: v for k, v in self._settings_environ.items() if k.startswith("WANDB_") and k not in exclude_env_vars } os_env = { k: v for k, v in os.environ.items() if k.startswith("WANDB_") and k not in exclude_env_vars } return ( set(singleton_env.keys()) != set(os_env.keys()) # or set(singleton_env.values()) != set(os_env.values()) ) def _load_settings( self, *, system_settings_path: str | None, disable_sagemaker: bool, overrides: Settings | None = None, ) -> None: """Load settings from environment variables, config files, etc. Args: system_settings_path: Location of system settings file to use. If not provided, reads the WANDB_CONFIG_DIR environment variable or uses the default location. disable_sagemaker: If true, skips modifying settings based on SageMaker. overrides: Additional settings to apply to the global settings. """ from wandb.sdk.wandb_settings import Settings self._settings = Settings() # the pid of the process to monitor for system stats pid = os.getpid() self._logger.info(f"Current SDK version is {wandb.__version__}") self._logger.info(f"Configure stats pid to {pid}") self._settings.x_stats_pid = pid if system_settings_path: self._settings.settings_system = system_settings_path elif config_dir_str := os.getenv(CONFIG_DIR, None): config_dir = pathlib.Path(config_dir_str).expanduser() self._settings.settings_system = str(config_dir / "settings") else: self._settings.settings_system = str( pathlib.Path("~", ".config", "wandb", "settings").expanduser() ) self._settings.update_from_system_settings() # load settings from the environment variables self._logger.info("Loading settings from environment variables") self._settings_environ = os.environ.copy() self._settings.update_from_env_vars(self._settings_environ) # infer settings from the system environment self._settings.update_from_system_environment() # load SageMaker settings if ( not self._settings.sagemaker_disable and not disable_sagemaker and sagemaker.is_using_sagemaker() ): self._logger.info("Loading SageMaker settings") sagemaker.set_global_settings(self._settings) # load settings from the passed init/setup settings if overrides: self._settings.update_from_settings(overrides) wandb.termsetup(self._settings, None) def _update(self, settings: Settings | None) -> None: """Update settings, initializing them if necessary. Args: settings: Overrides to apply, if any. """ if not self._settings: system_settings_path = settings.settings_system if settings else None disable_sagemaker = settings.sagemaker_disable if settings else False self._load_settings( system_settings_path=system_settings_path, disable_sagemaker=disable_sagemaker, overrides=settings, ) # This is 'elif' because load_settings already applies overrides. elif settings: self._settings.update_from_settings(settings) def update_user_settings(self) -> None: # Get rid of cached results to force a refresh. self._server = None def _early_logger_flush(self, new_logger: Logger) -> None: if self._logger is new_logger: return if isinstance(self._logger, _EarlyLogger): self._logger._flush(new_logger) self._logger = new_logger def _get_logger(self) -> Logger: return self._logger @property def settings(self) -> Settings: """The global wandb settings. Initializes settings if they have not yet been loaded. """ if not self._settings: self._load_settings( system_settings_path=None, disable_sagemaker=False, ) assert self._settings return self._settings @property def settings_if_loaded(self) -> Settings | None: """The global wandb settings, or None if not yet loaded.""" return self._settings def _get_entity(self) -> str | None: if self._settings and self._settings._offline: return None entity = self.viewer.get("entity") return entity def _get_username(self) -> str | None: if self._settings and self._settings._offline: return None return self.viewer.get("username") def _get_teams(self) -> list[str]: if self._settings and self._settings._offline: return [] teams = self.viewer.get("teams") if teams: teams = [team["node"]["name"] for team in teams["edges"]] return teams or [] @property def viewer(self) -> dict[str, Any]: if self._server is None: self._server = server.Server(settings=self.settings) return self._server.viewer def _load_user_settings(self) -> dict[str, Any] | None: # offline? if self._server is None: return None flags = self._server._flags user_settings = dict() if "code_saving_enabled" in flags: user_settings["save_code"] = flags["code_saving_enabled"] email = self.viewer.get("email", None) if email: user_settings["email"] = email return user_settings @property def config(self) -> dict: sweep_path = self.settings.sweep_param_path if sweep_path: self._sweep_config = config_util.dict_from_config_file( sweep_path, must_exist=True ) config = {} # if config_paths was set, read in config dict if self.settings.config_paths: # TODO(jhr): handle load errors, handle list of files for config_path in self.settings.config_paths: config_dict = config_util.dict_from_config_file(config_path) if config_dict: config.update(config_dict) return config def _teardown(self, exit_code: int | None = None) -> None: import_hooks.unregister_all_post_import_hooks() if self._connection: internal_exit_code = self._connection.teardown(exit_code or 0) else: internal_exit_code = None self._asyncer.join() if internal_exit_code not in (None, 0): sys.exit(internal_exit_code) def ensure_service(self) -> ServiceConnection: """Returns a connection to the service process creating it if needed.""" if self._connection: return self._connection from wandb.sdk.lib.service import service_connection self._connection = service_connection.connect_to_service( self._asyncer, self.settings, ) return self._connection def assert_service(self) -> ServiceConnection: """Returns a connection to the service process, asserting it exists. Unlike ensure_service(), this will not start up a service process if it didn't already exist. """ if not self._connection: raise AssertionError("Expected service process to exist.") return self._connection _singleton: _WandbSetup | None = None """The W&B library singleton, or None if not yet set up. The value is invalid and must not be used if `os.getpid() != _singleton._pid`. """ _singleton_lock = threading.Lock() def singleton() -> _WandbSetup: """The W&B singleton for the current process. The first call to this in this process (which may be a fork of another process) creates the singleton, and all subsequent calls return it until teardown(). This does not start the service process. """ return _setup(start_service=False, load_settings=False) @wb_logging.log_to_all_runs() def _setup( settings: Settings | None = None, start_service: bool = True, load_settings: bool = True, ) -> _WandbSetup: """Set up library context. Args: settings: Global settings to set, or updates to the global settings if the singleton has already been initialized. start_service: Whether to start up the service process. NOTE: A service process will only be started if allowed by the global settings (after the given updates). The service will not start up if the mode resolves to "disabled". load_settings: Whether to load settings from the environment if creating a new singleton. If False, then settings and start_service must be None. """ global _singleton if not load_settings and settings: raise ValueError("Cannot pass settings if load_settings is False.") if not load_settings and start_service: raise ValueError("Cannot use start_service if load_settings is False.") pid = os.getpid() with _singleton_lock: if _singleton and _singleton._pid == pid: current_singleton = _singleton else: current_singleton = _WandbSetup(pid=pid) if load_settings: current_singleton._update(settings) if start_service and not current_singleton.settings._noop: current_singleton.ensure_service() _singleton = current_singleton # Update after configuring the _singleton. # # Do not hold the lock while updating credentials, as it writes back # to settings. if settings: _maybe_update_credentials(settings) return current_singleton def _maybe_update_credentials(settings: Settings) -> None: """Update session credentials if they're set on settings. This is a refactoring step for moving credentials into a separate module and out of settings. If a user calls `wandb.setup()` explicitly with an api_key or other credential, this overwrites credentials that might have been set by a call to `wandb.login()`. """ if settings.api_key and settings.identity_token_file: raise UsageError( "The api_key and identity_token_file settings cannot be used together." ) from wandb.sdk.lib import wbauth if settings.api_key: wbauth.use_explicit_auth( wbauth.AuthApiKey( host=wbauth.HostUrl(settings.base_url, app_url=settings.app_url), api_key=settings.api_key, ), source="wandb.setup()", ) elif settings.identity_token_file: wbauth.use_explicit_auth( wbauth.AuthIdentityTokenFile( host=wbauth.HostUrl(settings.base_url, app_url=settings.app_url), path=settings.identity_token_file, ), source="wandb.setup()", ) def setup(settings: Settings | None = None) -> _WandbSetup: """Prepares W&B for use in the current process and its children. You can usually ignore this as it is implicitly called by `wandb.init()`. When using wandb in multiple processes, calling `wandb.setup()` in the parent process before starting child processes may improve performance and resource utilization. Note that `wandb.setup()` modifies `os.environ`, and it is important that child processes inherit the modified environment variables. See also `wandb.teardown()`. Args: settings: Configuration settings to apply globally. These can be overridden by subsequent `wandb.init()` calls. Example: ```python import multiprocessing import wandb def run_experiment(params): with wandb.init(config=params): # Run experiment pass if __name__ == "__main__": # Start backend and set global config wandb.setup(settings={"project": "my_project"}) # Define experiment parameters experiment_params = [ {"learning_rate": 0.01, "epochs": 10}, {"learning_rate": 0.001, "epochs": 20}, ] # Start multiple processes, each running a separate experiment processes = [] for params in experiment_params: p = multiprocessing.Process(target=run_experiment, args=(params,)) p.start() processes.append(p) # Wait for all processes to complete for p in processes: p.join() # Optional: Explicitly shut down the backend wandb.teardown() ``` """ return _setup(settings=settings) @wb_logging.log_to_all_runs() def teardown(exit_code: int | None = None) -> None: """Waits for W&B to finish and frees resources. Completes any runs that were not explicitly finished using `run.finish()` and waits for all data to be uploaded. It is recommended to call this at the end of a session that used `wandb.setup()`. It is invoked automatically in an `atexit` hook, but this is not reliable in certain setups such as when using Python's `multiprocessing` module. """ global _singleton from wandb.sdk.lib import wbauth with _singleton_lock: orig_singleton = _singleton _singleton = None if orig_singleton: orig_singleton._teardown(exit_code=exit_code) wbauth.unauthenticate_session(update_settings=False)