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

wandb/apis/reports/v1/_blocks.py

@@ -716,16 +716,12 @@ class WeaveBlockSummaryTable(Block):
             "fromOp"
         ]["inputs"]["run"]["fromOp"]["inputs"]["project"]["fromOp"]["inputs"][
             "entityName"
-        ][
-            "val"
-        ]
+        ]["val"]
         project = spec["config"]["panelConfig"]["exp"]["fromOp"]["inputs"]["obj"][
             "fromOp"
         ]["inputs"]["run"]["fromOp"]["inputs"]["project"]["fromOp"]["inputs"][
             "projectName"
-        ][
-            "val"
-        ]
+        ]["val"]
         table_name = spec["config"]["panelConfig"]["exp"]["fromOp"]["inputs"]["key"][
             "val"
         ]
@@ -1064,7 +1060,7 @@ class WeaveBlockArtifact(Block):
 
 
 class WeaveBlockArtifactVersionedFile(Block):
-    """This is a hacky solution to support the most common way of getting Weave artifact verions for now..."""
+    """This is a hacky solution to support the most common way of getting Weave artifact versions for now..."""
 
     entity: str = Attr()
     project: str = Attr()

wandb/apis/reports/v2/gql.py

@@ -1,4 +1,5 @@
 """GraphQL queries and mutations."""
