safetensors 0.5.0__cp38-abi3-win_amd64.whl → 0.5.1__cp38-abi3-win_amd64.whl

safetensors/__init__.pyi

@@ -5,11 +5,11 @@ def deserialize(bytes):
     Opens a safetensors lazily and returns tensors as asked
 
     Args:
-        data (:obj:`bytes`):
+        data (`bytes`):
             The byte content of a file
 
     Returns:
-        (:obj:`List[str, Dict[str, Dict[str, any]]]`):
+        (`List[str, Dict[str, Dict[str, any]]]`):
             The deserialized content is like:
                 [("tensor_name", {"shape": [2, 3], "dtype": "F32", "data": b"\0\0.." }), (...)]
     """
@@ -21,14 +21,14 @@ def serialize(tensor_dict, metadata=None):
     Serializes raw data.
 
     Args:
-        tensor_dict (:obj:`Dict[str, Dict[Any]]`):
+        tensor_dict (`Dict[str, Dict[Any]]`):
             The tensor dict is like:
                 {"tensor_name": {"dtype": "F32", "shape": [2, 3], "data": b"\0\0"}}
-        metadata (:obj:`Dict[str, str]`, *optional*):
+        metadata (`Dict[str, str]`, *optional*):
             The optional purely text annotations
 
     Returns:
-        (:obj:`bytes`):
+        (`bytes`):
             The serialized content.
     """
     pass
@@ -39,16 +39,16 @@ def serialize_file(tensor_dict, filename, metadata=None):
     Serializes raw data.
 
     Args:
-        tensor_dict (:obj:`Dict[str, Dict[Any]]`):
+        tensor_dict (`Dict[str, Dict[Any]]`):
             The tensor dict is like:
                 {"tensor_name": {"dtype": "F32", "shape": [2, 3], "data": b"\0\0"}}
-        filename (:obj:`str`):
+        filename (`str`, or `os.PathLike`):
             The name of the file to write into.
-        metadata (:obj:`Dict[str, str]`, *optional*):
+        metadata (`Dict[str, str]`, *optional*):
             The optional purely text annotations
 
     Returns:
-        (:obj:`bytes`):
+        (`bytes`):
             The serialized content.
     """
     pass
@@ -58,16 +58,92 @@ class safe_open:
     Opens a safetensors lazily and returns tensors as asked
 
     Args:
-        filename (:obj:`str`):
+        filename (`str`, or `os.PathLike`):
             The filename to open
 
-        framework (:obj:`str`):
-            The framework you want your tensors in. Supported values:
+        framework (`str`):
+            The framework you want you tensors in. Supported values:
             `pt`, `tf`, `flax`, `numpy`.
 
-        device (:obj:`str`, defaults to :obj:`"cpu"`):
+        device (`str`, defaults to `"cpu"`):
             The device on which you want the tensors.
     """
 
-    def __init__(self, filename, framework, device="cpu"):
+    def __init__(filename, framework, device=...):
         pass
+    def __enter__(self):
+        """
+        Start the context manager
+        """
+        pass
+    def __exit__(self, _exc_type, _exc_value, _traceback):
+        """
+        Exits the context manager
+        """
+        pass
+    def get_slice(self, name):
+        """
+        Returns a full slice view object
+
+        Args:
+            name (`str`):
+                The name of the tensor you want
+
+        Returns:
+            (`PySafeSlice`):
+                A dummy object you can slice into to get a real tensor
+        Example:
+        ```python
+        from safetensors import safe_open
+
+        with safe_open("model.safetensors", framework="pt", device=0) as f:
+            tensor_part = f.get_slice("embedding")[:, ::8]
+
+        ```
+        """
+        pass
+    def get_tensor(self, name):
+        """
+        Returns a full tensor
+
+        Args:
+            name (`str`):
+                The name of the tensor you want
+
+        Returns:
+            (`Tensor`):
+                The tensor in the framework you opened the file for.
+
+        Example:
+        ```python
+        from safetensors import safe_open
+
+        with safe_open("model.safetensors", framework="pt", device=0) as f:
+            tensor = f.get_tensor("embedding")
+
+        ```
+        """
+        pass
+    def keys(self):
+        """
+        Returns the names of the tensors in the file.
+
+        Returns:
+            (`List[str]`):
+                The name of the tensors contained in that file
+        """
+        pass
+    def metadata(self):
+        """
+        Return the special non tensor information in the header
+
+        Returns:
+            (`Dict[str, str]`):
+                The freeform metadata.
+        """
+        pass
+
+class SafetensorError(Exception):
+    """
+    Custom Python Exception for Safetensor errors.
+    """

{safetensors-0.5.0.dist-info → safetensors-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: safetensors
-Version: 0.5.0
+Version: 0.5.1
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education

{safetensors-0.5.0.dist-info → safetensors-0.5.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
-safetensors-0.5.0.dist-info/METADATA,sha256=ayT6ICSu_GWfjkVeNIUo54Gr0oyAeZVzCZXuIZgvUGs,3902
-safetensors-0.5.0.dist-info/WHEEL,sha256=mYDPFrpmO1_UhonyEoMo2i0zHOwqc92hj_Q3CYuEBdM,94
+safetensors-0.5.1.dist-info/METADATA,sha256=uFpXvzQlZ9qoi1joyCsHVw35woQhc50dY02xuZxn5OI,3902
+safetensors-0.5.1.dist-info/WHEEL,sha256=mYDPFrpmO1_UhonyEoMo2i0zHOwqc92hj_Q3CYuEBdM,94
 safetensors/flax.py,sha256=lyCfXWTwOqkKvfIbsfy1lTNoslqZm5RjBvvg6d1ZNZU,3984
 safetensors/mlx.py,sha256=MfhCBl9M9uW5BnFngRg3CNobi7fZXxS3ulJ9so82cNE,3975
 safetensors/numpy.py,sha256=HBAwy9bXQIKM_uk328kXiZ8tAIhtiq4usngqAWu_l8Y,5113
@@ -8,6 +8,6 @@ safetensors/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 safetensors/tensorflow.py,sha256=hvOLFjirEm-mZlzKcwbeNZutgcKtUxnaEP2VlrGd-Zc,4027
 safetensors/torch.py,sha256=8IEyIkBIYLL9lTSqtabsuZspVHgptYYc1X2d8S8AWXs,18325
 safetensors/__init__.py,sha256=xxEn5gc4JWHjA0wnafb0Wwwq1m2QXwlbm5nsItGRqO0,180
-safetensors/__init__.pyi,sha256=C_f5av3UsqpI042F4N3EDdZjeBTahOBcS5aMAArrE7E,2044
-safetensors/_safetensors_rust.pyd,sha256=UJmWcxKLUO9QZAnoIvCuckHOE6hRLnKSiJHxxHUqaxs,670720
-safetensors-0.5.0.dist-info/RECORD,,
+safetensors/__init__.pyi,sha256=5TwX35SbOMXsbK0srQFQaX2YlIGso4o9V82VJ7nZ-Mc,3899
+safetensors/_safetensors_rust.pyd,sha256=R16hvpW3T5ezix-yFRGi8IBqFC8ByGgIroptMQFm9TQ,670720
+safetensors-0.5.1.dist-info/RECORD,,