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

wandb/sdk/wandb_run.py

@@ -31,14 +31,15 @@ import requests
 
 import wandb
 import wandb.env
-from wandb import errors, trigger
+from wandb import trigger
 from wandb._globals import _datatypes_set_callback
 from wandb.apis import internal, public
 from wandb.apis.internal import Api
 from wandb.apis.public import Api as PublicApi
-from wandb.errors import CommError
+from wandb.errors import CommError, UnsupportedError, UsageError
+from wandb.errors.links import url_registry
 from wandb.integration.torch import wandb_torch
-from wandb.plot.viz import CustomChart, Visualize, custom_chart
+from wandb.plot import CustomChart, Visualize, plot_table
 from wandb.proto.wandb_internal_pb2 import (
     MetricRecord,
     PollExitResponse,
@@ -89,7 +90,6 @@ from .lib.gitlib import GitRepo
 from .lib.mailbox import MailboxError, MailboxHandle, MailboxProbe, MailboxProgress
 from .lib.proto_util import message_to_dict
 from .lib.reporting import Reporter
-from .lib.wburls import wburls
 from .wandb_alerts import AlertLevel
 from .wandb_settings import Settings
 from .wandb_setup import _WandbSetup
@@ -410,7 +410,7 @@ class _run_decorator:  # noqa: N801
                 if only_warn:
                     warnings.warn(resolved_message, UserWarning, stacklevel=2)
                 else:
-                    raise errors.UsageError(resolved_message)
+                    raise UsageError(resolved_message)
 
             return wrapper_fn
 
@@ -430,11 +430,10 @@ class _run_decorator:  # noqa: N801
                 #   - for fork case the new process share mem space hence the value would be of parent process.
                 _init_pid = getattr(self, "_init_pid", None)
                 if _init_pid != os.getpid():
-                    message = "`{}` ignored (called from pid={}, `init` called from pid={}). See: {}".format(
-                        func.__name__,
-                        os.getpid(),
-                        _init_pid,
-                        wburls.get("multiprocess"),
+                    message = (
+                        f"`{func.__name__}` ignored (called from pid={os.getpid()}, "
+                        f"`init` called from pid={_init_pid}). "
+                        f"See: {url_registry.url('multiprocess')}"
                     )
                     # - if this process was pickled in non-service case,
                     #   we ignore the attributes (since pickle is not supported)
@@ -443,7 +442,7 @@ class _run_decorator:  # noqa: N801
                     settings = getattr(self, "_settings", None)
                     if settings and settings["strict"]:
                         wandb.termerror(message, repeat=False)
-                        raise errors.UnsupportedError(
+                        raise UnsupportedError(
                             f"`{func.__name__}` does not support multiprocessing"
                         )
                     wandb.termwarn(message, repeat=False)
@@ -633,7 +632,7 @@ class Run:
 
         _datatypes_set_callback(self._datatypes_callback)
 
-        self._printer = printer.get_printer(self._settings._jupyter)
+        self._printer = printer.new_printer()
         self._wl = None
         self._reporter: Reporter | None = None
 
@@ -1158,7 +1157,7 @@ class Run:
 
         By default, it walks the current directory and logs all files that end with `.py`.
 
-        Arguments:
+        Args:
             root: The relative (to `os.getcwd()`) or absolute path to recursively find code from.
             name: (str, optional) The name of our code artifact. By default, we'll name
                 the artifact `source-$PROJECT_ID-$ENTRYPOINT_RELPATH`. There may be scenarios where you want
@@ -1415,7 +1414,7 @@ class Run:
             if is_id:
                 artifact = Artifact._from_id(artifact_string, public_api._client)
             else:
-                artifact = public_api.artifact(name=artifact_string)
+                artifact = public_api._artifact(name=artifact_string)
             # in the future we'll need to support using artifacts from
             # different instances of wandb.
 
@@ -1473,36 +1472,27 @@ class Run:
     def _visualization_hack(self, row: dict[str, Any]) -> dict[str, Any]:
         # TODO(jhr): move visualize hack somewhere else
         chart_keys = set()
-        split_table_set = set()
-        for k in row:
-            if isinstance(row[k], Visualize):
-                key = row[k].get_config_key(k)
-                value = row[k].get_config_value(k)
-                row[k] = row[k]._data
-                self._config_callback(val=value, key=key)
-            elif isinstance(row[k], CustomChart):
+        for k, v in row.items():
+            if isinstance(v, Visualize):
+                row[k] = v.table
+                v.set_key(k)
+                self._config_callback(
+                    val=v.spec.config_value,
+                    key=v.spec.config_key,
+                )
+            elif isinstance(v, CustomChart):
                 chart_keys.add(k)
-                key = row[k].get_config_key(k)
-                if row[k]._split_table:
-                    value = row[k].get_config_value(
-                        "Vega2", row[k].user_query(f"Custom Chart Tables/{k}_table")
-                    )
-                    split_table_set.add(k)
-                else:
-                    value = row[k].get_config_value(
-                        "Vega2", row[k].user_query(f"{k}_table")
-                    )
-                row[k] = row[k]._data
-                self._config_callback(val=value, key=key)
+                v.set_key(k)
+                self._config_callback(
+                    key=v.spec.config_key,
+                    val=v.spec.config_value,
+                )
 
         for k in chart_keys:
             # remove the chart key from the row
-            # TODO: is this really the right move? what if the user logs
-            #     a non-custom chart to this key?
-            if k in split_table_set:
-                row[f"Custom Chart Tables/{k}_table"] = row.pop(k)
-            else:
-                row[f"{k}_table"] = row.pop(k)
+            v = row.pop(k)
+            if isinstance(v, CustomChart):
+                row[v.spec.table_key] = v.table
         return row
 
     def _partial_history_callback(
@@ -1707,7 +1697,7 @@ class Run:
         [guides to logging](https://docs.wandb.ai/guides/track/log) for examples,
         from 3D molecular structures and segmentation masks to PR curves and histograms.
         You can use `wandb.Table` to log structured data. See our
-        [guide to logging tables](https://docs.wandb.ai/guides/data-vis/log-tables)
+        [guide to logging tables](https://docs.wandb.ai/guides/tables/tables-walkthrough)
         for details.
 
         The W&B UI organizes metrics with a forward slash (`/`) in their name
@@ -1770,7 +1760,7 @@ class Run:
         run.log({"accuracy": 0.9}, step=current_step)
         ```
 
-        Arguments:
+        Args:
             data: A `dict` with `str` keys and values that are serializable
                 Python objects including: `int`, `float` and `string`;
                 any of the `wandb.data_types`; lists, tuples and NumPy arrays
@@ -1923,7 +1913,7 @@ class Run:
         if self._settings._shared and step is not None:
             wandb.termwarn(
                 "In shared mode, the use of `wandb.log` with the step argument is not supported "
-                f"and will be ignored. Please refer to {wburls.get('wandb_define_metric')} "
+                f"and will be ignored. Please refer to {url_registry.url('define-metric')} "
                 "on how to customize your x-axis.",
                 repeat=False,
             )
@@ -1971,7 +1961,7 @@ class Run:
         Note: when given an absolute path or glob and no `base_path`, one
         directory level is preserved as in the example above.
 
-        Arguments:
+        Args:
             glob_str: A relative or absolute path or Unix glob.
             base_path: A path to use to infer a directory structure; see examples.
             policy: One of `live`, `now`, or `end`.
@@ -1998,9 +1988,7 @@ class Run:
         if isinstance(glob_str, bytes):
             # Preserved for backward compatibility: allow bytes inputs.
             glob_str = glob_str.decode("utf-8")
-        if isinstance(glob_str, str) and (
-            glob_str.startswith("gs://") or glob_str.startswith("s3://")
-        ):
+        if isinstance(glob_str, str) and (glob_str.startswith(("gs://", "s3://"))):
             # 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 []
@@ -2144,7 +2132,7 @@ class Run:
         This is used when creating multiple runs in the same process. We automatically
         call this method when your script exits or if you use the run context manager.
 
-        Arguments:
+        Args:
             exit_code: Set to something other than 0 to mark a run as failed
             quiet: Set to true to minimize log output
         """
@@ -2246,11 +2234,11 @@ class Run:
         data_table: Table,
         fields: dict[str, Any],
         string_fields: dict[str, Any] | None = None,
-        split_table: bool | None = False,
+        split_table: bool = False,
     ) -> CustomChart:
         """Create a custom plot on a table.
 
-        Arguments:
+        Args:
             vega_spec_name: the name of the spec for the plot
             data_table: a wandb.Table object containing the data to
                 be used on the visualization
@@ -2261,7 +2249,7 @@ class Run:
             split_table: a boolean that indicates whether the table should be in
                 a separate section in the UI
         """
-        return custom_chart(
+        return plot_table(
             vega_spec_name, data_table, fields, string_fields or {}, split_table
         )
 
@@ -2751,7 +2739,7 @@ class Run:
     ) -> wandb_metric.Metric:
         """Customize metrics logged with `wandb.log()`.
 
-        Arguments:
+        Args:
             name: The name of the metric to customize.
             step_metric: The name of another metric to serve as the X-axis
                 for this metric in automatically generated charts.
@@ -2977,10 +2965,10 @@ class Run:
 
         The linked artifact will be visible in the UI for the specified portfolio.
 
-        Arguments:
+        Args:
             artifact: the (public or local) artifact which will be linked
-            target_path: `str` - takes the following forms: {portfolio}, {project}/{portfolio},
-                or {entity}/{project}/{portfolio}
+            target_path: `str` - takes the following forms: `{portfolio}`, `{project}/{portfolio}`,
+                or `{entity}/{project}/{portfolio}`
             aliases: `List[str]` - optional alias(es) that will only be applied on this linked artifact
                                    inside the portfolio.
             The alias "latest" will always be applied to the latest version of an artifact that is linked.
@@ -3046,7 +3034,7 @@ class Run:
 
         Call `download` or `file` on the returned object to get the contents locally.
 
-        Arguments:
+        Args:
             artifact_or_name: (str or Artifact) An artifact name.
                 May be prefixed with project/ or entity/project/.
                 If no entity is specified in the name, the Run or API setting's entity is used.
@@ -3075,7 +3063,7 @@ class Run:
             else:
                 name = artifact_or_name
             public_api = self._public_api()
-            artifact = public_api.artifact(type=type, name=name)
+            artifact = public_api._artifact(type=type, name=name)
             if type is not None and type != artifact.type:
                 raise ValueError(
                     "Supplied type {} does not match type {} of artifact {}".format(
@@ -3155,7 +3143,7 @@ class Run:
     ) -> Artifact:
         """Declare an artifact as an output of a run.
 
-        Arguments:
+        Args:
             artifact_or_path: (str or Artifact) A path to the contents of this artifact,
                 can be in the following forms:
                     - `/local/directory`
@@ -3200,7 +3188,7 @@ class Run:
         Note that you must call run.finish_artifact() to finalize the artifact.
         This is useful when distributed jobs need to all contribute to the same artifact.
 
-        Arguments:
+        Args:
             artifact_or_path: (str or Artifact) A path to the contents of this artifact,
                 can be in the following forms:
                     - `/local/directory`
@@ -3253,7 +3241,7 @@ class Run:
 
         Subsequent "upserts" with the same distributed ID will result in a new version.
 
-        Arguments:
+        Args:
             artifact_or_path: (str or Artifact) A path to the contents of this artifact,
                 can be in the following forms:
                     - `/local/directory`
@@ -3442,7 +3430,7 @@ class Run:
     ) -> None:
         """Logs a model artifact containing the contents inside the 'path' to a run and marks it as an output to this run.
 
-        Arguments:
+        Args:
             path: (str) A path to the contents of this model,
                 can be in the following forms:
                     - `/local/directory`
@@ -3488,7 +3476,7 @@ class Run:
     def use_model(self, name: str) -> FilePathStr:
         """Download the files logged in a model artifact 'name'.
 
-        Arguments:
+        Args:
             name: (str) A model artifact name. 'name' must match the name of an existing logged
                 model artifact.
                 May be prefixed with entity/project/. Valid names
@@ -3558,7 +3546,7 @@ class Run:
             - Link version of model artifact 'name' to registered model, 'registered_model_name'.
             - Attach aliases from 'aliases' list to the newly linked model artifact version.
 
-        Arguments:
+        Args:
             path: (str) A path to the contents of this model,
                 can be in the following forms:
                     - `/local/directory`
@@ -3617,7 +3605,7 @@ class Run:
 
         public_api = self._public_api()
         try:
-            artifact = public_api.artifact(name=f"{name}:latest")
+            artifact = public_api._artifact(name=f"{name}:latest")
             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'."
@@ -3641,7 +3629,7 @@ class Run:
     ) -> None:
         """Launch an alert with the given title and text.
 
-        Arguments:
+        Args:
             title: (str) The title of the alert, must be less than 64 characters long.
             text: (str) The text body of the alert.
             level: (str or AlertLevel, optional) The alert level to use, either: `INFO`, `WARN`, or `ERROR`.
@@ -3815,7 +3803,7 @@ class Run:
 
                 # TODO(settings): make settings the source of truth
                 if not wandb.jupyter.quiet():  # type: ignore
-                    doc_html = printer.link(wburls.get("doc_run"), "docs")
+                    doc_html = printer.link(url_registry.url("developer-guide"), "docs")
 
                     project_html = printer.link(project_url, "Weights & Biases")
                     project_line = f"to {project_html} ({doc_html})"
@@ -4058,7 +4046,7 @@ class Run:
         printer.display(
             "The legacy backend is deprecated. In future versions, `wandb-core` will become "
             "the sole backend service, and the `wandb.require('legacy-service')` flag will be removed. "
-            "For more information, visit https://wandb.me/wandb-core",
+            f"For more information, visit {url_registry.url('wandb-core')}",
             level="warn",
         )
 
@@ -4103,7 +4091,7 @@ def restore(
     File is placed into the current directory or run directory.
     By default, will only download the file if it doesn't already exist.
 
-    Arguments:
+    Args:
         name: the name of the file
         run_path: optional path to a run to pull files from, i.e. `username/project_name/run_id`
             if wandb.init has not been called, this is required.
@@ -4161,7 +4149,7 @@ def finish(exit_code: int | None = None, quiet: bool | None = None) -> None:
     This is used when creating multiple runs in the same process.
     We automatically call this method when your script exits.
 
-    Arguments:
+    Args:
         exit_code: Set to something other than 0 to mark a run as failed
         quiet: Set to true to minimize log output
     """

wandb/sdk/wandb_settings.py

@@ -48,9 +48,8 @@ from wandb.sdk.lib._settings_toposort_generated import SETTINGS_TOPOLOGICALLY_SO
 from wandb.sdk.lib.run_moment import RunMoment
 from wandb.sdk.wandb_setup import _EarlyLogger
 
-from .lib import apikey
+from .lib import apikey, ipython
 from .lib.gitlib import GitRepo
-from .lib.ipython import _get_python_type
 from .lib.runid import generate_id
 
 if sys.version_info >= (3, 8):
@@ -690,11 +689,11 @@ class Settings(SettingsData):
             _internal_check_process={"value": 8, "preprocessor": float},
             _internal_queue_timeout={"value": 2, "preprocessor": float},
             _ipython={
-                "hook": lambda _: _get_python_type() == "ipython",
+                "hook": lambda _: ipython.in_ipython(),
                 "auto_hook": True,
             },
             _jupyter={
-                "hook": lambda _: _get_python_type() == "jupyter",
+                "hook": lambda _: ipython.in_jupyter(),
                 "auto_hook": True,
             },
             _kaggle={"hook": lambda _: util._is_likely_kaggle(), "auto_hook": True},

wandb/sdk/wandb_sync.py

@@ -1,7 +1,8 @@
 import pathlib
 from typing import TYPE_CHECKING, Optional
 
-from ..errors.term import termerror, termlog
+from wandb.errors.term import termerror, termlog
+
 from . import wandb_setup
 from .backend.backend import Backend
 from .lib.mailbox import Mailbox

wandb/util.py

@@ -84,7 +84,6 @@ _not_importable = set()
 
 MAX_LINE_BYTES = (10 << 20) - (100 << 10)  # imposed by back end
 IS_GIT = os.path.exists(os.path.join(os.path.dirname(__file__), "..", ".git"))
-RE_WINFNAMES = re.compile(r'[<>:"\\?*]')
 
 # From https://docs.docker.com/engine/reference/commandline/tag/
 # "Name components may contain lowercase letters, digits and separators.
@@ -881,6 +880,23 @@ def no_retry_4xx(e: Exception) -> bool:
     raise UsageError(body["errors"][0]["message"])
 
 
+def parse_backend_error_messages(response: requests.Response) -> List[str]:
+    errors: List[str] = []
+    try:
+        data = response.json()
+    except ValueError:
+        return errors
+
+    if "errors" in data and isinstance(data["errors"], list):
+        for error in data["errors"]:
+            # Our tests and potentially some api endpoints return a string error?
+            if isinstance(error, str):
+                error = {"message": error}
+            if "message" in error:
+                errors.append(error["message"])
+    return errors
+
+
 def no_retry_auth(e: Any) -> bool:
     if hasattr(e, "exception"):
         e = e.exception
@@ -894,7 +910,9 @@ def no_retry_auth(e: Any) -> bool:
     # Retry all non-forbidden/unauthorized/not-found errors.
     if e.response.status_code not in (401, 403, 404):
         return True
-    # Crash w/message on forbidden/unauthorized errors.
+
+    # Crash with more informational message on forbidden/unauthorized errors.
+    # UnauthorizedError
     if e.response.status_code == 401:
         raise AuthenticationError(
             "The API key you provided is either invalid or missing.  "
@@ -904,15 +922,29 @@ def no_retry_auth(e: Any) -> bool:
             "If you're not sure, you can try logging in again using the 'wandb login --relogin --host [hostname]' command."
             f"(Error {e.response.status_code}: {e.response.reason})"
         )
-    elif wandb.run:
-        raise CommError(f"Permission denied to access {wandb.run.path}")
-    else:
-        raise CommError(
-            "It appears that you do not have permission to access the requested resource. "
-            "Please reach out to the project owner to grant you access. "
-            "If you have the correct permissions, verify that there are no issues with your networking setup."
-            f"(Error {e.response.status_code}: {e.response.reason})"
-        )
+    # ForbiddenError
+    if e.response.status_code == 403:
+        if wandb.run:
+            raise CommError(f"Permission denied to access {wandb.run.path}")
+        else:
+            raise CommError(
+                "It appears that you do not have permission to access the requested resource. "
+                "Please reach out to the project owner to grant you access. "
+                "If you have the correct permissions, verify that there are no issues with your networking setup."
+                f"(Error {e.response.status_code}: {e.response.reason})"
+            )
+
+    # NotFoundError
+    if e.response.status_code == 404:
+        # If error message is empty, raise a more generic NotFoundError message.
+        if parse_backend_error_messages(e.response):
+            return False
+        else:
+            raise LookupError(
+                f"Failed to find resource. Please make sure you have the correct resource path. "
+                f"(Error {e.response.status_code}: {e.response.reason})"
+            )
+    return False
 
 
 def check_retry_conflict(e: Any) -> Optional[bool]:
@@ -956,7 +988,7 @@ def make_check_retry_fn(
 ) -> CheckRetryFnType:
     """Return a check_retry_fn which can be used by lib.Retry().
 
-    Arguments:
+    Args:
         fallback_fn: Use this function if check_fn didn't decide if a retry should happen.
         check_fn: Function which returns bool if retry should happen or None if unsure.
         check_timedelta: Optional retry timeout if we check_fn matches the exception
@@ -978,7 +1010,7 @@ def make_check_retry_fn(
 def find_runner(program: str) -> Union[None, list, List[str]]:
     """Return a command that will run program.
 
-    Arguments:
+    Args:
         program: The string name of the program to try to run.
 
     Returns:
@@ -1283,7 +1315,7 @@ def prompt_choices(
 def guess_data_type(shape: Sequence[int], risky: bool = False) -> Optional[str]:
     """Infer the type of data based on the shape of the tensors.
 
-    Arguments:
+    Args:
         shape (Sequence[int]): The shape of the data
         risky(bool): some guesses are more likely to be wrong.
     """
@@ -1563,10 +1595,6 @@ def _is_py_requirements_or_dockerfile(path: str) -> bool:
     )
 
 
-def check_windows_valid_filename(path: Union[int, str]) -> bool:
-    return not bool(re.search(RE_WINFNAMES, path))  # type: ignore
-
-
 def artifact_to_json(artifact: "Artifact") -> Dict[str, Any]:
     return {
         "_type": "artifactVersion",

wandb/wandb_agent.py

@@ -19,6 +19,7 @@ from wandb import util, wandb_lib, wandb_sdk
 from wandb.agents.pyagent import pyagent
 from wandb.apis import InternalApi
 from wandb.sdk.launch.sweeps import utils as sweep_utils
+from wandb.sdk.lib import ipython
 
 logger = logging.getLogger(__name__)
 
@@ -546,7 +547,7 @@ def agent(
     is a part of, what function to execute, and (optionally) how
     many agents to run.
 
-    Arguments:
+    Args:
         sweep_id: The unique identifier for a sweep. A sweep ID
             is generated by W&B CLI or Python SDK.
         function: A function to call instead of the "program"
@@ -568,11 +569,10 @@ def agent(
         wandb_sdk.wandb_login._login(_silent=True)
         if function:
             return pyagent(sweep_id, function, entity, project, count)
-        in_jupyter = wandb.wandb_sdk.lib.ipython._get_python_type() != "python"
         return run_agent(
             sweep_id,
             function=function,
-            in_jupyter=in_jupyter,
+            in_jupyter=ipython.in_jupyter(),
             entity=entity,
             project=project,
             count=count,

wandb/wandb_controller.py

@@ -88,8 +88,6 @@ def _id_generator(size=10, chars=string.ascii_lowercase + string.digits):
 class ControllerError(Exception):
     """Base class for sweep errors."""
 
-    pass
-
 
 class _WandbController:
     """Sweep controller class.
@@ -309,6 +307,8 @@ class _WandbController:
             self._create["parameters"][name]["value"] = value
         if values is not None:
             self._create["parameters"][name]["values"] = values
+        if distribution is not None:
+            self._create["parameters"][name]["distribution"] = distribution
         if min is not None:
             self._create["parameters"][name]["min"] = min
         if max is not None:

{wandb-0.18.5.dist-info → wandb-0.18.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: wandb
-Version: 0.18.5
+Version: 0.18.6
 Summary: A CLI and library for interacting with the Weights & Biases API.
 Project-URL: Source, https://github.com/wandb/wandb
 Project-URL: Bug Reports, https://github.com/wandb/wandb/issues