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

wandb/sdk/data_types/_dtypes.py

@@ -22,9 +22,9 @@ if not _TYPES_STRIPPED:
 
 
 class TypeRegistry:
-    """The TypeRegistry resolves python objects to Types as well as
-    deserializes JSON dicts. Additional types can be registered via
-    the .add call.
+    """A resolver for python objects that can deserialize JSON dicts.
+
+    Additional types can be registered via the .add call.
     """
 
     _types_by_name = None
@@ -137,7 +137,7 @@ def _params_obj_to_json_obj(
     params_obj: t.Any,
     artifact: t.Optional["ArtifactInCreation"] = None,
 ) -> t.Any:
-    """Helper method"""
+    """Helper method."""
     if params_obj.__class__ == dict:
         return {
             key: _params_obj_to_json_obj(params_obj[key], artifact)
@@ -154,7 +154,7 @@ def _params_obj_to_json_obj(
 def _json_obj_to_params_obj(
     json_obj: t.Any, artifact: t.Optional["DownloadedArtifact"] = None
 ) -> t.Any:
-    """Helper method"""
+    """Helper method."""
     if json_obj.__class__ == dict:
         if "wb_type" in json_obj:
             return TypeRegistry.type_from_dict(json_obj, artifact)
@@ -170,7 +170,8 @@ def _json_obj_to_params_obj(
 
 
 class Type:
-    """This is the most generic type which all types are subclasses.
+    """The most generic type that all types subclass.
+
     It provides simple serialization and deserialization as well as equality checks.
     A name class-level property must be uniquely set by subclasses.
     """
@@ -201,8 +202,7 @@ class Type:
         return self._params
 
     def assign(self, py_obj: t.Optional[t.Any] = None) -> "Type":
-        """Assign a python object to the type, returning a new type representing
-        the result of the assignment.
+        """Assign a python object to the type.
 
         May to be overridden by subclasses
 
@@ -211,7 +211,7 @@ class Type:
             this type
 
         Returns:
-            Type: an instance of a subclass of the Type class.
+            Type: a new type representing the result of the assignment.
         """
         return self.assign_type(TypeRegistry.type_of(py_obj))
 
@@ -251,10 +251,10 @@ class Type:
         json_dict: t.Dict[str, t.Any],
         artifact: t.Optional["DownloadedArtifact"] = None,
     ) -> "Type":
-        """Construct a new instance of the type using a JSON dictionary equivalent to
-        the kind output by `to_json`.
+        """Construct a new instance of the type using a JSON dictionary.
 
-        If overridden by subclass, ensure that `to_json` is equivalently overridden.
+        The mirror function of `to_json`. If overridden by subclass, ensure that
+        `to_json` is equivalently overridden.
 
         Returns:
             _Type: an instance of a subclass of the _Type class.
@@ -266,12 +266,13 @@ class Type:
         return cls()
 
     def explain(self, other: t.Any, depth=0) -> str:
-        """Explains why an item is not assignable to a type. Assumes that
-        the caller has already validated that the assignment fails.
+        """Explain why an item is not assignable to a type.
+
+        Assumes that the caller has already validated that the assignment fails.
 
         Args:
-            other (any): Any object
-            depth (int, optional): depth of the type checking. Defaults to 0.
+            other (any): Any object depth (int, optional): depth of the type checking.
+                Defaults to 0.
 
         Returns:
             str: human-readable explanation
@@ -307,8 +308,10 @@ class Type:
 
 
 class InvalidType(Type):
-    """all assignments to a InvalidType result in a Never Type.
-    InvalidType is basically the invalid case
+    """A disallowed type.
+
+    Assignments to a InvalidType result in a Never Type. InvalidType is basically the
+    invalid case.
     """
 
     name = "invalid"
@@ -319,8 +322,10 @@ class InvalidType(Type):
 
 
 class AnyType(Type):
