wandb 0.18.4__py3-none-any.whl → 0.18.6__py3-none-any.whl

wandb/sdk/launch/runner/abstract.py

@@ -82,7 +82,6 @@ class AbstractRun(ABC):
     @abstractmethod
     async def get_logs(self) -> Optional[str]:
         """Return the logs associated with the run."""
-        pass
 
     def _run_cmd(
         self, cmd: List[str], output_only: Optional[bool] = False
@@ -111,12 +110,10 @@ class AbstractRun(ABC):
 
         Note that in some cases, we may wait until the remote job completes rather than until the W&B run completes.
         """
-        pass
 
     @abstractmethod
     async def get_status(self) -> Status:
         """Get status of the run."""
-        pass
 
     @abstractmethod
     async def cancel(self) -> None:
@@ -125,7 +122,6 @@ class AbstractRun(ABC):
         Cancels the run and waits for it to terminate. The W&B run status may not be
         set correctly upon run cancellation.
         """
-        pass
 
     @property
     @abstractmethod
@@ -192,4 +188,3 @@ class AbstractRunner(ABC):
             the project asynchronously, i.e. it should trigger project execution and then
             immediately return a `SubmittedRun` to track execution status.
         """
-        pass

wandb/sdk/launch/sweeps/__init__.py

@@ -7,8 +7,6 @@ log = logging.getLogger(__name__)
 class SchedulerError(Exception):
     """Raised when a known error occurs with wandb sweep scheduler."""
 
-    pass
-
 
 def _import_sweep_scheduler() -> Any:
     from .scheduler_sweep import SweepScheduler

wandb/sdk/launch/sweeps/scheduler.py

@@ -183,12 +183,10 @@ class Scheduler(ABC):
     @abstractmethod
     def _get_next_sweep_run(self, worker_id: int) -> Optional[SweepRun]:
         """Called when worker available."""
-        pass
 
     @abstractmethod
     def _poll(self) -> None:
         """Called every polling loop."""
-        pass
 
     @abstractmethod
     def _exit(self) -> None:

wandb/sdk/launch/sweeps/scheduler_sweep.py

@@ -82,7 +82,6 @@ class SweepScheduler(Scheduler):
 
     def _poll(self) -> None:
         _logger.debug(f"_poll. _runs: {self._runs}")
-        pass
 
     def _load_state(self) -> None:
         pass

wandb/sdk/lib/apikey.py

@@ -21,10 +21,9 @@ from requests.utils import NETRC_FILES, get_netrc_auth
 import wandb
 from wandb.apis import InternalApi
 from wandb.errors import term
+from wandb.errors.links import url_registry
 from wandb.util import _is_databricks, isatty, prompt_choices
 
-from .wburls import wburls
-
 LOGIN_CHOICE_ANON = "Private W&B dashboard, no account required"
 LOGIN_CHOICE_NEW = "Create a W&B account"
 LOGIN_CHOICE_EXISTS = "Use an existing W&B account"
@@ -156,7 +155,8 @@ def prompt_api_key(  # noqa: C901
                     if app_url.startswith(prefix):
                         host = app_url[len(prefix) :]
                 wandb.termlog(
-                    f"Logging into {host}. (Learn how to deploy a W&B server locally: {wburls.get('wandb_server')})"
+                    f"Logging into {host}. (Learn how to deploy a W&B server "
+                    f"locally: {url_registry.url('wandb-server')})"
                 )
             wandb.termlog(
                 f"You can find your API key in your browser here: {app_url}/authorize"

wandb/sdk/lib/file_stream_utils.py

@@ -12,7 +12,7 @@ def split_files(
     This method is used in `FileStreamAPI._send()` to limit the size of post requests
     sent to wandb server.
 
-    Arguments:
+    Args:
     files (dict): `dict` of form {file_name: {'content': ".....", 'offset': 0}}
         The key `file_name` can also be mapped to a List [{"offset": int, "content": str}]
     `max_bytes`: max size for chunk in bytes

wandb/sdk/lib/filesystem.py

@@ -16,7 +16,7 @@ from wandb.sdk.lib.paths import StrPath
 logger = logging.getLogger(__name__)
 
 # https://en.wikipedia.org/wiki/Filename#Comparison_of_filename_limitations
-PROBLEMATIC_PATH_CHARS = "".join(chr(i) for i in range(0, 32)) + ':"*<>?|'
+PROBLEMATIC_PATH_CHARS = "".join(chr(i) for i in range(32)) + ':"*<>?|'
 
 
 def mkdir_exists_ok(dir_name: StrPath) -> None:

wandb/sdk/lib/ipython.py

@@ -15,16 +15,16 @@ PythonType = Literal["python", "ipython", "jupyter"]
 logger = logging.getLogger(__name__)
 
 
-TABLE_STYLES = """<style>
-    table.wandb td:nth-child(1) { padding: 0 10px; text-align: left ; width: auto;} td:nth-child(2) {text-align: left ; width: 100%}
-    .wandb-row { display: flex; flex-direction: row; flex-wrap: wrap; justify-content: flex-start; width: 100% }
-    .wandb-col { display: flex; flex-direction: column; flex-basis: 100%; flex: 1; padding: 10px; }
-    </style>
-"""
-
-
 def toggle_button(what="run"):
-    return f"<button onClick=\"this.nextSibling.style.display='block';this.style.display='none';\">Display W&B {what}</button>"
+    """Returns the HTML for a button used to reveal the element following it.
+
+    The element immediately after the button must have `display: none`.
+    """
+    return (
+        "<button onClick=\"this.nextSibling.style.display='block';this.style.display='none';\">"
+        f"Display W&B {what}"
+        "</button>"
+    )
 
 
 def _get_python_type() -> PythonType:
@@ -62,10 +62,17 @@ def _get_python_type() -> PythonType:
 
 
 def in_jupyter() -> bool:
+    """Returns True if we're in a Jupyter notebook."""
     return _get_python_type() == "jupyter"
 
 
+def in_ipython() -> bool:
+    """Returns True if we're running in IPython in the terminal."""
+    return _get_python_type() == "ipython"
+
+
 def in_notebook() -> bool:
+    """Returns True if we're running in Jupyter or IPython."""
     return _get_python_type() != "python"
 
 

wandb/sdk/lib/mailbox.py

@@ -23,14 +23,10 @@ def _generate_address(length: int = 12) -> str:
 class MailboxError(Error):
     """Generic Mailbox Exception."""
 
-    pass
-
 
 class ContextCancelledError(MailboxError):
     """Context cancelled Exception."""
 
-    pass
-
 
 class _MailboxWaitAll:
     _event: threading.Event

wandb/sdk/lib/printer.py

@@ -63,6 +63,48 @@ to form a subtle clockwise spinning animation.
 _PROGRESS_SYMBOL_COLOR = 0xB2
 """Color from the 256-color palette for the progress symbol."""
 
+_JUPYTER_TABLE_STYLES = """
+    <style>
+        table.wandb td:nth-child(1) {
+            padding: 0 10px;
+            text-align: left;
+            width: auto;
+        }
+
+        table.wandb td:nth-child(2) {
+            text-align: left;
+            width: 100%;
+        }
+    </style>
+"""
+
+_JUPYTER_PANEL_STYLES = """
+    <style>
+        .wandb-row {
+            display: flex;
+            flex-direction: row;
+            flex-wrap: wrap;
+            justify-content: flex-start;
+            width: 100%;
+        }
+        .wandb-col {
+            display: flex;
+            flex-direction: column;
+            flex-basis: 100%;
+            flex: 1;
+            padding: 10px;
+        }
+    </style>
+"""
+
+
+def new_printer() -> Printer:
+    """Returns a new printer based on the environment we're in."""
+    if ipython.in_jupyter():
+        return _PrinterJupyter()
+    else:
+        return _PrinterTerm()
+
 
 class Printer(abc.ABC):
     """An object that shows styled text to the user."""
@@ -485,15 +527,9 @@ class _PrinterJupyter(Printer):
         grid = f'<table class="wandb">{grid}</table>'
         if title:
             return f"<h3>{title}</h3><br/>{grid}<br/>"
-        return f"{grid}<br/>"
+        return f"{_JUPYTER_TABLE_STYLES}{grid}<br/>"
 
     @override
     def panel(self, columns: list[str]) -> str:
         row = "".join([f'<div class="wandb-col">{col}</div>' for col in columns])
-        return f'{ipython.TABLE_STYLES}<div class="wandb-row">{row}</div>'
-
-
-def get_printer(jupyter: bool) -> Printer:
-    if jupyter:
-        return _PrinterJupyter()
-    return _PrinterTerm()
+        return f'{_JUPYTER_PANEL_STYLES}<div class="wandb-row">{row}</div>'

wandb/sdk/lib/retry.py

@@ -94,7 +94,7 @@ class Retry(Generic[_R]):
     def __call__(self, *args: Any, **kwargs: Any) -> _R:  # noqa: C901
         """Call the wrapped function, with retries.
 
-        Arguments:
+        Args:
            retry_timedelta (kwarg): amount of time to retry before giving up.
            sleep_base (kwarg): amount of time to sleep upon first failure, all other sleeps
                are derived from this one.

wandb/sdk/service/service.py

@@ -17,7 +17,7 @@ from typing import TYPE_CHECKING, Any, Dict, Optional
 from wandb import _sentry, termlog
 from wandb.env import core_debug, error_reporting_enabled, is_require_legacy_service
 from wandb.errors import Error, WandbCoreNotAvailableError
-from wandb.sdk.lib.wburls import wburls
+from wandb.errors.links import url_registry
 from wandb.util import get_core_path, get_module
 
 from . import _startup_debug, port_file
@@ -164,8 +164,8 @@ class _Service:
 
                 exec_cmd_list = []
                 termlog(
-                    "Using wandb-core as the SDK backend."
-                    f" Please refer to {wburls.get('wandb_core')} for more information.",
+                    "Using wandb-core as the SDK backend.  Please refer to "
+                    f"{url_registry.url('wandb-core')} for more information.",
                     repeat=False,
                 )
             else:

wandb/sdk/service/streams.py

@@ -20,6 +20,7 @@ import wandb
 import wandb.util
 from wandb.proto import wandb_internal_pb2 as pb
 from wandb.sdk.internal.settings_static import SettingsStatic
+from wandb.sdk.lib import printer as printerlib
 from wandb.sdk.lib import progress
 from wandb.sdk.lib.mailbox import (
     Mailbox,
@@ -27,7 +28,6 @@ from wandb.sdk.lib.mailbox import (
     MailboxProgress,
     MailboxProgressAll,
 )
-from wandb.sdk.lib.printer import get_printer
 from wandb.sdk.wandb_run import Run
 
 from ..interface.interface_relay import InterfaceRelay
@@ -285,9 +285,7 @@ class StreamMux:
         if not streams:
             return
 
-        printer = get_printer(
-            all(stream._settings._jupyter for stream in streams.values())
-        )
+        printer = printerlib.new_printer()
 
         # fixme: for now we have a single printer for all streams,
         # and jupyter is disabled if at least single stream's setting set `_jupyter` to false

wandb/sdk/wandb_init.py

@@ -24,6 +24,7 @@ import wandb
 import wandb.env
 from wandb import trigger
 from wandb.errors import CommError, Error, UsageError
+from wandb.errors.links import url_registry
 from wandb.errors.util import ProtobufErrorHandler
 from wandb.integration import sagemaker
 from wandb.integration.magic import magic_install
@@ -33,11 +34,17 @@ from wandb.util import _is_artifact_representation
 
 from . import wandb_login, wandb_setup
 from .backend.backend import Backend
-from .lib import SummaryDisabled, filesystem, ipython, module, reporting, telemetry
+from .lib import (
+    SummaryDisabled,
+    filesystem,
+    ipython,
+    module,
+    printer,
+    reporting,
+    telemetry,
+)
 from .lib.deprecate import Deprecated, deprecate
 from .lib.mailbox import Mailbox, MailboxProgress
-from .lib.printer import Printer, get_printer
-from .lib.wburls import wburls
 from .wandb_helper import parse_config
 from .wandb_run import Run, TeardownHook, TeardownStage
 from .wandb_settings import Settings, Source
@@ -125,17 +132,12 @@ class _WandbInit:
         self._wl: wandb_setup._WandbSetup | None = None
         self._reporter: wandb.sdk.lib.reporting.Reporter | None = None
         self.notebook: wandb.jupyter.Notebook | None = None  # type: ignore
-        self.printer: Printer | None = None
+        self.printer = printer.new_printer()
 
         self._init_telemetry_obj = telemetry.TelemetryRecord()
 
         self.deprecated_features_used: dict[str, str] = dict()
 
-    def _setup_printer(self, settings: Settings) -> None:
-        if self.printer:
-            return
-        self.printer = get_printer(settings._jupyter)
-
     def setup(self, kwargs: Any) -> None:  # noqa: C901
         """Complete setup for `wandb.init()`.
 
@@ -148,8 +150,6 @@ class _WandbInit:
         # in between, they will be ignored, which we need to inform the user about.
         singleton = wandb_setup._WandbSetup._instance
         if singleton is not None:
-            self._setup_printer(settings=singleton._settings)
-            assert self.printer
             exclude_env_vars = {"WANDB_SERVICE", "WANDB_KUBEFLOW_URL"}
             # check if environment variables have changed
             singleton_env = {
@@ -170,7 +170,7 @@ class _WandbInit:
                     "because your `wandb` session has already started. "
                     "For more information on how to modify your settings with "
                     "`wandb.init()` arguments, please refer to "
-                    f"{self.printer.link(wburls.get('wandb_init'), 'the W&B docs')}."
+                    f"{self.printer.link(url_registry.url('wandb-init'), 'the W&B docs')}."
                 )
                 self.printer.display(line, level="warn")
 
@@ -202,7 +202,6 @@ class _WandbInit:
         if settings_param is not None and isinstance(settings_param, (Settings, dict)):
             settings.update(settings_param, source=Source.INIT)
 
-        self._setup_printer(settings)
         self._reporter = reporting.setup_reporter(settings=settings)
 
         sagemaker_config: dict = (
@@ -610,7 +609,6 @@ class _WandbInit:
         return drun
 
     def _on_progress_init(self, handle: MailboxProgress) -> None:
-        assert self.printer
         line = "Waiting for wandb.init()...\r"
         percent_done = handle.percent_done
         self.printer.progress_update(line, percent_done=percent_done)
@@ -827,7 +825,8 @@ class _WandbInit:
         if run_result is None:
             error_message = (
                 f"Run initialization has timed out after {timeout} sec. "
-                f"\nPlease refer to the documentation for additional information: {wburls.get('doc_start_err')}"
+                "Please try increasing the timeout with the `init_timeout` setting: "
+                "`wandb.init(settings=wandb.Settings(init_timeout=120))`."
             )
             # We're not certain whether the error we encountered is due to an issue
             # with the server (a "CommError") or if it's a problem within the SDK (an "Error").
@@ -851,7 +850,8 @@ class _WandbInit:
 
         if not run_result.HasField("run"):
             raise Error(
-                "It appears that something have gone wrong during the program execution as an unexpected missing field was encountered. "
+                "It appears that something have gone wrong during the program "
+                "execution as an unexpected missing field was encountered. "
                 "(run_result is missing the 'run' field)"
             )
 
@@ -920,7 +920,7 @@ def _attach(
 ) -> Run | None:
     """Attach to a run currently executing in another process/thread.
 
-    Arguments:
+    Args:
         attach_id: (str, optional) The id of the run or an attach identifier
             that maps to a run.
         run_id: (str, optional) The id of the run to attach to.
@@ -1064,7 +1064,7 @@ def init(
     For more on using `wandb.init()`, including detailed examples, check out our
     [guide and FAQs](https://docs.wandb.ai/guides/track/launch).
 
-    Arguments:
+    Args:
         project: (str, optional) The name of the project where you're sending
             the new run. If the project is not specified, we will try to infer
             the project name from git root or the current program file. If we
@@ -1187,11 +1187,11 @@ def init(
             for saving hyperparameters to compare across runs. The ID cannot
             contain the following special characters: `/\#?%:`.
             See [our guide to resuming runs](https://docs.wandb.com/guides/runs/resuming).
-        fork_from: (str, optional) A string with the format {run_id}?_step={step} describing
+        fork_from: (str, optional) A string with the format `{run_id}?_step={step}` describing
             a moment in a previous run to fork a new run from. Creates a new run that picks up
             logging history from the specified run at the specified moment. The target run must
             be in the current project. Example: `fork_from="my-run-id?_step=1234"`.
-        resume_from: (str, optional) A string with the format {run_id}?_step={step} describing
+        resume_from: (str, optional) A string with the format `{run_id}?_step={step}` describing
             a moment in a previous run to resume a run from. This allows users to truncate
             the history logged to a run at an intermediate step and resume logging from that step.
             It uses run forking under the hood. The target run must be in the

wandb/sdk/wandb_login.py

@@ -58,7 +58,7 @@ def login(
     verifying them with the W&B server. To verify credentials, pass
     `verify=True`.
 
-    Arguments:
+    Args:
         anonymous: (string, optional) Can be "must", "allow", or "never".
             If set to "must", always log a user in anonymously. If set to
             "allow", only create an anonymous user if the user

wandb/sdk/wandb_require.py

@@ -16,7 +16,6 @@ import wandb
 from wandb.env import _REQUIRE_LEGACY_SERVICE
 from wandb.errors import UnsupportedError
 from wandb.sdk import wandb_run
-from wandb.sdk.lib.wburls import wburls
 
 
 class _Requires:
@@ -63,9 +62,7 @@ class _Requires:
             func()
 
         if last_message:
-            wandb.termerror(
-                f"Supported wandb.require() features can be found at: {wburls.get('doc_require')}"
-            )
+            wandb.termwarn("Supported requirements are: `legacy-service`, `service`.")
             raise UnsupportedError(last_message)