wandb 0.16.6__py3-none-any.whl → 0.17.0rc2__py3-none-any.whl

wandb/sdk/lib/redirect.py

@@ -224,7 +224,7 @@ class TerminalEmulator:
     def carriage_return(self):
         self.cursor.x = 0
 
-    def cursor_postion(self, line, column):
+    def cursor_position(self, line, column):
         self.cursor.x = min(column, 1) - 1
         self.cursor.y = min(line, 1) - 1
 
@@ -393,25 +393,30 @@ class TerminalEmulator:
                         p = (int(p[0]), 1)
                     else:
                         p = (1, 1)
-                    self.cursor_postion(*p)
+                    self.cursor_position(*p)
         except Exception:
             pass
 
     def _get_line(self, n):
         line = self.buffer[n]
         line_len = self._get_line_len(n)
-        # We have to loop through each character in the line and check if foreground, background and
-        # other attributes (italics, bold, underline, etc) of the ith character are different from those of the
-        # (i-1)th character. If different, the appropriate ascii character for switching the color/attribute
-        # should be appended to the output string before appending the actual character. This loop and subsequent
-        # checks can be expensive, especially because 99% of terminal output use default colors and formatting. Even
-        # in outputs that do contain colors and styles, its unlikely that they will change on a per character basis.
-
-        # So instead we create a character list without any ascii codes (`out`), and a list of all the foregrounds
-        # in the line (`fgs`) on which we call np.diff() and np.where() to find the indices where the foreground change,
-        # and insert the ascii characters in the output list (`out`) on those indices. All of this is the done ony if
-        # there are more than 1 foreground color in the line in the first place (`if len(set(fgs)) > 1 else None`).
-        # Same logic is repeated for background colors and other attributes.
+        # We have to loop through each character in the line and check if foreground,
+        # background and other attributes (italics, bold, underline, etc) of the ith
+        # character are different from those of the (i-1)th character. If different, the
+        # appropriate ascii character for switching the color/attribute should be
+        # appended to the output string before appending the actual character. This loop
+        # and subsequent checks can be expensive, especially because 99% of terminal
+        # output use default colors and formatting. Even in outputs that do contain
+        # colors and styles, its unlikely that they will change on a per character
+        # basis.
+
+        # So instead we create a character list without any ascii codes (`out`), and a
+        # list of all the foregrounds in the line (`fgs`) on which we call np.diff() and
+        # np.where() to find the indices where the foreground change, and insert the
+        # ascii characters in the output list (`out`) on those indices. All of this is
+        # the done only if there are more than 1 foreground color in the line in the
+        # first place (`if len(set(fgs)) > 1 else None`). Same logic is repeated for
+        # background colors and other attributes.
 
         out = [line[i].data for i in range(line_len)]
 

wandb/sdk/lib/retry.py

@@ -248,8 +248,9 @@ class ExponentialBackoff(Backoff):
         if self._timeout_at is not None and NOW_FN() > self._timeout_at:
             raise exc
 