-    """all assignments to an AnyType result in the
-    AnyType except None which will be InvalidType
+    """An object that can be any type.
+
+    Assignments to an AnyType result in the AnyType except None which results in an
+    InvalidType.
     """
 
     name = "any"
@@ -335,8 +340,10 @@ class AnyType(Type):
 
 
 class UnknownType(Type):
-    """all assignments to an UnknownType result in the type of the assigned object
-    except none which will result in a InvalidType
+    """An object with an unknown type.
+
+    All assignments to an UnknownType result in the type of the assigned object except
+    `None` which results in a InvalidType.
     """
 
     name = "unknown"
@@ -416,7 +423,7 @@ if np:
 
 
 class PythonObjectType(Type):
-    """Serves as a backup type by keeping track of the python object name"""
+    """A backup type that keeps track of the python object name."""
 
     name = "pythonObject"
     legacy_names = ["object"]
@@ -431,7 +438,7 @@ class PythonObjectType(Type):
 
 
 class ConstType(Type):
-    """Represents a constant value (currently only primitives supported)"""
+    """A constant value (currently only primitives supported)."""
 
     name = "const"
     types: t.ClassVar[t.List[type]] = []
@@ -524,7 +531,7 @@ def _union_assigner(
 
 
 class UnionType(Type):
-    """Represents an "or" of types"""
+    """An "or" of types."""
 
     name = "union"
     types: t.ClassVar[t.List[type]] = []
@@ -580,8 +587,9 @@ class UnionType(Type):
 
 
 def OptionalType(dtype: ConvertableToType) -> UnionType:  # noqa: N802
-    """Function that mimics the Type class API for constructing an "Optional Type"
-    which is just a Union[wb_type, NoneType]
+    """Function that mimics the Type class API for constructing an "Optional Type".
+
+    This is just a Union[wb_type, NoneType].
 
     Args:
         dtype (Type): type to be optional
@@ -593,7 +601,7 @@ def OptionalType(dtype: ConvertableToType) -> UnionType:  # noqa: N802
 
 
 class ListType(Type):
-    """Represents a list of homogenous types"""
+    """A list of homogenous types."""
 
     name = "list"
     types: t.ClassVar[t.List[type]] = [list, tuple, set, frozenset]
@@ -693,7 +701,7 @@ class ListType(Type):
 
 
 class NDArrayType(Type):
-    """Represents a list of homogenous types"""
+    """Represents a list of homogenous types."""
 
     name = "ndarray"
     types: t.ClassVar[t.List[type]] = []  # will manually add type if np is available
@@ -782,7 +790,7 @@ if np:
 
 
 class TypedDictType(Type):
-    """Represents a dictionary object where each key can have a type"""
+    """Represents a dictionary object where each key can have a type."""
 
     name = "typedDict"
     legacy_names = ["dictionary"]

wandb/sdk/data_types/base_types/json_metadata.py

@@ -21,9 +21,7 @@ if TYPE_CHECKING:  # pragma: no cover
 
 
 class JSONMetadata(Media):
-    """
-    JSONMetadata is a type for encoding arbitrary metadata as files.
-    """
+    """JSONMetadata is a type for encoding arbitrary metadata as files."""
 
     def __init__(self, val: dict) -> None:
         super().__init__()

wandb/sdk/data_types/base_types/media.py

@@ -31,11 +31,10 @@ def _wb_filename(
 
 
 class Media(WBValue):
-    """A WBValue that we store as a file outside JSON and show in a media panel
-    on the front end.
+    """A WBValue stored as a file outside JSON that can be rendered in a media panel.
 
-    If necessary, we move or copy the file into the Run's media directory so
-    that it gets uploaded.
+    If necessary, we move or copy the file into the Run's media directory so that it
+    gets uploaded.
     """
 
     _path: Optional[str]
@@ -98,9 +97,8 @@ class Media(WBValue):
     ) -> None:
         """Bind this object to a particular Run.
 
-        Calling this function is necessary so that we have somewhere specific to
-        put the file associated with this object, from which other Runs can
-        refer to it.
+        Calling this function is necessary so that we have somewhere specific to put the
+        file associated with this object, from which other Runs can refer to it.
         """
         assert self.file_is_set(), "bind_to_run called before _set_file"
 
@@ -146,12 +144,15 @@ class Media(WBValue):
             _datatypes_callback(media_path)
 
     def to_json(self, run: Union["LocalRun", "LocalArtifact"]) -> dict:
-        """Serializes the object into a JSON blob, using a run or artifact to store additional data. If `run_or_artifact`
-        is a wandb.Run then `self.bind_to_run()` must have been previously been called.
+        """Serialize the object into a JSON blob.
+
+        Uses run or artifact to store additional data. If `run_or_artifact` is a
+        wandb.Run then `self.bind_to_run()` must have been previously been called.
 
         Args:
-            run_or_artifact (wandb.Run | wandb.Artifact): the Run or Artifact for which this object should be generating
-            JSON for - this is useful to to store additional data if needed.
+            run_or_artifact (wandb.Run | wandb.Artifact): the Run or Artifact for which
+                this object should be generating JSON for - this is useful to to store
+                additional data if needed.
 
         Returns:
             dict: JSON representation
@@ -254,11 +255,11 @@ class Media(WBValue):
     def from_json(
         cls: Type["Media"], json_obj: dict, source_artifact: "PublicArtifact"
     ) -> "Media":
-        """Likely will need to override for any more complicated media objects"""
+        """Likely will need to override for any more complicated media objects."""
         return cls(source_artifact.get_path(json_obj["path"]).download())
 
     def __eq__(self, other: object) -> bool:
-        """Likely will need to override for any more complicated media objects"""
+        """Likely will need to override for any more complicated media objects."""
         return (
             isinstance(other, self.__class__)
             and hasattr(self, "_sha256")
@@ -272,11 +273,10 @@ class Media(WBValue):
 
 
 class BatchableMedia(Media):
-    """Parent class for Media we treat specially in batches, like images and
-    thumbnails.
+    """Media that is treated in batches.
 
-    Apart from images, we just use these batches to help organize files by name
-    in the media directory.
+    E.g. images and thumbnails. Apart from images, we just use these batches to help
+    organize files by name in the media directory.
     """
 
     def __init__(self) -> None:

wandb/sdk/data_types/base_types/wb_value.py

@@ -54,12 +54,10 @@ class _WBValueArtifactTarget:
 
 
 class WBValue:
-    """
-    Abstract parent class for things that can be logged by `wandb.log()` and
-    visualized by wandb.
+    """Typed objects that can be logged with `wandb.log()` and visualized by wandb.
 
-    The objects will be serialized as JSON and always have a _type attribute
-    that indicates how to interpret the other fields.
+    The objects will be serialized as JSON and always have a _type attribute that
+    indicates how to interpret the other fields.
     """
 
     # Class Attributes
@@ -76,11 +74,14 @@ class WBValue:
         self._artifact_target = None
 
     def to_json(self, run_or_artifact: Union["LocalRun", "LocalArtifact"]) -> dict:
-        """Serializes the object into a JSON blob, using a run or artifact to store additional data.
+        """Serialize the object into a JSON blob.
+
+        Uses current run or artifact to store additional data.
 
         Args:
-            run_or_artifact (wandb.Run | wandb.Artifact): the Run or Artifact for which this object should be generating
-            JSON for - this is useful to to store additional data if needed.
+            run_or_artifact (wandb.Run | wandb.Artifact): the Run or Artifact for which
+                this object should be generating JSON for - this is useful to to store
+                additional data if needed.
 
         Returns:
             dict: JSON representation
@@ -91,27 +92,29 @@ class WBValue:
     def from_json(
         cls: Type["WBValue"], json_obj: dict, source_artifact: "PublicArtifact"
     ) -> "WBValue":
-        """Deserialize a `json_obj` into it's class representation. If additional resources were stored in the
-        `run_or_artifact` artifact during the `to_json` call, then those resources are expected to be in
-        the `source_artifact`.
+        """Deserialize a `json_obj` into it's class representation.
+
+        If additional resources were stored in the `run_or_artifact` artifact during the
+        `to_json` call, then those resources should be in the `source_artifact`.
 
         Args:
-            json_obj (dict): A JSON dictionary to deserialize
-            source_artifact (wandb.Artifact): An artifact which will hold any additional resources which were stored
-            during the `to_json` function.
+            json_obj (dict): A JSON dictionary to deserialize source_artifact
+            (wandb.Artifact): An artifact which will hold any additional
+                resources which were stored during the `to_json` function.
         """
         raise NotImplementedError
 
     @classmethod
     def with_suffix(cls: Type["WBValue"], name: str, filetype: str = "json") -> str:
-        """Helper function to return the name with suffix added if not already
+        """Get the name with the appropriate suffix.
 
         Args:
             name (str): the name of the file
             filetype (str, optional): the filetype to use. Defaults to "json".
 
         Returns:
-            str: a filename which is suffixed with it's `_log_type` followed by the filetype
+            str: a filename which is suffixed with it's `_log_type` followed by the
+                filetype.
         """
         if cls._log_type is not None:
             suffix = cls._log_type + "." + filetype
@@ -125,16 +128,20 @@ class WBValue:
     def init_from_json(
         json_obj: dict, source_artifact: "PublicArtifact"
     ) -> Optional["WBValue"]:
-        """Looks through all subclasses and tries to match the json obj with the class which created it. It will then
-        call that subclass' `from_json` method. Importantly, this function will set the return object's `source_artifact`
-        attribute to the passed in source artifact. This is critical for artifact bookkeeping. If you choose to create
-        a wandb.Value via it's `from_json` method, make sure to properly set this `artifact_source` to avoid data duplication.
+        """Initialize a `WBValue` from a JSON blob based on the class that creatd it.
+
+        Looks through all subclasses and tries to match the json obj with the class
+        which created it. It will then call that subclass' `from_json` method.
+        Importantly, this function will set the return object's `source_artifact`
+        attribute to the passed in source artifact. This is critical for artifact
+        bookkeeping. If you choose to create a wandb.Value via it's `from_json` method,
+        make sure to properly set this `artifact_source` to avoid data duplication.
 
         Args:
-            json_obj (dict): A JSON dictionary to deserialize. It must contain a `_type` key. The value of
-            this key is used to lookup the correct subclass to use.
-            source_artifact (wandb.Artifact): An artifact which will hold any additional resources which were stored
-            during the `to_json` function.
+            json_obj (dict): A JSON dictionary to deserialize. It must contain a `_type`
+                key. This is used to lookup the correct subclass to use.
+            source_artifact (wandb.Artifact): An artifact which will hold any additional
+                resources which were stored during the `to_json` function.
 
         Returns:
             wandb.Value: a newly created instance of a subclass of wandb.Value
@@ -149,7 +156,7 @@ class WBValue:
 
     @staticmethod
     def type_mapping() -> "TypeMappingType":
-        """Returns a map from `_log_type` to subclass. Used to lookup correct types for deserialization.
+        """Return a map from `_log_type` to subclass. Used to lookup correct types for deserialization.
 
         Returns:
             dict: dictionary of str:class
@@ -175,7 +182,7 @@ class WBValue:
         return not self.__eq__(other)
 
     def to_data_array(self) -> List[Any]:
-        """Converts the object to a list of primitives representing the underlying data"""
+        """Convert the object to a list of primitives representing the underlying data."""
         raise NotImplementedError
 
     def _set_artifact_source(