samgis_core 1.1.0__py3-none-any.whl → 1.1.2__py3-none-any.whl

samgis_core/prediction_api/sam_onnx.py

@@ -32,7 +32,7 @@ from onnxruntime import get_available_providers, InferenceSession
 
 from samgis_core import app_logger, MODEL_FOLDER
 from samgis_core.utilities.constants import DEFAULT_INPUT_SHAPE, MODEL_ENCODER_NAME, MODEL_DECODER_NAME
-from samgis_core.utilities.type_hints import PIL_Image, list_dict, tuple_ndarr_int, EmbeddingDict, EmbeddingImage
+from samgis_core.utilities.type_hints import PIL_Image, ListDict, TupleNdarrayInt, EmbeddingDict, EmbeddingImage
 
 
 class SegmentAnythingONNX:
@@ -197,6 +197,12 @@ class SegmentAnythingONNX:
     def encode(self, cv_image: ndarray) -> EmbeddingImage:
         """
         Calculate embedding and metadata for a single image.
+
+        Args:
+            cv_image: input image to embed
+
+        Returns:
+            embedding image dict useful to store and cache image embeddings
         """
         original_size = cv_image.shape[:2]
 
@@ -251,8 +257,8 @@ class SegmentAnythingONNX:
 
 
 def get_raster_inference(
-        img: PIL_Image or ndarray, prompt: list_dict, models_instance: SegmentAnythingONNX, model_name: str
-) -> tuple_ndarr_int:
+        img: PIL_Image or ndarray, prompt: ListDict, models_instance: SegmentAnythingONNX, model_name: str
+) -> TupleNdarrayInt:
     """
     Get inference output for a given image using a SegmentAnythingONNX model
 
@@ -312,7 +318,7 @@ def get_inference_embedding(
 
 
 def get_raster_inference_using_existing_embedding(
-        embedding: dict, prompt: list_dict, models_instance: SegmentAnythingONNX) -> tuple_ndarr_int:
+        embedding: dict, prompt: ListDict, models_instance: SegmentAnythingONNX) -> TupleNdarrayInt:
     """
     Get inference output for a given image using a SegmentAnythingONNX model, using an existing embedding instead of a
     new ndarray or PIL image
