wandb 0.21.0__py3-none-win_amd64.whl → 0.21.1__py3-none-win_amd64.whl

wandb/apis/public/artifacts.py

@@ -1,4 +1,8 @@
-"""Public API: artifacts."""
+"""W&B Public API for Artifact objects.
+
+This module provides classes for interacting with W&B artifacts and their
+collections.
+"""
 
 from __future__ import annotations
 
@@ -67,6 +71,11 @@ if TYPE_CHECKING:
 
 
 class ArtifactTypes(Paginator["ArtifactType"]):
+    """An lazy iterator of `ArtifactType` objects for a specific project.
+
+    <!-- lazydoc-ignore-init: internal -->
+    """
+
     QUERY = gql(PROJECT_ARTIFACT_TYPES_GQL)
 
     last_response: ArtifactTypesFragment | None
@@ -101,25 +110,45 @@ class ArtifactTypes(Paginator["ArtifactType"]):
 
     @property
     def _length(self) -> None:
+        """Returns `None`.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         # TODO
         return None
 
     @property
     def more(self) -> bool:
+        """Returns whether there are more artifact types to fetch.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return True
         return self.last_response.page_info.has_next_page
 
     @property
     def cursor(self) -> str | None:
+        """Returns the cursor for the next page of results.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return None
         return self.last_response.edges[-1].cursor
 
     def update_variables(self) -> None:
+        """Update the cursor variable for pagination.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         self.variables.update({"cursor": self.cursor})
 
     def convert_objects(self) -> list[ArtifactType]:
+        """Convert the raw response data into a list of ArtifactType objects.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return []
 
@@ -137,6 +166,19 @@ class ArtifactTypes(Paginator["ArtifactType"]):
 
 
 class ArtifactType:
+    """An artifact object that satisfies query based on the specified type.
+
+    Args:
+        client: The client instance to use for querying W&B.
+        entity: The entity (user or team) that owns the project.
+        project: The name of the project to query for artifact types.
+        type_name: The name of the artifact type.
+        attrs: Optional mapping of attributes to initialize the artifact type. If not provided,
+            the object will load its attributes from W&B upon initialization.
+
+    <!-- lazydoc-ignore-init: internal -->
+    """
+
     def __init__(
         self,
         client: Client,
@@ -154,6 +196,10 @@ class ArtifactType:
             self.load()
 
     def load(self) -> Mapping[str, Any]:
+        """Load the artifact type attributes from W&B.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         data: Mapping[str, Any] | None = self.client.execute(
             gql(PROJECT_ARTIFACT_TYPE_GQL),
             variable_values={
@@ -171,18 +217,30 @@ class ArtifactType:
 
     @property
     def id(self) -> str:
+        """The unique identifier of the artifact type."""
         return self._attrs["id"]
 
     @property
     def name(self) -> str:
+        """The name of the artifact type."""
         return self._attrs["name"]
 
     @normalize_exceptions
     def collections(self, per_page: int = 50) -> ArtifactCollections:
-        """Artifact collections."""
+        """Get all artifact collections associated with this artifact type.
+
+        Args:
+            per_page (int): The number of artifact collections to fetch per page.
+                Default is 50.
+        """
         return ArtifactCollections(self.client, self.entity, self.project, self.type)
 
     def collection(self, name: str) -> ArtifactCollection:
+        """Get a specific artifact collection by name.
+
+        Args:
+            name (str): The name of the artifact collection to retrieve.
+        """
         return ArtifactCollection(
             self.client, self.entity, self.project, name, self.type
         )
@@ -192,6 +250,18 @@ class ArtifactType:
 
 
 class ArtifactCollections(SizedPaginator["ArtifactCollection"]):
+    """Artifact collections of a specific type in a project.
+
+    Args:
+        client: The client instance to use for querying W&B.
+        entity: The entity (user or team) that owns the project.
+        project: The name of the project to query for artifact collections.
+        type_name: The name of the artifact type for which to fetch collections.
+        per_page: The number of artifact collections to fetch per page. Default is 50.
+
+    <!-- lazydoc-ignore-init: internal -->
+    """
+
     last_response: ArtifactCollectionsFragment | None
 
     def __init__(
@@ -241,29 +311,48 @@ class ArtifactCollections(SizedPaginator["ArtifactCollection"]):
 
     @property
     def _length(self) -> int:
+        """Returns the total number of artifact collections.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             self._load_page()
         return self.last_response.total_count
 
     @property
     def more(self):
+        """Returns whether there are more artifacts to fetch.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return True
         return self.last_response.page_info.has_next_page
 
     @property
     def cursor(self):
+        """Returns the cursor for the next page of results.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return None
         return self.last_response.edges[-1].cursor
 
     def update_variables(self) -> None:
+        """Update the cursor variable for pagination.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         self.variables.update({"cursor": self.cursor})
 
     def convert_objects(self) -> list[ArtifactCollection]:
+        """Convert the raw response data into a list of ArtifactCollection objects.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return []
-
         return [
             ArtifactCollection(
                 client=self.client,
@@ -278,6 +367,22 @@ class ArtifactCollections(SizedPaginator["ArtifactCollection"]):
 
 
 class ArtifactCollection:
+    """An artifact collection that represents a group of related artifacts.
+
+    Args:
+        client: The client instance to use for querying W&B.
+        entity: The entity (user or team) that owns the project.
+        project: The name of the project to query for artifact collections.
+        name: The name of the artifact collection.
+        type: The type of the artifact collection (e.g., "dataset", "model").
+        organization: Optional organization name if applicable.
+        attrs: Optional mapping of attributes to initialize the artifact collection.
+            If not provided, the object will load its attributes from W&B upon
+            initialization.
+
+    <!-- lazydoc-ignore-init: internal -->
+    """
+
     def __init__(
         self,
         client: Client,
@@ -310,11 +415,12 @@ class ArtifactCollection:
 
     @property
     def id(self) -> str:
+        """The unique identifier of the artifact collection."""
         return self._attrs["id"]
 
     @normalize_exceptions
     def artifacts(self, per_page: int = 50) -> Artifacts:
-        """Artifacts."""
+        """Get all artifacts in the collection."""
         return Artifacts(
             client=self.client,
             entity=self.entity,
@@ -331,9 +437,14 @@ class ArtifactCollection:
 
     @property
     def created_at(self) -> str:
+        """The creation date of the artifact collection."""
         return self._created_at
 
     def load(self):
+        """Load the artifact collection attributes from W&B.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if server_supports_artifact_collections_gql_edges(self.client):
             rename_fields = None
         else:
@@ -425,6 +536,7 @@ class ArtifactCollection:
 
     @description.setter
     def description(self, description: str | None) -> None:
+        """Set the description of the artifact collection."""
         self._description = description
 
     @property
@@ -434,6 +546,7 @@ class ArtifactCollection:
 
     @tags.setter
     def tags(self, tags: list[str]) -> None:
+        """Set the tags associated with the artifact collection."""
         if any(not re.match(r"^[-\w]+([ ]+[-\w]+)*$", tag) for tag in tags):
             raise ValueError(
                 "Tags must only contain alphanumeric characters or underscores separated by spaces or hyphens"
@@ -447,15 +560,17 @@ class ArtifactCollection:
 
     @name.setter
     def name(self, name: str) -> None:
+        """Set the name of the artifact collection."""
         self._name = validate_artifact_name(name)
 
     @property
     def type(self):
-        """The type of the artifact collection."""
+        """Returns the type of the artifact collection."""
         return self._type
 
     @type.setter
     def type(self, type: list[str]) -> None:
+        """Set the type of the artifact collection."""
         if not self.is_sequence():
             raise ValueError(
                 "Type can only be changed if the artifact collection is a sequence."
@@ -543,9 +658,23 @@ class ArtifactCollection:
 
 
 class Artifacts(SizedPaginator["Artifact"]):
-    """An iterable collection of artifact versions associated with a project and optional filter.
-
-    This is generally used indirectly via the `Api`.artifact_versions method.
+    """An iterable collection of artifact versions associated with a project.
+
+    Optionally pass in filters to narrow down the results based on specific criteria.
+
+    Args:
+        client: The client instance to use for querying W&B.
+        entity: The entity (user or team) that owns the project.
+        project: The name of the project to query for artifacts.
+        collection_name: The name of the artifact collection to query.
+        type: The type of the artifacts to query. Common examples include
+            "dataset" or "model".
+        filters: Optional mapping of filters to apply to the query.
+        order: Optional string to specify the order of the results.
+        per_page: The number of artifact versions to fetch per page. Default is 50.
+        tags: Optional string or list of strings to filter artifacts by tags.
+
+    <!-- lazydoc-ignore-init: internal -->
     """
 
     last_response: ArtifactsFragment | None
@@ -609,23 +738,39 @@ class Artifacts(SizedPaginator["Artifact"]):
 
     @property
     def _length(self) -> int:
+        """Returns the total number of artifacts in the collection.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             self._load_page()
         return self.last_response.total_count
 
     @property
     def more(self) -> bool:
+        """Returns whether there are more files to fetch.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return True
         return self.last_response.page_info.has_next_page
 
     @property
     def cursor(self) -> str | None:
+        """Returns the cursor for the next page of results.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return None
         return self.last_response.edges[-1].cursor
 
     def convert_objects(self) -> list[Artifact]:
+        """Convert the raw response data into a list of wandb.Artifact objects.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return []
 
@@ -645,6 +790,11 @@ class Artifacts(SizedPaginator["Artifact"]):
 
 
 class RunArtifacts(SizedPaginator["Artifact"]):
+    """An iterable collection of artifacts associated with a specific run.
+
+    <!-- lazydoc-ignore-init: internal -->
+    """
+
     last_response: (
         RunOutputArtifactsProjectRunOutputArtifacts
         | RunInputArtifactsProjectRunInputArtifacts
@@ -699,23 +849,39 @@ class RunArtifacts(SizedPaginator["Artifact"]):
 
     @property
     def _length(self) -> int:
+        """Returns the total number of artifacts in the collection.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             self._load_page()
         return self.last_response.total_count
 
     @property
     def more(self) -> bool:
+        """Returns whether there are more artifacts to fetch.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return True
         return self.last_response.page_info.has_next_page
 
     @property
     def cursor(self) -> str | None:
+        """Returns the cursor for the next page of results.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return None
         return self.last_response.edges[-1].cursor
 
     def convert_objects(self) -> list[Artifact]:
+        """Convert the raw response data into a list of wandb.Artifact objects.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return []
 
@@ -735,6 +901,11 @@ class RunArtifacts(SizedPaginator["Artifact"]):
 
 
 class ArtifactFiles(SizedPaginator["public.File"]):
+    """A paginator for files in an artifact.
+
+    <!-- lazydoc-ignore-init: internal -->
+    """
+
     last_response: FilesFragment | None
 
     def __init__(
@@ -796,30 +967,51 @@ class ArtifactFiles(SizedPaginator["public.File"]):
 
     @property
     def path(self) -> list[str]:
+        """Returns the path of the artifact."""
         return [self.artifact.entity, self.artifact.project, self.artifact.name]
 
     @property
     def _length(self) -> int:
         if self.last_response is None:
             self._load_page()
+        """Returns the total number of files in the artifact.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         return self.artifact.file_count
 
     @property
     def more(self) -> bool:
+        """Returns whether there are more files to fetch.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return True
         return self.last_response.page_info.has_next_page
 
     @property
     def cursor(self) -> str | None:
+        """Returns the cursor for the next page of results.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return None
         return self.last_response.edges[-1].cursor
 
     def update_variables(self) -> None:
+        """Update the variables dictionary with the cursor.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         self.variables.update({"fileLimit": self.per_page, "fileCursor": self.cursor})
 
     def convert_objects(self) -> list[public.File]:
+        """Convert the raw response data into a list of public.File objects.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return []
 
@@ -840,6 +1032,10 @@ class ArtifactFiles(SizedPaginator["public.File"]):
 def server_supports_artifact_collections_gql_edges(
     client: RetryingClient, warn: bool = False
 ) -> bool:
+    """Check if W&B server supports GraphQL edges for artifact collections.
+
+    <!-- lazydoc-ignore-function: internal -->
+    """
     # TODO: Validate this version
     # Edges were merged into core on Mar 2, 2022: https://github.com/wandb/core/commit/81c90b29eaacfe0a96dc1ebd83c53560ca763e8b
     # CLI version was bumped to "0.12.11" on Mar 3, 2022: https://github.com/wandb/core/commit/328396fa7c89a2178d510a1be9c0d4451f350d7b

wandb/apis/public/automations.py

@@ -1,3 +1,5 @@
+"""W&B Public API for Automation objects."""
+
 from __future__ import annotations
 
 from itertools import chain
@@ -15,6 +17,11 @@ if TYPE_CHECKING:
 
 
 class Automations(Paginator["Automation"]):
+    """An lazy iterator of `Automation` objects.
+
+    <!-- lazydoc-ignore-init: internal -->
+    """
+
     last_response: ProjectConnectionFields | None
     _query: Document
 
@@ -32,14 +39,20 @@ class Automations(Paginator["Automation"]):
 
     @property
     def more(self) -> bool:
-        """Whether there are more items to fetch."""
+        """Whether there are more items to fetch.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return True
         return self.last_response.page_info.has_next_page
 
     @property
     def cursor(self) -> str | None:
-        """The start cursor to use for the next page."""
+        """The start cursor to use for the next page.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         if self.last_response is None:
             return None
         return self.last_response.page_info.end_cursor
@@ -59,7 +72,10 @@ class Automations(Paginator["Automation"]):
             raise ValueError("Unexpected response data") from e
 
     def convert_objects(self) -> Iterable[Automation]:
-        """Parse the page data into a list of objects."""
+        """Parse the page data into a list of objects.
+
+        <!-- lazydoc-ignore: internal -->
+        """
         from wandb.automations import Automation
 
         page = self.last_response