-        result, self._next_sleep = self._next_sleep, min(
-            self._max_sleep, self._next_sleep * (1 + random.random())
+        result, self._next_sleep = (
+            self._next_sleep,
+            min(self._max_sleep, self._next_sleep * (1 + random.random())),
         )
 
         return result

wandb/sdk/lib/tracelog.py

@@ -6,7 +6,7 @@ Functions:
     log_message_send    - message sent to socket
     log_message_recv    - message received from socket
     log_message_process - message processed by thread
-    log_message_link    - message linked to another mesage
+    log_message_link    - message linked to another message
     log_message_assert  - message encountered problem
 
 """

wandb/sdk/service/service.py

@@ -2,6 +2,7 @@
 
 Backend server process can be connected to using tcp sockets transport.
 """
+
 import datetime
 import os
 import pathlib
@@ -14,8 +15,8 @@ import time
 from typing import TYPE_CHECKING, Any, Dict, Optional
 
 from wandb import _sentry, termlog
-from wandb.env import error_reporting_enabled
-from wandb.errors import Error
+from wandb.env import core_debug, core_error_reporting_enabled, is_require_core
+from wandb.errors import Error, WandbCoreNotAvailableError
 from wandb.sdk.lib.wburls import wburls
 from wandb.util import get_core_path, get_module
 
@@ -161,28 +162,29 @@ class _Service:
                 exec_cmd_list += ["coverage", "run", "-m"]
 
             service_args = []
-            # NOTE: "wandb-core" is the name of the package that will be distributed
-            #       as the stable version of the wandb core library.
-            #
-            #       Environment variable _WANDB_CORE_PATH is a temporary development feature
-            #       to assist in running the core service from a live development directory.
-            core_path = get_core_path()
-            if core_path:
+
+            if is_require_core():
+                try:
+                    core_path = get_core_path()
+                except WandbCoreNotAvailableError as e:
+                    _sentry.reraise(e)
+
                 service_args.extend([core_path])
-                if not error_reporting_enabled():
+
+                if not core_error_reporting_enabled(default="True"):
                     service_args.append("--no-observability")
-                if os.environ.get("WANDB_CORE_DEBUG", False):
+
+                if core_debug(default="False"):
                     service_args.append("--debug")
+
                 trace_filename = os.environ.get("_WANDB_TRACE")
                 if trace_filename is not None:
                     service_args.extend(["--trace", trace_filename])
 
                 exec_cmd_list = []
-                # TODO: remove this after the wandb-core GA release
-                wandb_core = get_module("wandb_core")
                 termlog(
-                    f"Using wandb-core version {wandb_core.__version__} as the SDK backend. "
-                    f"Please refer to {wburls.get('wandb_core')} for more information.",
+                    "Using wandb-core as the SDK backend."
+                    f" Please refer to {wburls.get('wandb_core')} for more information.",
                     repeat=False,
                 )
             else:

wandb/sdk/verify/verify.py

@@ -1,4 +1,5 @@
 """Utilities for wandb verify."""
+
 import getpass
 import os
 import time
@@ -20,7 +21,7 @@ PROJECT_NAME = "verify"
 GET_RUN_MAX_TIME = 10
 MIN_RETRYS = 3
 CHECKMARK = "\u2705"
-RED_X = "\u274C"
+RED_X = "\u274c"
 ID_PREFIX = runid.generate_id()
 
 

wandb/sdk/wandb_manager.py

@@ -5,7 +5,7 @@ Create a manager channel.
 
 import atexit
 import os
-from typing import TYPE_CHECKING, Any, Callable, Dict, Optional
+from typing import TYPE_CHECKING, Callable, Optional
 
 import psutil
 
@@ -205,7 +205,7 @@ class _Manager:
         svc_iface = self._get_service_interface()
         svc_iface._svc_inform_start(settings=settings, run_id=run_id)
 
-    def _inform_attach(self, attach_id: str) -> Optional[Dict[str, Any]]:
+    def _inform_attach(self, attach_id: str) -> Optional["wandb_settings_pb2.Settings"]:
         svc_iface = self._get_service_interface()
         try:
             response = svc_iface._svc_inform_attach(attach_id=attach_id)

wandb/sdk/wandb_require.py

@@ -9,9 +9,11 @@ Example:
     wandb.require("incremental-artifacts@beta")
 """
 
+import os
 from typing import Optional, Sequence, Union
 
 import wandb
+from wandb.env import _REQUIRE_CORE
 from wandb.errors import UnsupportedError
 from wandb.sdk import wandb_run
 from wandb.sdk.lib.wburls import wburls
@@ -38,6 +40,9 @@ class _Requires:
     def require_service(self) -> None:
         self._require_service()
 
+    def require_core(self) -> None:
+        os.environ[_REQUIRE_CORE] = "true"
+
     def apply(self) -> None:
         """Call require_* method for supported features."""
         last_message: str = ""

wandb/sdk/wandb_run.py

@@ -327,8 +327,7 @@ class RunStatusChecker:
 class _run_decorator:  # noqa: N801
     _is_attaching: str = ""
 
-    class Dummy:
-        ...
+    class Dummy: ...
 
     @classmethod
     def _attach(cls, func: Callable) -> Callable:
@@ -1854,7 +1853,7 @@ class Run:
         picked up automatically.
 
         A `base_path` may be provided to control the directory structure of
-        uploaded files. It should be a prefix of `glob_str`, and the direcotry
+        uploaded files. It should be a prefix of `glob_str`, and the directory
         structure beneath it is preserved. It's best understood through
         examples:
 
@@ -1866,16 +1865,19 @@ class Run:
         # => Saves files in an "are/myfiles/" folder in the run.
 
         wandb.save("/User/username/Documents/run123/*.txt")
-        # => Saves files in a "run123/" folder in the run.
+        # => Saves files in a "run123/" folder in the run. See note below.
 
         wandb.save("/User/username/Documents/run123/*.txt", base_path="/User")
         # => Saves files in a "username/Documents/run123/" folder in the run.
 
         wandb.save("files/*/saveme.txt")
         # => Saves each "saveme.txt" file in an appropriate subdirectory
-        # of "files/".
+        #    of "files/".
         ```
 
+        Note: when given an absolute path or glob and no `base_path`, one
+        directory level is preserved as in the example above.
+
         Arguments:
             glob_str: A relative or absolute path or Unix glob.
             base_path: A path to use to infer a directory structure; see examples.
@@ -1909,7 +1911,11 @@ class Run:
             # Provide a better error message for a common misuse.
             wandb.termlog(f"{glob_str} is a cloud storage url, can't save file to W&B.")
             return []
-        glob_path = pathlib.Path(glob_str)
+        # NOTE: We use PurePath instead of Path because WindowsPath doesn't
+        # like asterisks and errors out in resolve(). It also makes logical
+        # sense: globs aren't real paths, they're just path-like strings.
+        glob_path = pathlib.PurePath(glob_str)
+        resolved_glob_path = pathlib.PurePath(os.path.abspath(glob_path))
 
         if base_path is not None:
             base_path = pathlib.Path(base_path)
@@ -1923,15 +1929,14 @@ class Run:
                 'wandb.save("/mnt/folder/file.h5", base_path="/mnt")',
                 repeat=False,
             )
-            base_path = glob_path.resolve().parent.parent
+            base_path = resolved_glob_path.parent.parent
 
         if policy not in ("live", "end", "now"):
             raise ValueError(
                 'Only "live", "end" and "now" policies are currently supported.'
             )
 
-        resolved_glob_path = glob_path.resolve()
-        resolved_base_path = base_path.resolve()
+        resolved_base_path = pathlib.PurePath(os.path.abspath(base_path))
 
         return self._save(
             resolved_glob_path,
@@ -1941,8 +1946,8 @@ class Run:
 
     def _save(
         self,
-        glob_path: pathlib.Path,
-        base_path: pathlib.Path,
+        glob_path: pathlib.PurePath,
+        base_path: pathlib.PurePath,
         policy: "PolicyName",
     ) -> List[str]:
         # Can't use is_relative_to() because that's added in Python 3.9,
@@ -3171,13 +3176,13 @@ class Run:
             )
         if entity and artifact._source_entity and entity != artifact._source_entity:
             raise ValueError(
-                f"Artifact {artifact.name} is owned by entity '{entity}'; it can't be "
-                f"moved to '{artifact._source_entity}'"
+                f"Artifact {artifact.name} is owned by entity "
+                f"'{artifact._source_entity}'; it can't be moved to '{entity}'"
             )
         if project and artifact._source_project and project != artifact._source_project:
             raise ValueError(
-                f"Artifact {artifact.name} exists in project '{project}'; it can't be "
-                f"moved to '{artifact._source_project}'"
+                f"Artifact {artifact.name} exists in project "
+                f"'{artifact._source_project}'; it can't be moved to '{project}'"
             )
 
     def _prepare_artifact(
@@ -3304,8 +3309,8 @@ class Run:
             path: (str) path to downloaded model artifact file(s).
         """
         artifact = self.use_artifact(artifact_or_name=name)
-        assert "model" in str(
-            artifact.type.lower()
+        assert (
+            "model" in str(artifact.type.lower())
         ), "You can only use this method for 'model' artifacts. For an artifact to be a 'model' artifact, its type property must contain the substring 'model'."
         path = artifact.download()
 
@@ -3397,8 +3402,8 @@ class Run:
         public_api = self._public_api()
         try:
             artifact = public_api.artifact(name=f"{name}:latest")
-            assert "model" in str(
-                artifact.type.lower()
+            assert (
+                "model" in str(artifact.type.lower())
             ), "You can only use this method for 'model' artifacts. For an artifact to be a 'model' artifact, its type property must contain the substring 'model'."
             artifact = self._log_artifact(
                 artifact_or_path=path, name=name, type=artifact.type
@@ -3656,7 +3661,7 @@ class Run:
     # FOOTER
     # ------------------------------------------------------------------------------
     # Note: All the footer methods are static methods since we want to share the printing logic
-    # with the service execution path that doesn't have acess to the run instance
+    # with the service execution path that doesn't have access to the run instance
     @staticmethod
     def _footer(
         sampled_history: Optional["SampledHistoryResponse"] = None,

wandb/sdk/wandb_settings.py

@@ -1675,7 +1675,6 @@ class Settings(SettingsData):
             "WANDB_TRACELOG": "_tracelog",
             "WANDB_DISABLE_SERVICE": "_disable_service",
             "WANDB_SERVICE_TRANSPORT": "_service_transport",
-            "WANDB_REQUIRE_CORE": "_require_core",
             "WANDB_DIR": "root_dir",
             "WANDB_NAME": "run_name",
             "WANDB_NOTES": "run_notes",

wandb/sdk/wandb_setup.py

@@ -1,7 +1,7 @@
 #
 """Setup wandb session.
 
-This module configures a wandb session which can extend to mutiple wandb runs.
+This module configures a wandb session which can extend to multiple wandb runs.
 
 Functions:
     setup(): Configure wandb session.

wandb/sklearn/__init__.py

@@ -1,4 +1,5 @@
 """Create informative charts for scikit-learn models and log them to W&B."""
+
 from .plot import (
     plot_calibration_curve,
     plot_class_proportions,

wandb/sklearn/plot/__init__.py

@@ -1,4 +1,5 @@
 """Create and logs charts introspecting models built with scikit-learn to W&B."""
+
 from .classifier import calibration_curve as plot_calibration_curve
 from .classifier import class_proportions as plot_class_proportions
 from .classifier import classifier as plot_classifier

wandb/sklearn/plot/classifier.py

@@ -1,4 +1,5 @@
 """Define plots for classification models built with scikit-learn."""
+
 from warnings import simplefilter
 
 import numpy as np
@@ -32,9 +33,9 @@ def classifier(
 
     The following plots are generated:
         feature importances, confusion matrix, summary metrics,
-        class propotions, calibration curve, roc curve, precision-recall curve.
+        class proportions, calibration curve, roc curve, precision-recall curve.
 
-    Should only be called with a fitted classifer (otherwise an error is thrown).
+    Should only be called with a fitted classifier (otherwise an error is thrown).
 
     Arguments:
         model: (classifier) Takes in a fitted classifier.
@@ -44,7 +45,7 @@ def classifier(
         y_test: (arr) Test set labels.
         y_pred: (arr) Test set predictions by the model passed.
         y_probas: (arr) Test set predicted probabilities by the model passed.
-        labels: (list) Named labels for target varible (y). Makes plots easier to
+        labels: (list) Named labels for target variable (y). Makes plots easier to
                         read by replacing target values with corresponding index.
                         For example if `labels=['dog', 'cat', 'owl']` all 0s are
                         replaced by dog, 1s by cat.
@@ -224,7 +225,7 @@ def feature_importances(
 ):
     """Log a plot depicting the relative importance of each feature for a classifier's decisions.
 
-    Should only be called with a fitted classifer (otherwise an error is thrown).
+    Should only be called with a fitted classifier (otherwise an error is thrown).
     Only works with classifiers that have a feature_importances_ attribute, like trees.
 
     Arguments:
@@ -251,7 +252,7 @@ def feature_importances(
 
 
 def class_proportions(y_train=None, y_test=None, labels=None):
-    """Plot the distribution of target classses in training and test sets.
+    """Plot the distribution of target classes in training and test sets.
 
     Useful for detecting imbalanced classes.
 
@@ -295,7 +296,7 @@ def calibration_curve(clf=None, X=None, y=None, clf_name="Classifier"):
     if so which calibration (sigmoid or isotonic) might help fix this.
     For more details, see https://scikit-learn.org/stable/auto_examples/calibration/plot_calibration_curve.html.
 
-    Should only be called with a fitted classifer (otherwise an error is thrown).
+    Should only be called with a fitted classifier (otherwise an error is thrown).
 
     Please note this function fits variations of the model on the training set when called.
 

wandb/sklearn/plot/clusterer.py

@@ -1,4 +1,5 @@
 """Define plots for clustering models built with scikit-learn."""
+
 from warnings import simplefilter
 
 import pandas as pd
@@ -24,7 +25,7 @@ def clusterer(model, X_train, cluster_labels, labels=None, model_name="Clusterer
         X_train: (arr) Training set features.
         cluster_labels: (list) Names for cluster labels. Makes plots easier to read
                             by replacing cluster indexes with corresponding names.
-        labels: (list) Named labels for target varible (y). Makes plots easier to
+        labels: (list) Named labels for target variable (y). Makes plots easier to
                         read by replacing target values with corresponding index.
                         For example if `labels=['dog', 'cat', 'owl']` all 0s are
                         replaced by dog, 1s by cat.

wandb/sklearn/plot/regressor.py

@@ -1,4 +1,5 @@
 """Define plots for regression models built with scikit-learn."""
+
 from warnings import simplefilter
 
 import numpy as np

wandb/sklearn/plot/shared.py

@@ -1,4 +1,5 @@
 """Define plots used by multiple sklearn model classes."""
+
 from warnings import simplefilter
 
 import numpy as np

wandb/sklearn/utils.py

@@ -1,4 +1,5 @@
 """Shared utilities for the modules in wandb.sklearn."""
+
 from collections.abc import Iterable, Sequence
 
 import numpy as np

wandb/testing/relay.py

@@ -586,11 +586,11 @@ class InjectedResponse:
 
 
 class RelayControlProtocol(Protocol):
-    def process(self, request: "flask.Request") -> None:
-        ...  # pragma: no cover
+    def process(self, request: "flask.Request") -> None: ...  # pragma: no cover
 
-    def control(self, request: "flask.Request") -> Mapping[str, str]:
-        ...  # pragma: no cover
+    def control(
+        self, request: "flask.Request"
+    ) -> Mapping[str, str]: ...  # pragma: no cover
 
 
 class RelayServer:

wandb/trigger.py

@@ -6,6 +6,7 @@ Usage:
     trigger.call('on_something', *args, **kwargs)
     trigger.unregister('on_something', func)
 """
+
 from typing import Any, Callable
 
 _triggers = {}

wandb/util.py

@@ -11,6 +11,7 @@ import logging
 import math
 import numbers
 import os
+import pathlib
 import platform
 import queue
 import random
@@ -55,7 +56,13 @@ import yaml
 
 import wandb
 import wandb.env
-from wandb.errors import AuthenticationError, CommError, UsageError, term
+from wandb.errors import (
+    AuthenticationError,
+    CommError,
+    UsageError,
+    WandbCoreNotAvailableError,
+    term,
+)
 from wandb.sdk.internal.thread_local_settings import _thread_local_api_settings
 from wandb.sdk.lib import filesystem, runid
 from wandb.sdk.lib.json_util import dump, dumps
@@ -1842,15 +1849,6 @@ def sample_with_exponential_decay_weights(
     return sampled_xs, sampled_ys, sampled_keys
 
 
-def get_core_path() -> str:
-    core_path: str = os.environ.get("_WANDB_CORE_PATH", "")
-    wandb_core = get_module("wandb_core")
-    if not core_path and wandb_core:
-        _check_wandb_core_version_compatibility(wandb_core.__version__)
-        core_path = wandb_core.get_core_path()
-    return core_path
-
-
 @dataclasses.dataclass(frozen=True)
 class InstalledDistribution:
     """An installed distribution.
@@ -1888,15 +1886,40 @@ def parse_version(version: str) -> "packaging.version.Version":
     try:
         from packaging.version import parse as parse_version  # type: ignore
     except ImportError:
-        from pkg_resources import parse_version
+        from pkg_resources import parse_version  # type: ignore[assignment]
 
     return parse_version(version)
 
 
-def _check_wandb_core_version_compatibility(core_version: str) -> None:
-    """Checks if the installed wandb-core version is compatible with the wandb version."""
-    if parse_version(core_version) < parse_version(wandb._minimum_core_version):
-        raise ImportError(
-            f"Requires wandb-core version {wandb._minimum_core_version} or later, "
-            f"but you have {core_version}. Run `pip install --upgrade wandb-core` to upgrade."
+def get_core_path() -> str:
+    """Returns the path to the wandb-core binary.
+
+    The path can be set explicitly via the _WANDB_CORE_PATH environment
+    variable. Otherwise, the path to the binary in the current package
+    is returned.
+
+    Returns:
+        str: The path to the wandb-core package.
+
+    Raises:
+        WandbCoreNotAvailableError: If wandb-core was not built for the current system.
+    """
+    # NOTE: Environment variable _WANDB_CORE_PATH is a temporary development feature
+    #       to assist in running the core service from a live development directory.
+    path_from_env: str = os.environ.get("_WANDB_CORE_PATH", "")
+    if path_from_env:
+        wandb.termwarn(
+            f"Using wandb-core from path `_WANDB_CORE_PATH={path_from_env}`. "
+            "This is a development feature and may not work as expected."
+        )
+        return path_from_env
+
+    bin_path = pathlib.Path(__file__).parent / "bin" / "wandb-core"
+    if not bin_path.exists():
+        raise WandbCoreNotAvailableError(
+            f"Looks like wandb-core is not compiled for your system ({platform.platform()}):"
+            " Please contact support at support@wandb.com to request `wandb-core`"
+            " support for your system."
         )
+
+    return str(bin_path)

wandb/wandb_controller.py

@@ -20,7 +20,7 @@ Example:
     tuner = wandb.controller()
     tuner.configure(sweep_config)
     tuner.create()
-    # (3) create by constructing progamatic sweep configuration
+    # (3) create by constructing programmatic sweep configuration
     tuner = wandb.controller()
     tuner.configure_search('random')
     tuner.configure_program('train-dummy.py')
@@ -47,7 +47,6 @@ Example:
             tuner.stop_runs(runs)
 """
 
-
 import json
 import os
 import random
@@ -128,7 +127,7 @@ class _WandbController:
     """
 
     def __init__(self, sweep_id_or_config=None, entity=None, project=None):
-        # sweep id configured in constuctor
+        # sweep id configured in constructor
         self._sweep_id: Optional[str] = None
 
         # configured parameters

wandb/wandb_torch.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 
-"""PyTorch-specific functionality
-"""
+"""PyTorch-specific functionality"""
 
 import itertools
 from functools import reduce