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

package_readme.md

@@ -0,0 +1,95 @@
+<div align="center">
+  <img src="https://i.imgur.com/RUtiVzH.png" width="600" /><br><br>
+</div>
+
+# Weights and Biases [![PyPI](https://img.shields.io/pypi/v/wandb)](https://pypi.python.org/pypi/wandb) [![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/wandb)](https://anaconda.org/conda-forge/wandb) [![CircleCI](https://img.shields.io/circleci/build/github/wandb/wandb/main)](https://circleci.com/gh/wandb/wandb) [![Codecov](https://img.shields.io/codecov/c/gh/wandb/wandb)](https://codecov.io/gh/wandb/wandb)
+
+Use W&B to build better models faster. Track and visualize all the pieces of your machine learning pipeline, from datasets to production models.
+
+- Quickly identify model regressions. Use W&B to visualize results in real time, all in a central dashboard.
+- Focus on the interesting ML. Spend less time manually tracking results in spreadsheets and text files.
+- Capture dataset versions with W&B Artifacts to identify how changing data affects your resulting models.
+- Reproduce any model, with saved code, hyperparameters, launch commands, input data, and resulting model weights.
+
+[Sign up for a free account →](https://wandb.ai/login?signup=true)
+
+## Features
+
+-   Store hyper-parameters used in a training run
+-   Search, compare, and visualize training runs
+-   Analyze system usage metrics alongside runs
+-   Collaborate with team members
+-   Replicate historic results
+-   Run parameter sweeps
+-   Keep records of experiments available forever
+
+[Documentation →](https://docs.wandb.com)
+
+## Quickstart
+
+```shell
+pip install wandb
+```
+
+In your training script:
+
+```python
+import wandb
+
+# Your custom arguments defined here
+args = ...
+
+wandb.init(config=args, project="my-project")
+wandb.config["more"] = "custom"
+
+
+def training_loop():
+    while True:
+        # Do some machine learning
+        epoch, loss, val_loss = ...
+        # Framework agnostic / custom metrics
+        wandb.log({"epoch": epoch, "loss": loss, "val_loss": val_loss})
+```
+
+If you're already using Tensorboard or [TensorboardX](https://github.com/lanpa/tensorboardX), you can integrate with one line:
+
+```python
+wandb.init(sync_tensorboard=True)
+```
+
+## Running your script
+
+Run `wandb login` from your terminal to signup or authenticate your machine (we store your api key in ~/.netrc). You can also set the `WANDB_API_KEY` environment variable with a key from your [settings](https://app.wandb.ai/settings).
+
+Run your script with `python my_script.py` and all metadata will be synced to the cloud. You will see a url in your terminal logs when your script starts and finishes. Data is staged locally in a directory named _wandb_ relative to your script. If you want to test your script without syncing to the cloud you can set the environment variable `WANDB_MODE=dryrun`.
+
+If you are using [docker](https://docker.com) to run your code, we provide a wrapper command `wandb docker` that mounts your current directory, sets environment variables, and ensures the wandb library is installed. Training your models in docker gives you the ability to restore the exact code and environment with the `wandb restore` command.
+
+## Web Interface
+
+[Sign up for a free account →](https://wandb.com)
+[![Watch the video](https://i.imgur.com/PW0Ejlc.png)](https://youtu.be/EeqhOSvNX-A)
+[Introduction video →](https://youtu.be/EeqhOSvNX-A)
+
+## Detailed Usage
+
+Framework specific and detailed usage can be found in our [documentation](http://docs.wandb.com/).
+
+## Testing
+
+To run basic test use `make test`.  More detailed information can be found at CONTRIBUTING.md.
+
+We use [circleci](https://circleci.com) for CI.
+
+# Academic Researchers
+If you'd like a free academic account for your research group, [reach out to us →](https://www.wandb.com/academic)
+
+We make it easy to cite W&B in your published paper. [Learn more →](https://www.wandb.com/academic)
+[![](https://i.imgur.com/loKLiez.png)](https://www.wandb.com/academic)
+
+## Community
+Got questions, feedback or want to join a community of ML engineers working on exciting projects?
+
+<a href="https://bit.ly/wb-slack"><img src="https://svgshare.com/i/M93.svg" alt="slack" width="55"/></a> Join our [slack](https://bit.ly/wb-slack) community.
+
+[![Twitter](https://img.shields.io/twitter/follow/weights_biases?style=social)](https://twitter.com/weights_biases) Follow us on [Twitter](https://twitter.com/weights_biases).

wandb/__init__.py

@@ -11,8 +11,8 @@ For scripts and interactive notebooks, see https://github.com/wandb/examples.
 
 For reference documentation, see https://docs.wandb.com/ref/python.
 """
-__version__ = "0.16.5"
-_minimum_core_version = "0.17.0b10"
+__version__ = "0.17.0"
+
 
 # Used with pypi checks and other messages related to pip
 _wandb_module = "wandb"
@@ -85,7 +85,6 @@ from wandb.wandb_agent import agent
 # from wandb.core import *
 from wandb.viz import visualize
 from wandb import plot
-from wandb import plots  # deprecating this
 from wandb.integration.sagemaker import sagemaker_auth
 from wandb.sdk.internal import profiler
 

wandb/agents/pyagent.py

@@ -4,7 +4,6 @@ Manage wandb agent.
 
 """
 
-
 import ctypes
 import logging
 import os

wandb/analytics/sentry.py

@@ -137,7 +137,8 @@ class Sentry:
         self.mark_session(status=status)
 
         client, _ = self.hub._stack[-1]  # type: ignore
-        client.flush()
+        if client is not None:
+            client.flush()
 
         return None
 

wandb/apis/importers/internals/internal.py

@@ -323,7 +323,6 @@ def _make_settings(
         "_sync": True,
         "_live_policy_rate_limit": 15,  # matches dir_watcher
         "_live_policy_wait_time": 600,  # matches dir_watcher
-        "_async_upload_concurrency_limit": None,
         "_file_stream_timeout_seconds": 60,
     }
 

wandb/apis/importers/internals/protocols.py

@@ -17,20 +17,15 @@ Policy = Literal["now", "end", "live"]
 
 @runtime_checkable
 class ImporterRun(Protocol):
-    def run_id(self) -> str:
-        ...  # pragma: no cover
+    def run_id(self) -> str: ...  # pragma: no cover
 
-    def entity(self) -> str:
-        ...  # pragma: no cover
+    def entity(self) -> str: ...  # pragma: no cover
 
-    def project(self) -> str:
-        ...  # pragma: no cover
+    def project(self) -> str: ...  # pragma: no cover
 
-    def config(self) -> Dict[str, Any]:
-        ...  # pragma: no cover
+    def config(self) -> Dict[str, Any]: ...  # pragma: no cover
 
-    def summary(self) -> Dict[str, float]:
-        ...  # pragma: no cover
+    def summary(self) -> Dict[str, float]: ...  # pragma: no cover
 
     def metrics(self) -> Iterable[Dict[str, float]]:
         """Metrics for the run.
@@ -55,71 +50,50 @@ class ImporterRun(Protocol):
         """
         ...  # pragma: no cover
 
-    def run_group(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def run_group(self) -> Optional[str]: ...  # pragma: no cover
 
-    def job_type(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def job_type(self) -> Optional[str]: ...  # pragma: no cover
 
-    def display_name(self) -> str:
-        ...  # pragma: no cover
+    def display_name(self) -> str: ...  # pragma: no cover
 
-    def notes(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def notes(self) -> Optional[str]: ...  # pragma: no cover
 
-    def tags(self) -> Optional[List[str]]:
-        ...  # pragma: no cover
+    def tags(self) -> Optional[List[str]]: ...  # pragma: no cover
 
-    def artifacts(self) -> Optional[Iterable[Artifact]]:
-        ...  # pragma: no cover
+    def artifacts(self) -> Optional[Iterable[Artifact]]: ...  # pragma: no cover
 
-    def used_artifacts(self) -> Optional[Iterable[Artifact]]:
-        ...  # pragma: no cover
+    def used_artifacts(self) -> Optional[Iterable[Artifact]]: ...  # pragma: no cover
 
-    def os_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def os_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def python_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def python_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def cuda_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def cuda_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def program(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def program(self) -> Optional[str]: ...  # pragma: no cover
 
-    def host(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def host(self) -> Optional[str]: ...  # pragma: no cover
 
-    def username(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def username(self) -> Optional[str]: ...  # pragma: no cover
 
-    def executable(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def executable(self) -> Optional[str]: ...  # pragma: no cover
 
-    def gpus_used(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def gpus_used(self) -> Optional[str]: ...  # pragma: no cover
 
-    def cpus_used(self) -> Optional[int]:
-        ...  # pragma: no cover
+    def cpus_used(self) -> Optional[int]: ...  # pragma: no cover
 
-    def memory_used(self) -> Optional[int]:
-        ...  # pragma: no cover
+    def memory_used(self) -> Optional[int]: ...  # pragma: no cover
 
-    def runtime(self) -> Optional[int]:
-        ...  # pragma: no cover
+    def runtime(self) -> Optional[int]: ...  # pragma: no cover
 
-    def start_time(self) -> Optional[int]:
-        ...  # pragma: no cover
+    def start_time(self) -> Optional[int]: ...  # pragma: no cover
 
-    def code_path(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def code_path(self) -> Optional[str]: ...  # pragma: no cover
 
-    def cli_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def cli_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def files(self) -> Optional[Iterable[Tuple[PathStr, Policy]]]:
-        ...  # pragma: no cover
+    def files(
+        self,
+    ) -> Optional[Iterable[Tuple[PathStr, Policy]]]: ...  # pragma: no cover
 
-    def logs(self) -> Optional[Iterable[str]]:
-        ...  # pragma: no cover
+    def logs(self) -> Optional[Iterable[str]]: ...  # pragma: no cover

wandb/apis/importers/mlflow.py

@@ -96,35 +96,26 @@ class MlflowRun:
     def used_artifacts(self) -> Optional[Iterable[Artifact]]:  # type: ignore
         ...  # pragma: no cover
 
-    def os_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def os_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def python_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def python_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def cuda_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def cuda_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def program(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def program(self) -> Optional[str]: ...  # pragma: no cover
 
-    def host(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def host(self) -> Optional[str]: ...  # pragma: no cover
 
-    def username(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def username(self) -> Optional[str]: ...  # pragma: no cover
 
-    def executable(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def executable(self) -> Optional[str]: ...  # pragma: no cover
 
-    def gpus_used(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def gpus_used(self) -> Optional[str]: ...  # pragma: no cover
 
     def cpus_used(self) -> Optional[int]:  # can we get the model?
         ...  # pragma: no cover
 
-    def memory_used(self) -> Optional[int]:
-        ...  # pragma: no cover
+    def memory_used(self) -> Optional[int]: ...  # pragma: no cover
 
     def runtime(self) -> Optional[int]:
         end_time = (
@@ -137,17 +128,13 @@ class MlflowRun:
     def start_time(self) -> Optional[int]:
         return self.run.info.start_time // 1000
 
-    def code_path(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def code_path(self) -> Optional[str]: ...  # pragma: no cover
 
-    def cli_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def cli_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def files(self) -> Optional[Iterable[Tuple[str, str]]]:
-        ...  # pragma: no cover
+    def files(self) -> Optional[Iterable[Tuple[str, str]]]: ...  # pragma: no cover
 
-    def logs(self) -> Optional[Iterable[str]]:
-        ...  # pragma: no cover
+    def logs(self) -> Optional[Iterable[str]]: ...  # pragma: no cover
 
     @staticmethod
     def _handle_incompatible_strings(s: str) -> str:

wandb/apis/importers/wandb.py

@@ -1,4 +1,5 @@
 """Tooling for the W&B Importer."""
+
 import itertools
 import json
 import logging
@@ -201,35 +202,28 @@ class WandbRun:
 
         yield from self._used_artifacts
 
-    def os_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def os_version(self) -> Optional[str]: ...  # pragma: no cover
 
     def python_version(self) -> Optional[str]:
         return self._metadata_file().get("python")
 
-    def cuda_version(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def cuda_version(self) -> Optional[str]: ...  # pragma: no cover
 
-    def program(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def program(self) -> Optional[str]: ...  # pragma: no cover
 
     def host(self) -> Optional[str]:
         return self._metadata_file().get("host")
 
-    def username(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def username(self) -> Optional[str]: ...  # pragma: no cover
 
-    def executable(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def executable(self) -> Optional[str]: ...  # pragma: no cover
 
-    def gpus_used(self) -> Optional[str]:
-        ...  # pragma: no cover
+    def gpus_used(self) -> Optional[str]: ...  # pragma: no cover
 
     def cpus_used(self) -> Optional[int]:  # can we get the model?
         ...  # pragma: no cover
 
-    def memory_used(self) -> Optional[int]:
-        ...  # pragma: no cover
+    def memory_used(self) -> Optional[int]: ...  # pragma: no cover
 
     def runtime(self) -> Optional[int]:
         wandb_runtime = self.run.summary.get("_wandb", {}).get("runtime")

wandb/apis/internal.py

@@ -170,9 +170,6 @@ class Api:
     def upload_multipart_file_chunk_retry(self, *args, **kwargs):
         return self.api.upload_multipart_file_chunk_retry(*args, **kwargs)
 
-    async def upload_file_retry_async(self, *args, **kwargs):
-        return await self.api.upload_file_retry_async(*args, **kwargs)
-
     def get_run_info(self, *args, **kwargs):
         return self.api.get_run_info(*args, **kwargs)
 

wandb/apis/public/api.py

@@ -10,6 +10,7 @@ You might use the Public API to
 
 For more on using the Public API, check out [our guide](https://docs.wandb.com/guides/track/public-api-guide).
 """
+
 import json
 import logging
 import os
@@ -29,6 +30,7 @@ from wandb.apis.public.const import RETRY_TIMEDELTA
 from wandb.sdk.internal.thread_local_settings import _thread_local_api_settings
 from wandb.sdk.launch.utils import LAUNCH_DEFAULT_PROJECT
 from wandb.sdk.lib import retry, runid
+from wandb.sdk.lib.deprecate import Deprecated, deprecate
 from wandb.sdk.lib.gql_request import GraphQLSession
 
 if TYPE_CHECKING:
@@ -109,6 +111,17 @@ class Api:
     """
 
     _HTTP_TIMEOUT = env.get_http_timeout(19)
+    DEFAULT_ENTITY_QUERY = gql(
+        """
+        query Viewer{
+            viewer {
+                id
+                entity
+            }
+        }
+        """
+    )
+
     VIEWER_QUERY = gql(
         """
         query Viewer{
@@ -488,7 +501,7 @@ class Api:
     @property
     def default_entity(self):
         if self._default_entity is None:
-            res = self._client.execute(self.VIEWER_QUERY)
+            res = self._client.execute(self.DEFAULT_ENTITY_QUERY)
             self._default_entity = (res.get("viewer") or {}).get("entity")
         return self._default_entity
 
@@ -926,8 +939,12 @@ class Api:
     @normalize_exceptions
     def artifact_versions(self, type_name, name, per_page=50):
         """Deprecated, use artifacts(type_name, name) instead."""
-        wandb.termwarn(
-            "Api.artifact_versions(type_name, name) is deprecated, use Api.artifacts(type_name, name) instead."
+        deprecate(
+            field_name=Deprecated.api__artifact_versions,
+            warning_message=(
+                "Api.artifact_versions(type_name, name) is deprecated, "
+                "use Api.artifacts(type_name, name) instead."
+            ),
         )
         return self.artifacts(type_name, name, per_page=per_page)
 
@@ -1042,3 +1059,38 @@ class Api:
             return [x["node"]["artifacts"] for x in artifacts]
         except requests.exceptions.HTTPError:
             return False
+
+    @normalize_exceptions
+    def artifact_exists(self, name: str, type: Optional[str] = None):
+        """Return whether an artifact version exists within a specified project and entity.
+
+        Arguments:
+            name: (str) An artifact name. May be prefixed with entity/project.
+                If entity or project is not specified, it will be inferred from the override params if populated.
+                Otherwise, entity will be pulled from the user settings and project will default to "uncategorized".
+                Valid names can be in the following forms:
+                    name:version
+                    name:alias
+            type: (str, optional) The type of artifact
+        """
+        try:
+            self.artifact(name, type)
+            return True
+        except wandb.errors.CommError:
+            return False
+
+    @normalize_exceptions
+    def artifact_collection_exists(self, name: str, type: str):
+        """Return whether an artifact collection exists within a specified project and entity.
+
+        Arguments:
+            name: (str) An artifact collection name. May be prefixed with entity/project.
+                If entity or project is not specified, it will be inferred from the override params if populated.
+                Otherwise, entity will be pulled from the user settings and project will default to "uncategorized".
+            type: (str) The type of artifact collection
+        """
+        try:
+            self.artifact_collection(type, name)
+            return True
+        except wandb.errors.CommError:
+            return False

wandb/apis/public/artifacts.py

@@ -1,4 +1,5 @@
 """Public API: artifacts."""
+
 import json
 from typing import TYPE_CHECKING, Any, Mapping, Optional, Sequence
 

wandb/apis/public/files.py

@@ -1,4 +1,5 @@
 """Public API: files."""
+
 import io
 import os
 from typing import Optional

wandb/apis/public/history.py

@@ -1,4 +1,5 @@
 """Public API: history."""
+
 import json
 
 import requests

wandb/apis/public/jobs.py

@@ -1,4 +1,5 @@
 """Public API: jobs."""
+
 import json
 import os
 import shutil
@@ -62,6 +63,8 @@ class Job:
         # only use notebook job if entrypoint not set and notebook is set
         self._notebook_job = source_info.get("notebook", False)
         self._entrypoint = source_info.get("entrypoint")
+        self._dockerfile = source_info.get("dockerfile")
+        self._build_context = source_info.get("build_context")
         self._args = source_info.get("args")
         self._partial = self._job_info.get("_partial", False)
         self._requirements_file = os.path.join(self._fpath, "requirements.frozen.txt")
@@ -105,7 +108,7 @@ class Job:
         )
         new_entrypoint = self._entrypoint
         new_entrypoint[-1] = new_fname
-        launch_project.set_entry_point(new_entrypoint)
+        launch_project.set_job_entry_point(new_entrypoint)
 
     def _configure_launch_project_repo(self, launch_project):
         git_info = self._job_info.get("source", {}).get("git", {})
@@ -122,7 +125,12 @@ class Job:
         if self._notebook_job:
             self._configure_launch_project_notebook(launch_project)
         else:
-            launch_project.set_entry_point(self._entrypoint)
+            launch_project.set_job_entry_point(self._entrypoint)
+
+        if self._dockerfile:
+            launch_project.set_job_dockerfile(self._dockerfile)
+        if self._build_context:
+            launch_project.set_job_build_context(self._build_context)
 
     def _configure_launch_project_artifact(self, launch_project):
         artifact_string = self._job_info.get("source", {}).get("artifact")
@@ -138,7 +146,12 @@ class Job:
         if self._notebook_job:
             self._configure_launch_project_notebook(launch_project)
         else:
-            launch_project.set_entry_point(self._entrypoint)
+            launch_project.set_job_entry_point(self._entrypoint)
+
+        if self._dockerfile:
+            launch_project.set_job_dockerfile(self._dockerfile)
+        if self._build_context:
+            launch_project.set_job_build_context(self._build_context)
 
     def _configure_launch_project_container(self, launch_project):
         launch_project.docker_image = self._job_info.get("source", {}).get("image")
@@ -147,7 +160,7 @@ class Job:
                 "Job had malformed source dictionary without an image key"
             )
         if self._entrypoint:
-            launch_project.set_entry_point(self._entrypoint)
+            launch_project.set_job_entry_point(self._entrypoint)
 
     def set_entrypoint(self, entrypoint: List[str]):
         self._entrypoint = entrypoint

wandb/apis/public/projects.py

@@ -1,4 +1,5 @@
 """Public API: projects."""
+
 from wandb_gql import gql
 
 from wandb.apis import public

wandb/apis/public/reports.py

@@ -1,4 +1,5 @@
 """Public API: reports."""
+
 import ast
 import json
 import sys

wandb/apis/public/runs.py

@@ -1,4 +1,5 @@
 """Public API: runs."""
+
 import json
 import os
 import tempfile
@@ -706,27 +707,24 @@ class Run(Attrs):
         )
         api.set_current_run_id(self.id)
 
-        if isinstance(artifact, wandb.Artifact) and not artifact.is_draft():
-            if (
-                self.entity != artifact.source_entity
-                or self.project != artifact.source_project
-            ):
-                raise ValueError("A run can't log an artifact to a different project.")
-            artifact_collection_name = artifact.source_name.split(":")[0]
-            api.create_artifact(
-                artifact.type,
-                artifact_collection_name,
-                artifact.digest,
-                aliases=aliases,
-            )
-            return artifact
-        elif isinstance(artifact, wandb.Artifact) and artifact.is_draft():
+        if not isinstance(artifact, wandb.Artifact):
+            raise ValueError("You must pass a wandb.Api().artifact() to use_artifact")
+        if artifact.is_draft():
             raise ValueError(
                 "Only existing artifacts are accepted by this api. "
                 "Manually create one with `wandb artifact put`"
             )
-        else:
-            raise ValueError("You must pass a wandb.Api().artifact() to use_artifact")
+        if (
+            self.entity != artifact.source_entity
+            or self.project != artifact.source_project
+        ):
+            raise ValueError("A run can't log an artifact to a different project.")
+
+        artifact_collection_name = artifact.source_name.split(":")[0]
+        api.create_artifact(
+            artifact.type, artifact_collection_name, artifact.digest, aliases=aliases
+        )
+        return artifact
 
     @property
     def summary(self):

wandb/apis/public/sweeps.py

@@ -1,4 +1,5 @@
 """Public API: sweeps."""
+
 import urllib
 from typing import Optional
 

wandb/apis/public/teams.py

@@ -1,4 +1,5 @@
 """Public API: teams."""
+
 import requests
 from wandb_gql import gql
 

wandb/apis/public/users.py

@@ -1,4 +1,5 @@
 """Public API: users."""
+
 import requests
 from wandb_gql import gql