wandb 0.13.10__py3-none-any.whl → 0.14.0__py3-none-any.whl

wandb/data_types.py

@@ -148,7 +148,7 @@ def _json_helper(val, artifact):
 
 
 class Table(Media):
-    """The Table class is used to display and analyze tabular data.
+    """The Table class used to display and analyze tabular data.
 
     Unlike traditional spreadsheets, Tables support numerous types of data:
     scalar values, strings, numpy arrays, and most subclasses of `wandb.data_types.Media`.
@@ -257,7 +257,10 @@ class Table(Media):
         optional=True,
         allow_mixed_types=False,
     ):
-        """rows is kept for legacy reasons, we use data to mimic the Pandas api"""
+        """Initialize a Table object.
+
+        Rows is kept for legacy reasons, we use data to mimic the Pandas api.
+        """
         super().__init__()
         self._pk_col = None
         self._fk_cols = set()
@@ -344,7 +347,7 @@ class Table(Media):
             self.cast(col_name, dt, opt)
 
     def cast(self, col_name, dtype, optional=False):
-        """Casts a column to a specific type
+        """Cast a column to a specific type.
 
         Arguments:
             col_name: (str) - name of the column to cast
@@ -445,12 +448,15 @@ class Table(Media):
         return self._eq_debug(other)
 
     def add_row(self, *row):
-        """add_row is deprecated. Please use add_data"""
+        """Deprecated: use add_data instead."""
         logging.warning("add_row is deprecated, use add_data")
         self.add_data(*row)
 
     def add_data(self, *data):