@@ -339,8 +345,8 @@ def get_raster_inference_using_existing_embedding(
 
 
 def get_raster_inference_with_embedding_from_dict(
-        img: PIL_Image or ndarray, prompt: list_dict, models_instance: SegmentAnythingONNX, model_name: str,
-        embedding_key: str, embedding_dict: dict) -> tuple_ndarr_int:
+        img: PIL_Image or ndarray, prompt: ListDict, models_instance: SegmentAnythingONNX, model_name: str,
+        embedding_key: str, embedding_dict: dict) -> TupleNdarrayInt:
     """
     Get inference output using a SegmentAnythingONNX model, but get the image embedding from the given embedding dict
      instead of creating a new embedding. This function needs the img argument to update the embedding dict if necessary
@@ -351,7 +357,7 @@ def get_raster_inference_with_embedding_from_dict(
         models_instance: SegmentAnythingONNX instance model
         model_name: model name string
         embedding_key: embedding id
-        embedding_dict: embedding dict object
+        embedding_dict: embedding images dict
 
     Returns:
         raster prediction mask, prediction number

samgis_core/utilities/serialize.py

@@ -2,7 +2,6 @@
 from typing import Mapping
 
 from samgis_core import app_logger
-from samgis_core.utilities.type_hints import dict_str, dict_str_any
 
 
 def serialize(obj: any, include_none: bool = False):
@@ -74,11 +73,11 @@ def _serialize_list(ls: list, include_none: bool) -> list:
     return [_serialize(elem, include_none) for elem in ls]
 
 
-def _serialize_bytes(b: bytes) -> dict_str:
+def _serialize_bytes(b: bytes) -> dict[str, str]:
     import base64
     encoded = base64.b64encode(b)
     return {"value": encoded.decode('ascii'), "type": "bytes"}
 
 
-def _serialize_exception(e: Exception) -> dict_str_any:
+def _serialize_exception(e: Exception) -> dict[str, str]:
     return {"msg": str(e), "type": str(type(e)), **e.__dict__}

samgis_core/utilities/type_hints.py

@@ -1,22 +1,47 @@
 """custom type hints"""
 from enum import Enum
-from typing import TypedDict
+from typing import TypedDict, NewType
 
 from PIL.Image import Image
 from numpy import ndarray
 
 
-dict_str_int = dict[str, int]
-dict_str = dict[str]
-dict_str_any = dict[str, any]
-list_dict = list[dict]
-list_float = list[float]
-list_int = list[int]
-tuple_int = tuple[int]
-tuple_ndarr_int = tuple[ndarray, int]
-llist_float = list[list_float]
-tuple_float = tuple[float]
-tuple_float_any = tuple[float, any]
+class DictStrInt(dict[str, int]): pass
+
+
+class DictStr(dict[str]): pass
+
+
+class DictStrAny(dict[str, any]): pass
+
+
+class ListDict(list[dict]): pass
+
+
+class ListFloat(list[float]): pass
+
+
+class ListInt(list[int]): pass
+
+
+class TupleInt(tuple[int]): pass
+
+
+class TupleNdarrayInt(tuple[ndarray, int]): pass
+
+
+class TupleNdarrayFloat(tuple[ndarray, float]): pass
+
+
+class LlistFloat(ListFloat): pass
+
+
+class TupleFloat(tuple[float]): pass
+
+
+class TupleFloatAny(tuple[float, any]): pass
+
+
 PIL_Image = Image
 
 
@@ -26,7 +51,7 @@ class StrEnum(str, Enum):
 
 class EmbeddingImage(TypedDict):
     image_embedding: ndarray
-    original_size: tuple_int
+    original_size: TupleInt
     transform_matrix: ndarray
 
 

{samgis_core-1.1.0.dist-info → samgis_core-1.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: samgis_core
-Version: 1.1.0
+Version: 1.1.2
 Summary: SamGIS CORE
 License: MIT
 Author: alessandro trinca tornidor

{samgis_core-1.1.0.dist-info → samgis_core-1.1.2.dist-info}/RECORD

@@ -1,13 +1,13 @@
 samgis_core/__init__.py,sha256=1kFX8G22dxNz23J7uOYl-SMWOe4W1olssc-5zKAVwSc,351
 samgis_core/__version__.py,sha256=x-8LeQkljky-ao1MyT98tSQE1xNvJp3LelqsAdCb9Og,94
 samgis_core/prediction_api/__init__.py,sha256=_jUZhspS26ygiSzBJywfZ4fQf9X7oC8w6oxvhd9S2hQ,57
-samgis_core/prediction_api/sam_onnx.py,sha256=G5jJUyidLC_-9VrVmQRUHQpKQHW-vnv_EC7ppNap9VI,15172
+samgis_core/prediction_api/sam_onnx.py,sha256=YEX6UOFKcqPiuF_SCPAcK_gCmxoj4lvTLNNDul2htZ8,15320
 samgis_core/utilities/__init__.py,sha256=nL9pzdB4SdEF8m5gCbtlVCtdGLg9JjPm-FNxKBsIBZA,32
 samgis_core/utilities/constants.py,sha256=645W57jrUNbnujgUwCietfr-rECENDXLGmHeD2YoSwg,157
 samgis_core/utilities/fastapi_logger.py,sha256=yt8Vj1viyE-Kry1_iy5p4saZvGEEmRfuTEMHYXgnjqk,650
-samgis_core/utilities/serialize.py,sha256=iWi_m_7vL7Hmr3Lb5yASXU5DtoUU18M_JdwiRSOs9sI,2749
-samgis_core/utilities/type_hints.py,sha256=R-xfFbiGz12tuHqChlVI9GguR9Q7pxceFkCi_OmscM4,659
+samgis_core/utilities/serialize.py,sha256=aIjhEoibBpV_gpgOg6LiVxZCWjOkYxlzcboDZLQctJE,2689
+samgis_core/utilities/type_hints.py,sha256=iDkWiVB2B0W_GaRhdpypEra2FvQtwC5lNLVZr7a4yhU,845
 samgis_core/utilities/utilities.py,sha256=fP3cnxIYULYoCBft54EAivUR_fMcCDz2Z9AMpAO0zZ0,2434
-samgis_core-1.1.0.dist-info/METADATA,sha256=Zj7E1tpVyMtVbYH4uKYCTNqdYPrjuzgabs878EkNONw,892
-samgis_core-1.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-samgis_core-1.1.0.dist-info/RECORD,,
+samgis_core-1.1.2.dist-info/METADATA,sha256=KcYx7_-LSImFjrPf1EKBqpCPrE4Vxy2g6IqcHicUPjw,892
+samgis_core-1.1.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+samgis_core-1.1.2.dist-info/RECORD,,