+
 from wandb_gql import gql
 
 view_report = gql(

wandb/apis/reports/v2/interface.py

@@ -1,4 +1,5 @@
 """Public interfaces for the Report API."""
+
 import os
 from datetime import datetime
 from typing import Dict, Iterable, Optional, Tuple, Union
@@ -100,8 +101,7 @@ class Layout(Base):
 
 
 @dataclass(config=dataclass_config)
-class Block(Base):
-    ...
+class Block(Base): ...
 
 
 @dataclass(config=ConfigDict(validate_assignment=True, extra="allow", slots=True))
@@ -706,8 +706,7 @@ class Twitter(Block):
 
 
 @dataclass(config=dataclass_config)
-class WeaveBlock(Block):
-    ...
+class WeaveBlock(Block): ...
 
 
 BlockTypes = Union[

wandb/apis/reports/v2/internal.py

@@ -1,4 +1,5 @@
 """JSONSchema for internal types.  Hopefully this is auto-generated one day!"""
+
 import json
 import random
 from copy import deepcopy
@@ -102,16 +103,13 @@ class TextLikeMixin:
         return obj
 
 
-class Sentinel(BaseModel):
-    ...
+class Sentinel(BaseModel): ...
 
 
-class ReportEntity(Sentinel):
-    ...
+class ReportEntity(Sentinel): ...
 
 
-class ReportProject(Sentinel):
-    ...
+class ReportProject(Sentinel): ...
 
 
 class ReportAPIBaseModel(BaseModel):
@@ -271,8 +269,7 @@ class PanelGridMetadata(ReportAPIBaseModel):
     # )
 
 
-class Block(ReportAPIBaseModel):
-    ...
+class Block(ReportAPIBaseModel): ...
 
 
 class PanelGrid(Block):

wandb/cli/cli.py

@@ -30,10 +30,12 @@ import wandb
 import wandb.env
 
 # from wandb.old.core import wandb_dir
+import wandb.errors
 import wandb.sdk.verify.verify as wandb_verify
 from wandb import Config, Error, env, util, wandb_agent, wandb_sdk
 from wandb.apis import InternalApi, PublicApi
 from wandb.apis.public import RunQueue
+from wandb.errors import WandbCoreNotAvailableError
 from wandb.integration.magic import magic_install
 from wandb.sdk.artifacts.artifact_file_cache import get_artifact_file_cache
 from wandb.sdk.launch import utils as launch_utils
@@ -44,6 +46,7 @@ from wandb.sdk.launch.sweeps.scheduler import Scheduler
 from wandb.sdk.lib import filesystem
 from wandb.sdk.lib.wburls import wburls
 from wandb.sync import SyncManager, get_run_from_path, get_runs
+from wandb.util import get_core_path
 
 # Send cli logs to wandb/debug-cli.<username>.log by default and fallback to a temp dir.
 _wandb_dir = wandb.old.core.wandb_dir(env.get_dir())
@@ -430,14 +433,15 @@ def init(ctx, project, entity, reset, mode):
 def beta():
     """Beta versions of wandb CLI commands. Requires wandb-core."""
     # this is the future that requires wandb-core!
-    from wandb.util import get_core_path
+    wandb._sentry.configure_scope(process_context="wandb_beta")
+    wandb.require("core")
 
-    if not get_core_path():
+    try:
+        get_core_path()
+    except WandbCoreNotAvailableError as e:
+        wandb._sentry.exception(f"using `wandb beta`. failed with {e}")
         click.secho(
-            (
-                "wandb beta commands require wandb-core, please install with"
-                " `pip install wandb-core`"
-            ),
+            (e),
             fg="red",
             err=True,
         )
@@ -1307,7 +1311,15 @@ def launch_sweep(
 
 
 @cli.command(help=f"Launch or queue a W&B Job. See {wburls.get('cli_launch')}")
-@click.option("--uri", "-u", metavar="(str)", default=None, hidden=True)
+@click.option(
+    "--uri",
+    "-u",
+    metavar="(str)",
+    default=None,
+    hidden=True,
+    help="Local path or git repo uri to launch. If provided this command will "
+    "create a job from the specified uri.",
+)
 @click.option(
     "--job",
     "-j",
@@ -1332,6 +1344,20 @@ def launch_sweep(
     hidden=True,
     help="Version of the project to run, as a Git commit reference for Git projects.",
 )
+@click.option(
+    "--build-context",
+    metavar="(str)",
+    help="Path to the build context within the source code. Defaults to the "
+    "root of the source code. Compatible only with -u.",
+)
+@click.option(
+    "--job-name",
+    "-J",
+    metavar="(str)",
+    default=None,
+    hidden=True,
+    help="Name for the job created if the -u,--uri flag is passed in.",
+)
 @click.option(
     "--name",
     envvar="WANDB_NAME",
@@ -1456,6 +1482,7 @@ def launch(
     job,
     entry_point,
     git_version,
+    build_context,
     name,
     resource,
     entity,
@@ -1471,6 +1498,7 @@ def launch(
     project_queue,
     dockerfile,
     priority,
+    job_name,
 ):
     """Start a W&B run from the given URI.
 
@@ -1486,6 +1514,8 @@ def launch(
         f"=== Launch called with kwargs {locals()} CLI Version: {wandb.__version__}==="
     )
     from wandb.sdk.launch._launch import _launch
+    from wandb.sdk.launch.create_job import _create_job
+    from wandb.sdk.launch.utils import _is_git_uri
 
     api = _get_cling_api()
     wandb._sentry.configure_scope(process_context="launch_cli")
@@ -1532,6 +1562,36 @@ def launch(
 
     run_id = config.get("run_id")
 
+    # If URI was provided, we need to create a job from it.
+    if uri:
+        if entry_point is None:
+            raise LaunchError(
+                "Cannot provide a uri without an entry point. Please provide an "
+                "entry point with --entry-point or -E."
+            )
+        if job is not None:
+            raise LaunchError("Cannot provide both a uri and a job name.")
+        job_type = (
+            "git" if _is_git_uri(uri) else "code"
+        )  # TODO: Add support for local URIs with git.
+        if entity is None:
+            entity = launch_utils.get_default_entity(api, config)
+        artifact, _, _ = _create_job(
+            api,
+            job_type,
+            uri,
+            entrypoint=" ".join(entry_point),
+            git_hash=git_version,
+            name=job_name,
+            project=project,
+            build_context=build_context,
+            dockerfile=dockerfile,
+            entity=entity,
+        )
+        if artifact is None:
+            raise LaunchError(f"Failed to create job from uri: {uri}")
+        job = f"{entity}/{project}/{artifact.name}"
+
     if dockerfile:
         if "overrides" in config:
             config["overrides"]["dockerfile"] = dockerfile
@@ -1565,7 +1625,6 @@ def launch(
             run = asyncio.run(
                 _launch(
                     api,
-                    uri,
                     job,
                     project=project,
                     entity=entity,
@@ -1602,7 +1661,6 @@ def launch(
         try:
             _launch_add(
                 api,
-                uri,
                 job,
                 config,
                 template_variables,
@@ -1641,13 +1699,6 @@ def launch(
     metavar="<queue(s)>",
     help="The name of a queue for the agent to watch. Multiple -q flags supported.",
 )
-@click.option(
-    "--project",
-    "-p",
-    default=None,
-    help="""Name of the project which the agent will watch.
-    If passed in, will override the project value passed in using a config file.""",
-)
 @click.option(
     "--entity",
     "-e",
@@ -1684,7 +1735,6 @@ def launch(
 @display_error
 def launch_agent(
     ctx,
-    project=None,
     entity=None,
     queues=None,
     max_jobs=None,
@@ -1709,7 +1759,7 @@ def launch_agent(
     api = _get_cling_api()
     wandb._sentry.configure_scope(process_context="launch_agent")
     agent_config, api = _launch.resolve_agent_config(
-        entity, project, max_jobs, queues, config, verbose
+        entity, max_jobs, queues, config, verbose
     )
 
     if len(agent_config.get("queues")) == 0:
@@ -1907,14 +1957,16 @@ def describe(job):
     "--entry-point",
     "-E",
     "entrypoint",
-    help="Entrypoint to the script, including an executable and an entrypoint file. Required for code or repo jobs",
+    help="Entrypoint to the script, including an executable and an entrypoint "
+    "file. Required for code or repo jobs. If --build-context is provided, "
+    "paths in the entrypoint command will be relative to the build context.",
 )
 @click.option(
     "--git-hash",
     "-g",
     "git_hash",
     type=str,
-    help="Hash to a specific git commit.",
+    help="Commit reference to use as the source for git jobs",
 )
 @click.option(
     "--runtime",
@@ -1922,6 +1974,20 @@ def describe(job):
     type=str,
     help="Python runtime to execute the job",
 )
+@click.option(
+    "--build-context",
+    "-b",
+    type=str,
+    help="Path to the build context from the root of the job source code. If "
+    "provided, this is used as the base path for the Dockerfile and entrypoint.",
+)
+@click.option(
+    "--dockerfile",
+    "-D",
+    type=str,
+    help="Path to the Dockerfile for the job. If --build-context is provided, "
+    "the Dockerfile path will be relative to the build context.",
+)
 @click.argument(
     "job_type",
     type=click.Choice(("git", "code", "image")),
@@ -1938,6 +2004,8 @@ def create(
     entrypoint,
     git_hash,
     runtime,
+    build_context,
+    dockerfile,
 ):
     """Create a job from a source, without a wandb run.
 
@@ -1980,6 +2048,8 @@ def create(
         entrypoint=entrypoint,
         git_hash=git_hash,
         runtime=runtime,
+        build_context=build_context,
+        dockerfile=dockerfile,
     )
     if not artifact:
         wandb.termerror("Job creation failed")
@@ -2188,7 +2258,7 @@ def docker(
         if cmd:
             command.extend(["-e", "WANDB_COMMAND=%s" % cmd])
         command.extend(["-it", image, shell])
-        wandb.termlog("Launching docker container \U0001F6A2")
+        wandb.termlog("Launching docker container \U0001f6a2")
     subprocess.call(command)
 
 
@@ -2306,7 +2376,7 @@ def start(ctx, port, env, daemon, upgrade, edge):
             )
             exit(1)
         else:
-            wandb.termlog("W&B server started at http://localhost:%s \U0001F680" % port)
+            wandb.termlog("W&B server started at http://localhost:%s \U0001f680" % port)
             wandb.termlog("You can stop the server by running `wandb server stop`")
             if not api.api_key:
                 # Let the server start before potentially launching a browser

wandb/data_types.py

@@ -191,7 +191,7 @@ class Table(Media):
     ):
         """Initializes a Table object.
 
-        The rows is availble for legacy reasons and should not be used.
+        The rows is available for legacy reasons and should not be used.
         The Table class uses data to mimic the Pandas API.
         """
         super().__init__()
@@ -280,7 +280,10 @@ class Table(Media):
             self.cast(col_name, dt, opt)
 
     def cast(self, col_name, dtype, optional=False):
-        """Casts a column to a specific data type. This can be one of the normal python classes, an internal W&B type, or an example objec, like an instance of wandb.Image or wandb.Classes.
+        """Casts a column to a specific data type.
+
+        This can be one of the normal python classes, an internal W&B type, or an
+        example object, like an instance of wandb.Image or wandb.Classes.
 
         Arguments:
             col_name: (str) - The name of the column to cast.
@@ -513,9 +516,9 @@ class Table(Media):
                     deserialized = np.load(
                         source_artifact.get_entry(serialization_path["path"]).download()
                     )
-                    np_deserialized_columns[
-                        json_obj["columns"].index(col_name)
-                    ] = deserialized[serialization_path["key"]]
+                    np_deserialized_columns[json_obj["columns"].index(col_name)] = (
+                        deserialized[serialization_path["key"]]
+                    )
                     ndarray_type._clear_serialization_path()
 
         for r_ndx, row in enumerate(json_obj["data"]):
@@ -763,7 +766,7 @@ class Table(Media):
 
         Arguments:
             name: (str) - the unique name of the column
-            data: (list | np.array) - a column of homogenous data
+            data: (list | np.array) - a column of homogeneous data
             optional: (bool) - if null-like values are permitted
         """
         assert isinstance(name, str) and name not in self.columns

wandb/docker/__init__.py

@@ -289,7 +289,7 @@ def image_id_from_registry(image_name: str) -> Optional[str]:
 
 
 def image_id(image_name: str) -> Optional[str]:
-    """Retreve the image id from the local docker daemon or remote registry."""
+    """Retrieve the image id from the local docker daemon or remote registry."""
     if "@sha256:" in image_name:
         return image_name
     else:

wandb/env.py

@@ -13,11 +13,10 @@ these values in many cases.
 import json
 import os
 import sys
-from distutils.util import strtobool
 from pathlib import Path
 from typing import List, MutableMapping, Optional, Union
 
-import appdirs  # type: ignore
+import platformdirs  # type: ignore
 
 Env = Optional[MutableMapping]
 
@@ -61,6 +60,8 @@ SAVE_CODE = "WANDB_SAVE_CODE"
 TAGS = "WANDB_TAGS"
 IGNORE = "WANDB_IGNORE_GLOBS"
 ERROR_REPORTING = "WANDB_ERROR_REPORTING"
+CORE_ERROR_REPORTING = "WANDB_CORE_ERROR_REPORTING"
+CORE_DEBUG = "WANDB_CORE_DEBUG"
 DOCKER = "WANDB_DOCKER"
 AGENT_REPORT_INTERVAL = "WANDB_AGENT_REPORT_INTERVAL"
 AGENT_KILL_DELAY = "WANDB_AGENT_KILL_DELAY"
@@ -87,6 +88,7 @@ _EXECUTABLE = "WANDB_EXECUTABLE"
 LAUNCH_QUEUE_NAME = "WANDB_LAUNCH_QUEUE_NAME"
 LAUNCH_QUEUE_ENTITY = "WANDB_LAUNCH_QUEUE_ENTITY"
 LAUNCH_TRACE_ID = "WANDB_LAUNCH_TRACE_ID"
+_REQUIRE_CORE = "WANDB__REQUIRE_CORE"
 
 # For testing, to be removed in future version
 USE_V1_ARTIFACTS = "_WANDB_USE_V1_ARTIFACTS"
@@ -139,11 +141,16 @@ def _env_as_bool(
     if env is None:
         env = os.environ
     val = env.get(var, default)
+    if not isinstance(val, str):
+        return False
     try:
-        val = bool(strtobool(val))  # type: ignore
-    except (AttributeError, ValueError):
-        pass
-    return val if isinstance(val, bool) else False
+        return strtobool(val)
+    except ValueError:
+        return False
+
+
+def is_require_core(env: Optional[Env] = None) -> bool:
+    return _env_as_bool(_REQUIRE_CORE, default="False", env=env)
 
 
 def is_debug(default: Optional[str] = None, env: Optional[Env] = None) -> bool:
@@ -154,6 +161,14 @@ def error_reporting_enabled() -> bool:
     return _env_as_bool(ERROR_REPORTING, default="True")
 
 
+def core_error_reporting_enabled(default: Optional[str] = None) -> bool:
+    return _env_as_bool(CORE_ERROR_REPORTING, default=default)
+
+
+def core_debug(default: Optional[str] = None) -> bool:
+    return _env_as_bool(CORE_DEBUG, default=default)
+
+
 def ssl_disabled() -> bool:
     return _env_as_bool(DISABLE_SSL, default="False")
 
@@ -370,7 +385,7 @@ def get_magic(
 
 
 def get_data_dir(env: Optional[Env] = None) -> str:
-    default_dir = appdirs.user_data_dir("wandb")
+    default_dir = platformdirs.user_data_dir("wandb")
     if env is None:
         env = os.environ
     val = env.get(DATA_DIR, default_dir)
@@ -395,7 +410,7 @@ def get_artifact_fetch_file_url_batch_size(env: Optional[Env] = None) -> int:
 
 def get_cache_dir(env: Optional[Env] = None) -> Path:
     env = env or os.environ
-    return Path(env.get(CACHE_DIR, appdirs.user_cache_dir("wandb")))
+    return Path(env.get(CACHE_DIR, platformdirs.user_cache_dir("wandb")))
 
 
 def get_use_v1_artifacts(env: Optional[Env] = None) -> bool:
@@ -464,3 +479,18 @@ def get_launch_trace_id(env: Optional[Env] = None) -> Optional[str]:
         env = os.environ
     val = env.get(LAUNCH_TRACE_ID, None)
     return val
+
+
+def strtobool(val: str) -> bool:
+    """Convert a string representation of truth to true or false.
+
+    Copied from distutils. distutils was removed in Python 3.12.
+    """
+    val = val.lower()
+
+    if val in ("y", "yes", "t", "true", "on", "1"):
+        return True
+    elif val in ("n", "no", "f", "false", "off", "0"):
+        return False
+    else:
+        raise ValueError(f"invalid truth value {val!r}")

wandb/errors/__init__.py

@@ -4,6 +4,7 @@ __all__ = [
     "AuthenticationError",
     "UsageError",
     "UnsupportedError",
+    "WandbCoreNotAvailableError",
 ]
 
 from typing import Optional
@@ -39,3 +40,7 @@ class UsageError(Error):
 
 class UnsupportedError(UsageError):
     """Raised when trying to use a feature that is not supported."""
+
+
+class WandbCoreNotAvailableError(Error):
+    """Raised when wandb core is not available."""

wandb/errors/term.py

@@ -27,7 +27,10 @@ def termsetup(settings, logger) -> None:
 
 
 def termlog(
-    string: str = "", newline: bool = True, repeat: bool = True, prefix: bool = True
+    string: str = "",
+    newline: bool = True,
+    repeat: bool = True,
+    prefix: bool = True,
 ) -> None:
     """Log to standard error with formatting.
 
@@ -68,7 +71,12 @@ def termerror(string: str, **kwargs: Any) -> None:
 
 
 def _log(
-    string="", newline=True, repeat=True, prefix=True, silent=False, level=logging.INFO
+    string="",
+    newline=True,
+    repeat=True,
+    prefix=True,
+    silent=False,
+    level=logging.INFO,
 ):
     global _logger
     silent = silent or _silent

wandb/filesync/step_checksum.py

@@ -17,7 +17,7 @@ if TYPE_CHECKING:
 
     from wandb.filesync import stats
     from wandb.sdk.artifacts.artifact_manifest import ArtifactManifest
-    from wandb.sdk.artifacts.artifact_saver import SaveFn, SaveFnAsync
+    from wandb.sdk.artifacts.artifact_saver import SaveFn
     from wandb.sdk.internal import internal_api
 
 
@@ -31,7 +31,6 @@ class RequestStoreManifestFiles(NamedTuple):
     manifest: "ArtifactManifest"
     artifact_id: str
     save_fn: "SaveFn"
-    save_fn_async: "SaveFnAsync"
 
 
 class RequestCommitArtifact(NamedTuple):
@@ -96,7 +95,6 @@ class StepChecksum:
                         req.copy,
                         None,
                         None,
-                        None,
                     )
                 )
             elif isinstance(req, RequestStoreManifestFiles):
@@ -115,7 +113,6 @@ class StepChecksum:
                                 entry.digest,
                                 False,
                                 functools.partial(req.save_fn, entry),
-                                functools.partial(req.save_fn_async, entry),
                                 entry.digest,
                             )
                         )

wandb/filesync/step_prepare.py

@@ -1,7 +1,5 @@
 """Batching file prepare requests to our API."""
 
-import asyncio
-import functools
 import queue
 import threading
 import time
@@ -29,10 +27,7 @@ if TYPE_CHECKING:
 # Request for a file to be prepared.
 class RequestPrepare(NamedTuple):
     file_spec: "CreateArtifactFileSpecInput"
-    response_channel: Union[
-        "queue.Queue[ResponsePrepare]",
-        Tuple["asyncio.AbstractEventLoop", "asyncio.Future[ResponsePrepare]"],
-    ]
+    response_channel: "queue.Queue[ResponsePrepare]"
 
 
 class RequestFinish(NamedTuple):
@@ -110,7 +105,7 @@ def prepare_response(response: "CreateArtifactFilesResponseFile") -> ResponsePre
 class StepPrepare:
     """A thread that batches requests to our file prepare API.
 
-    Any number of threads may call prepare_async() in parallel. The PrepareBatcher thread
+    Any number of threads may call prepare() in parallel. The PrepareBatcher thread
     will batch requests up and send them all to the backend at once.
     """
 
@@ -145,11 +140,7 @@ class StepPrepare:
                     name = prepare_request.file_spec["name"]
                     response_file = batch_response[name]
                     response = prepare_response(response_file)
-                    if isinstance(prepare_request.response_channel, queue.Queue):
-                        prepare_request.response_channel.put(response)
-                    else:
-                        loop, future = prepare_request.response_channel
-                        loop.call_soon_threadsafe(future.set_result, response)
+                    prepare_request.response_channel.put(response)
             if finish:
                 break
 
@@ -167,18 +158,7 @@ class StepPrepare:
         """
         return self._api.create_artifact_files([req.file_spec for req in batch])
 
-    def prepare_async(
-        self, file_spec: "CreateArtifactFileSpecInput"
-    ) -> "asyncio.Future[ResponsePrepare]":
-        """Request the backend to prepare a file for upload."""
-        response: asyncio.Future[ResponsePrepare] = asyncio.Future()
-        self._request_queue.put(
-            RequestPrepare(file_spec, (asyncio.get_event_loop(), response))
-        )
-        return response
-
-    @functools.wraps(prepare_async)
-    def prepare_sync(
+    def prepare(
         self, file_spec: "CreateArtifactFileSpecInput"
     ) -> "queue.Queue[ResponsePrepare]":
         response_queue: queue.Queue[ResponsePrepare] = queue.Queue()