-        """Add a row of data to the table. Argument length should match column length"""
+        """Add a row of data to the table.
+
+        Argument length should match column length.
+        """
         if len(data) != len(self.columns):
             raise ValueError(
                 "This table expects {} columns: {}, found {}".format(
@@ -482,8 +488,11 @@ class Table(Media):
         self._update_keys(force_last=True)
 
     def _get_updated_result_type(self, row):
-        """Returns an updated result type based on incoming row. Raises error if
-        the assignment is invalid"""
+        """Return an updated result type based on incoming row.
+
+        Raises:
+            TypeError: if the assignment is invalid.
+        """
         incoming_row_dict = {
             col_key: row[ndx] for ndx, col_key in enumerate(self.columns)
         }
@@ -695,14 +704,15 @@ class Table(Media):
         return json_dict
 
     def iterrows(self):
-        """Iterate over rows as (ndx, row)
-        Yields
+        """Iterate over rows as (ndx, row).
+
+        Yields:
         ------
         index : int
             The index of the row. Using this value in other WandB tables
             will automatically build a relationship between the tables
         row : List[any]
-            The data of the row
+            The data of the row.
         """
         for ndx in range(len(self.data)):
             index = _TableIndex(ndx)
@@ -721,13 +731,14 @@ class Table(Media):
         self.cast(col_name, _ForeignKeyType(table, table_col))
 
     def _update_keys(self, force_last=False):
-        """Updates the known key-like columns based on the current
-        column types. If the state has been updated since
-        the last update, we wrap the data appropriately in the Key classes
+        """Update the known key-like columns based on the current column types.
+
+        If the state has been updated since the last update, we wrap the data
+        appropriately in the Key classes.
 
         Arguments:
-        force_last: (bool) Determines wrapping the last column of data even if
-        there are no key updates.
+            force_last: (bool) Determines wrapping the last column of data even if there
+                are no key updates.
         """
         _pk_col = None
         _fk_cols = set()
@@ -767,7 +778,7 @@ class Table(Media):
             self._apply_key_updates(not has_update)
 
     def _apply_key_updates(self, only_last=False):
-        """Appropriately wraps the underlying data in special key classes.
+        """Appropriately wrap the underlying data in special key classes.
 
         Arguments:
             only_last: only apply the updates to the last row (used for performance when
@@ -818,7 +829,7 @@ class Table(Media):
     def add_column(self, name, data, optional=False):
         """Add a column of data to the table.
 
-        Arguments
+        Arguments:
             name: (str) - the unique name of the column
             data: (list | np.array) - a column of homogenous data
             optional: (bool) - if null-like values are permitted
@@ -857,9 +868,9 @@ class Table(Media):
             raise err
 
     def get_column(self, name, convert_to=None):
-        """Retrieves a column of data from the table
+        """Retrieve a column of data from the table.
 
-        Arguments
+        Arguments:
             name: (str) - the name of the column
             convert_to: (str, optional)
                 - "numpy": will convert the underlying data to numpy object
@@ -882,7 +893,7 @@ class Table(Media):
         return col
 
     def get_index(self):
-        """Returns an array of row indexes which can be used in other tables to create links"""
+        """Return an array of row indexes for use in other tables to create links."""
         ndxs = []
         for ndx in range(len(self.data)):
             index = _TableIndex(ndx)
@@ -891,14 +902,14 @@ class Table(Media):
         return ndxs
 
     def index_ref(self, index):
-        """Get a reference to a particular row index in the table"""
+        """Get a reference to a particular row index in the table."""
         assert index < len(self.data)
         _index = _TableIndex(index)
         _index.set_table(self)
         return _index
 
     def add_computed_columns(self, fn):
-        """Adds one or more computed columns based on existing data
+        """Add one or more computed columns based on existing data.
 
         Args:
             fn: A function which accepts one or two parameters, ndx (int) and row (dict),
@@ -923,7 +934,7 @@ class Table(Media):
 
 
 class _PartitionTablePartEntry:
-    """Helper class for PartitionTable to track its parts"""
+    """Helper class for PartitionTable to track its parts."""
 
     def __init__(self, entry, source_artifact):
         self.entry = entry
@@ -940,17 +951,18 @@ class _PartitionTablePartEntry:
 
 
 class PartitionedTable(Media):
-    """PartitionedTable represents a table which is composed
-    by the union of multiple sub-tables. Currently, PartitionedTable
-    is designed to point to a directory within an artifact.
+    """A table which is composed of multiple sub-tables.
+
+    Currently, PartitionedTable is designed to point to a directory within an artifact.
     """
 
     _log_type = "partitioned-table"
 
     def __init__(self, parts_path):
-        """
+        """Initialize a PartitionedTable.
+
         Args:
-            parts_path (str): path to a directory of tables in the artifact
+            parts_path (str): path to a directory of tables in the artifact.
         """
         super().__init__()
         self.parts_path = parts_path
@@ -982,13 +994,14 @@ class PartitionedTable(Media):
         return instance
 
     def iterrows(self):
-        """Iterate over rows as (ndx, row)
-        Yields
+        """Iterate over rows as (ndx, row).
+
+        Yields:
         ------
         index : int
             The index of the row.
         row : List[any]
-            The data of the row
+            The data of the row.
         """
         columns = None
         ndx = 0
@@ -1024,8 +1037,7 @@ class PartitionedTable(Media):
 
 
 class Audio(BatchableMedia):
-    """
-    Wandb class for audio clips.
+    """Wandb class for audio clips.
 
     Arguments:
         data_or_path: (string or numpy array) A path to an audio file
@@ -1038,7 +1050,7 @@ class Audio(BatchableMedia):
     _log_type = "audio-file"
 
     def __init__(self, data_or_path, sample_rate=None, caption=None):
-        """Accepts a path to an audio file or a numpy array of audio data."""
+        """Accept a path to an audio file or a numpy array of audio data."""
         super().__init__()
         self._duration = None
         self._sample_rate = sample_rate
@@ -1172,7 +1184,7 @@ class Audio(BatchableMedia):
 
 
 class JoinedTable(Media):
-    """Joins two tables for visualization in the Artifact UI
+    """Join two tables for visualization in the Artifact UI.
 
     Arguments:
         table1 (str, wandb.Table, ArtifactManifestEntry):
@@ -1227,7 +1239,7 @@ class JoinedTable(Media):
 
     @staticmethod
     def _validate_table_input(table):
-        """Helper method to validate that the table input is one of the 3 supported types"""
+        """Helper method to validate that the table input is one of the 3 supported types."""
         return (
             (type(table) == str and table.endswith(".table.json"))
             or isinstance(table, Table)
@@ -1236,7 +1248,7 @@ class JoinedTable(Media):
         )
 
     def _ensure_table_in_artifact(self, table, artifact, table_ndx):
-        """Helper method to add the table to the incoming artifact. Returns the path"""
+        """Helper method to add the table to the incoming artifact. Returns the path."""
         if isinstance(table, Table) or isinstance(table, PartitionedTable):
             table_name = f"t{table_ndx}_{str(id(self))}"
             if (
@@ -1310,8 +1322,7 @@ class JoinedTable(Media):
 
 
 class Bokeh(Media):
-    """
-    Wandb class for Bokeh plots.
+    """Wandb class for Bokeh plots.
 
     Arguments:
         val: Bokeh plot
@@ -1373,7 +1384,7 @@ def _nest(thing):
 
 
 class Graph(Media):
-    """Wandb class for graphs
+    """Wandb class for graphs.
 
     This class is typically used for saving and diplaying neural net models.  It
     represents the graph as an array of nodes and edges.  The nodes can have
@@ -1537,9 +1548,7 @@ class Graph(Media):
 
 
 class Node(WBValue):
-    """
-    Node used in `Graph`
-    """
+    """Node used in `Graph`."""
 
     def __init__(
         self,
@@ -1589,7 +1598,7 @@ class Node(WBValue):
 
     @property
     def id(self):
-        """Must be unique in the graph"""
+        """Must be unique in the graph."""
         return self._attributes.get("id")
 
     @id.setter
@@ -1599,7 +1608,7 @@ class Node(WBValue):
 
     @property
     def name(self):
-        """Usually the type of layer or sublayer"""
+        """Usually the type of layer or sublayer."""
         return self._attributes.get("name")
 
     @name.setter
@@ -1609,7 +1618,7 @@ class Node(WBValue):
 
     @property
     def class_name(self):
-        """Usually the type of layer or sublayer"""
+        """Usually the type of layer or sublayer."""
         return self._attributes.get("class_name")
 
     @class_name.setter
@@ -1641,7 +1650,7 @@ class Node(WBValue):
 
     @size.setter
     def size(self, val):
-        """Tensor size"""
+        """Tensor size."""
         self._attributes["size"] = tuple(val)
         return val
 
@@ -1651,7 +1660,7 @@ class Node(WBValue):
 
     @output_shape.setter
     def output_shape(self, val):
-        """Tensor output_shape"""
+        """Tensor output_shape."""
         self._attributes["output_shape"] = val
         return val
 
@@ -1661,7 +1670,7 @@ class Node(WBValue):
 
     @is_output.setter
     def is_output(self, val):
-        """Tensor is_output"""
+        """Tensor is_output."""
         self._attributes["is_output"] = val
         return val
 
@@ -1671,7 +1680,7 @@ class Node(WBValue):
 
     @num_parameters.setter
     def num_parameters(self, val):
-        """Tensor num_parameters"""
+        """Tensor num_parameters."""
         self._attributes["num_parameters"] = val
         return val
 
@@ -1681,7 +1690,7 @@ class Node(WBValue):
 
     @child_parameters.setter
     def child_parameters(self, val):
-        """Tensor child_parameters"""
+        """Tensor child_parameters."""
         self._attributes["child_parameters"] = val
         return val
 
@@ -1691,7 +1700,7 @@ class Node(WBValue):
 
     @is_constant.setter
     def is_constant(self, val):
-        """Tensor is_constant"""
+        """Tensor is_constant."""
         self._attributes["is_constant"] = val
         return val
 
@@ -1714,9 +1723,7 @@ class Node(WBValue):
 
 
 class Edge(WBValue):
-    """
-    Edge used in `Graph`
-    """
+    """Edge used in `Graph`."""
 
     def __init__(self, from_node, to_node):
         self._attributes = {}
@@ -1736,7 +1743,7 @@ class Edge(WBValue):
 
     @property
     def name(self):
-        """Optional, not necessarily unique"""
+        """Optional, not necessarily unique."""
         return self._attributes.get("name")
 
     @name.setter

wandb/docker/__init__.py

@@ -8,7 +8,40 @@ import requests
 from dockerpycreds.utils import find_executable  # type: ignore
 
 from wandb.docker import auth, www_authenticate
-from wandb.errors import DockerError
+from wandb.errors import Error
+
+
+class DockerError(Error):
+    """Raised when attempting to execute a docker command."""
+
+    def __init__(
+        self,
+        command_launched: List[str],
+        return_code: int,
+        stdout: Optional[bytes] = None,
+        stderr: Optional[bytes] = None,
+    ) -> None:
+        command_launched_str = " ".join(command_launched)
+        error_msg = (
+            f"The docker command executed was `{command_launched_str}`.\n"
+            f"It returned with code {return_code}\n"
+        )
+        if stdout is not None:
+            error_msg += f"The content of stdout is '{stdout.decode()}'\n"
+        else:
+            error_msg += (
+                "The content of stdout can be found above the "
+                "stacktrace (it wasn't captured).\n"
+            )
+        if stderr is not None:
+            error_msg += f"The content of stderr is '{stderr.decode()}'\n"
+        else:
+            error_msg += (
+                "The content of stderr can be found above the "
+                "stacktrace (it wasn't captured)."
+            )
+        super().__init__(error_msg)
+
 
 entrypoint = os.path.join(
     os.path.dirname(os.path.abspath(__file__)), "wandb-entrypoint.sh"
@@ -18,9 +51,10 @@ log = logging.getLogger(__name__)
 
 
 def shell(cmd: List[str]) -> Optional[str]:
-    """Simple wrapper for calling docker,
+    """Simple wrapper for calling docker,.
 
-    returning None on error and the output on success"""
+    returning None on error and the output on success
+    """
     try:
         return (
             subprocess.check_output(["docker"] + cmd, stderr=subprocess.STDOUT)
@@ -36,7 +70,7 @@ _buildx_installed = None
 
 
 def is_buildx_installed() -> bool:
-    """Returns `True` if docker buildx is installed and working."""
+    """Return `True` if docker buildx is installed and working."""
     global _buildx_installed
     if _buildx_installed is not None:
         return _buildx_installed  # type: ignore
@@ -53,12 +87,40 @@ def build(tags: List[str], file: str, context_path: str) -> str:
     build_tags = []
     for tag in tags:
         build_tags += ["-t", tag]
-    run(
-        ["docker"] + command + build_tags + ["-f", file, context_path],
-        capture_stderr=False,
-        capture_stdout=False,
+    args = ["docker"] + command + build_tags + ["-f", file, context_path]
+    stdout = run_command_live_output(
+        args,
     )
-    return tags[0]
+    return stdout
+
+
+def run_command_live_output(args: List[Any]) -> str:
+    with subprocess.Popen(
+        args,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        universal_newlines=True,
+        bufsize=1,
+    ) as process:
+        stdout = ""
+        while True:
+            chunk = os.read(process.stdout.fileno(), 4096)  # type: ignore
+            if not chunk:
+                break
+            index = chunk.find(b"\r")
+            if index != -1:
+                print(chunk.decode(), end="")
+            else:
+                stdout += chunk.decode()
+                print(chunk.decode(), end="\r")
+
+        print(stdout)
+
+    return_code = process.wait()
+    if return_code != 0:
+        raise DockerError(args, return_code, stdout.encode())
+
+    return stdout
 
 
 def run(
@@ -132,7 +194,7 @@ def parse(image_name: str) -> Tuple[str, str, str]:
 
 
 def auth_token(registry: str, repo: str) -> Dict[str, str]:
-    """Makes a request to the root of a v2 docker registry to get the auth url.
+    """Make a request to the root of a v2 docker registry to get the auth url.
 
     Always returns a dictionary, if there's no token key we couldn't authenticate
     """
@@ -175,7 +237,7 @@ def auth_token(registry: str, repo: str) -> Dict[str, str]:
 
 
 def image_id_from_registry(image_name: str) -> Optional[str]:
-    """Get the docker id from a public or private registry"""
+    """Get the docker id from a public or private registry."""
     registry, repository, tag = parse(image_name)
     res = None
     try:
@@ -199,7 +261,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"""
+    """Retreve the image id from the local docker daemon or remote registry."""
     if "@sha256:" in image_name:
         return image_name
     else:
@@ -214,23 +276,23 @@ def image_id(image_name: str) -> Optional[str]:
 
 
 def get_image_uid(image_name: str) -> int:
-    """Retrieve the image default uid through brute force"""
+    """Retrieve the image default uid through brute force."""
     image_uid = shell(["run", image_name, "id", "-u"])
     return int(image_uid) if image_uid else -1
 
 
 def push(image: str, tag: str) -> Optional[str]:
-    """Push an image to a remote registry"""
+    """Push an image to a remote registry."""
     return shell(["push", f"{image}:{tag}"])
 
 
 def login(username: str, password: str, registry: str) -> Optional[str]:
-    """Login to a registry"""
+    """Login to a registry."""
     return shell(["login", "--username", username, "--password", password, registry])
 
 
 def tag(image_name: str, tag: str) -> Optional[str]:
-    """Tag an image"""
+    """Tag an image."""
     return shell(["tag", image_name, tag])
 
 

wandb/docker/auth.py

@@ -19,8 +19,8 @@ log = logging.getLogger(__name__)
 
 
 class DockerError(Exception):
-    """
-    A base class from which all other exceptions inherit.
+    """Base class from which all other exceptions inherit.
+
     If you want to catch all errors that the Docker SDK might raise,
     catch this base exception.
     """
@@ -67,9 +67,10 @@ def config_path_from_environment() -> Optional[str]:
 
 
 def home_dir() -> str:
-    """
-    Get the user's home directory, using the same logic as the Docker Engine
-    client - use %USERPROFILE% on Windows, $HOME/getuid on POSIX.
+    """Get the user's home directory.
+
+    Uses the same logic as the Docker Engine client - use %USERPROFILE% on Windows,
+    $HOME/getuid on POSIX.
     """
     if IS_WINDOWS_PLATFORM:
         return os.environ.get("USERPROFILE", "")
@@ -149,8 +150,8 @@ class AuthConfig(dict):
         entries: Dict[str, Dict[str, Any]],
         raise_on_error: bool = False,
     ) -> Dict[str, Dict[str, Any]]:
-        """
-        Parses authentication entries
+        """Parse authentication entries.
+
         Arguments:
           entries:        Dict of authentication entries.
           raise_on_error: If set to true, an invalid format will raise
@@ -158,7 +159,6 @@ class AuthConfig(dict):
         Returns:
           Authentication registry.
         """
-
         conf = {}
         for registry, entry in entries.items():
             if not isinstance(entry, dict):
@@ -210,14 +210,15 @@ class AuthConfig(dict):
         config_dict: Optional[Dict[str, Any]],
         credstore_env: Optional[Mapping] = None,
     ) -> "AuthConfig":
-        """
-        Loads authentication data from a Docker configuration file in the given
-        root directory or if config_path is passed use given path.
+        """Load authentication data from a Docker configuration file.
+
+        If the config_path is not passed in it looks for a configuration file in the
+        root directory.
+
         Lookup priority:
             explicit config_path parameter > DOCKER_CONFIG environment
-            variable > ~/.docker/config.json > ~/.dockercfg
+            variable > ~/.docker/config.json > ~/.dockercfg.
         """
-
         if not config_dict:
             config_file = find_config_file(config_path)
 
@@ -274,13 +275,12 @@ class AuthConfig(dict):
     def resolve_authconfig(
         self, registry: Optional[str] = None
     ) -> Optional[Dict[str, Any]]:
-        """
-        Returns the authentication data from the given auth configuration for a
-        specific registry. As with the Docker client, legacy entries in the
-        config with full URLs are stripped down to hostnames before checking
-        for a match. Returns None if no match was found.
-        """
+        """Return the authentication data for a specific registry.
 
+        As with the Docker client, legacy entries in the config with full URLs are
+        stripped down to hostnames before checking for a match. Returns None if no match
+        was found.
+        """
         if self.creds_store or self.cred_helpers:
             store_name = self.get_credential_store(registry)
             if store_name is not None:
@@ -387,8 +387,8 @@ def decode_auth(auth: Union[str, bytes]) -> Tuple[str, str]:
 def parse_auth(
     entries: Dict, raise_on_error: bool = False
 ) -> Dict[str, Dict[str, Any]]:
-    """
-    Parses authentication entries
+    """Parse authentication entries.
+
     Arguments:
       entries:        Dict of authentication entries.
       raise_on_error: If set to true, an invalid format will raise
@@ -396,7 +396,6 @@ def parse_auth(
     Returns:
       Authentication registry.
     """
-
     return AuthConfig.parse_auth(entries, raise_on_error)
 
 

wandb/env.py

@@ -74,7 +74,6 @@ DATA_DIR = "WANDB_DATA_DIR"
 CACHE_DIR = "WANDB_CACHE_DIR"
 DISABLE_SSL = "WANDB_INSECURE_DISABLE_SSL"
 SERVICE = "WANDB_SERVICE"
-REQUIRE_SERVICE = "WANDB_REQUIRE_SERVICE"
 _DISABLE_SERVICE = "WANDB_DISABLE_SERVICE"
 SENTRY_DSN = "WANDB_SENTRY_DSN"
 INIT_TIMEOUT = "WANDB_INIT_TIMEOUT"