feat: Add CSV ingestion support for Frames

aperturedb/CommonLibrary.py

@@ -16,6 +16,7 @@
 from aperturedb.ConnectorRest import ConnectorRest
 from aperturedb.types import Blobs, CommandResponses, Commands
 from aperturedb.LoggingUtils import censor_tokens
+from aperturedb.Constants import BLOB_FIND_COMMANDS
 
 logger = logging.getLogger(__name__)
 
@@ -383,9 +384,7 @@ def map_response_to_handler(handler, query, query_blobs,  response, response_blo
         if is_list:
             for req, resp in zip(query[start:end], response[start:end]):
                 for k in req:
-                    blob_returning_commands = ["FindImage", "FindBlob", "FindVideo",
-                                               "FindDescriptor", "FindBoundingBox"]
-                    if k in blob_returning_commands and "blobs" in req[k] and req[k]["blobs"]:
+                    if k in BLOB_FIND_COMMANDS and "blobs" in req[k] and req[k]["blobs"]:
                         count = resp[k]["returned"]
                         b_count += count
 

aperturedb/Constants.py

@@ -0,0 +1,33 @@
+"""
+Shared constants for the ApertureDB Python SDK.
+"""
+
+BLOB_ADD_COMMANDS = frozenset({
+    "AddImage",
+    "AddDescriptor",
+    "AddVideo",
+    "AddBlob",
+    "AddFrame"
+})
+
+BLOB_FIND_COMMANDS = frozenset({
+    "FindImage",
+    "FindDescriptor",
+    "FindVideo",
+    "FindBlob",
+    "FindFrame",
+    "FindBoundingBox"
+})
+
+OPENCV_DECODE_FIND_COMMANDS = frozenset({
+    "FindImage",
+    "FindFrame"
+})
+
+PROPERTY_ADD_COMMANDS = frozenset({
+    "AddImage",
+    "AddVideo",
+    "AddBoundingBox",
+    "AddPolygon",
+    "AddFrame"
+})

aperturedb/DataModels.py

@@ -70,7 +70,7 @@ class PolygonDataModel(IdentityDataModel):
     type = ObjectType.POLYGON
 
 
-class FrameDataModel(IdentityDataModel):
+class FrameDataModel(BlobDataModel):
     """Frame data model for ApertureDB.
     """
     type = ObjectType.FRAME

aperturedb/Entities.py

@@ -278,6 +278,7 @@ def get_blob(self, entity) -> Any:
 def load_entities_registry(custom_entities: List[str] = None) -> dict:
     from aperturedb.Polygons import Polygons
     from aperturedb.Images import Images
+    from aperturedb.Frames import Frames
     from aperturedb.Blobs import Blobs
     from aperturedb.BoundingBoxes import BoundingBoxes
     from aperturedb.Videos import Videos
@@ -287,6 +288,7 @@ def load_entities_registry(custom_entities: List[str] = None) -> dict:
     known_entities = {
         ObjectType.POLYGON.value: Polygons,
         ObjectType.IMAGE.value: Images,
+        ObjectType.FRAME.value: Frames,
         ObjectType.VIDEO.value: Videos,
         ObjectType.BOUNDING_BOX.value: BoundingBoxes,
         ObjectType.BLOB.value: Blobs,

aperturedb/FrameDataCSV.py

@@ -0,0 +1,19 @@
+from aperturedb.ImageDataCSV import ImageDataCSV
+from aperturedb.Query import ObjectType
+
+
+class FrameDataCSV(ImageDataCSV):
+    """
+    **Helper class to ingest Frame data from a CSV file.**
+
+    This class extends ImageDataCSV and sets the insertion command to "AddFrame",
+    allowing frame files to be batch ingested from CSVs just like images.
+    """
+    command = "AddFrame"
+
+    def get_indices(self):
+        return {
+            "entity": {
+                ObjectType.FRAME.value: self.get_indexed_properties()
+            }
+        }

aperturedb/Frames.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from aperturedb.Images import Images
+from aperturedb.Query import ObjectType
+
+
+class Frames(Images):
+    """
+    **The python wrapper of frame images in ApertureDB.**
+
+    Frames in ApertureDB are quite similar to images and so
+    are modeled in python as a subclass.
+
+
+    Args:
+        client: The database connector, perhaps as returned by `CommonLibrary.create_connector`
+    """
+    db_object = ObjectType.FRAME
+
+    def __init__(self, client, batch_size=100, response=None, **kwargs):
+        super().__init__(
+            client, batch_size=batch_size, response=response, **kwargs)

aperturedb/ImageDataCSV.py

@@ -171,6 +171,7 @@ class ImageDataCSV(CSVParser.CSVParser, ImageDataProcessor):
     id would be only inserted if it does not already exist in the database.
     :::
     """
+    command = "AddImage"
 
     def __init__(self, filename: str, check_image: bool = True, n_download_retries: int = 3, **kwargs):
 
@@ -199,8 +200,6 @@ def __init__(self, filename: str, check_image: bool = True, n_download_retries:
         self.relative_path_prefix = os.path.dirname(self.filename) \
             if self.source_type == HEADER_PATH and self.blobs_relative_to_csv else ""
 
-        self.command = "AddImage"
-
     def getitem(self, idx):
         idx = self.df.index.start + idx
 

aperturedb/Images.py

@@ -3,7 +3,10 @@
 """
 
 from __future__ import annotations
-from typing import Any, Dict, Iterable, List, Tuple, Union
+from typing import Any, Dict, Iterable, List, Tuple, Union, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from aperturedb.Frames import Frames
 import cv2
 import math
 import numpy as np
@@ -1003,18 +1006,13 @@ def get_properties(self, prop_list: Iterable[str] = []) -> Dict[str, Any]:
         return return_dictionary
 
 
-class Frames(Images):
-    """
-    **The python wrapper of frame images in ApertureDB.**
-
-    Frames in ApertureDB are quite similar to images and so
-    are modeled in python as a subclass.
-
+def __getattr__(name: str):
+    if name == "Frames":
+        from aperturedb.Frames import Frames
+        globals()[name] = Frames
+        return Frames
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
 
-    Args:
-        client: The database connector, perhaps as returned by `CommonLibrary.create_connector`
-    """
-    db_object = ObjectType.FRAME
 
-    def __init__(self, client, batch_size=100, response=None, **kwargs):
-        super().__init__(client, batch_size=batch_size, response=response, **kwargs)
+def __dir__():
+    return sorted(set(list(globals().keys()) + ["Frames"]))

aperturedb/MLCroissant.py

@@ -14,7 +14,14 @@
 from aperturedb.Query import QueryBuilder
 from aperturedb.DataModels import IdentityDataModel
 from aperturedb.Query import generate_add_query
+from aperturedb.Constants import BLOB_ADD_COMMANDS
 
+# Commands for which we do not want to automatically create entity indices.
+# AddDescriptor is intentionally excluded from this skip list because descriptor
+# indices are explicitly required for similarity search and must be created.
+_CROISSANT_SKIP_INDEX_COMMANDS = frozenset(
+    cmd for cmd in BLOB_ADD_COMMANDS if cmd != "AddDescriptor"
+)
 
 logger = logging.getLogger(__name__)
 
@@ -273,7 +280,7 @@ def getitem(self, subscript):
         indexes_to_create = []
         for command in q:
             cmd = list(command.keys())[-1]
-            if cmd in ["AddImage", "AddBlob", "AddVideo"]:
+            if cmd in _CROISSANT_SKIP_INDEX_COMMANDS:
                 continue
             indexable_entity = command[list(command.keys())[-1]]["class"]
             if indexable_entity not in self.indexed_entities:

aperturedb/PyTorchDataset.py

@@ -1,14 +1,14 @@
 import math
 import numpy as np
 import cv2
+from aperturedb.Constants import BLOB_FIND_COMMANDS, OPENCV_DECODE_FIND_COMMANDS
 import logging
 
 from torch.utils import data
 
 from aperturedb.CommonLibrary import execute_query
 from aperturedb.Connector import Connector
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -17,7 +17,7 @@ class ApertureDBDataset(data.Dataset):
     This class implements a PyTorch Dataset for ApertureDB.
     It is used to load blobs returned by a `Find*` command from ApertureDB into a PyTorch model.
     It can be initialized with a query that will be used to retrieve
-    the blobs from ApertureDB. Note that only `FindImage` blobs are decoded via OpenCV.
+    the blobs from ApertureDB. Note that only `FindImage` and `FindFrame` blobs are decoded via OpenCV.
     """
 
     def __init__(self, client: Connector, query, label_prop=None, batch_size=1, command_idx=None):
@@ -35,24 +35,19 @@ def __init__(self, client: Connector, query, label_prop=None, batch_size=1, comm
         self.batch_end = 0
         self.label_prop = label_prop
 
-        allowed_find_commands = {
-            "FindImage", "FindVideo", "FindBlob",
-            "FindDescriptor", "FindBoundingBox"
-        }
-
         if self.command_idx is not None:
             if not (0 <= self.command_idx < len(query)):
                 raise ValueError(
                     f"command_idx {self.command_idx} is out of range.")
             self.command_name = list(query[self.command_idx].keys())[0]
-            if self.command_name not in allowed_find_commands:
+            if self.command_name not in BLOB_FIND_COMMANDS:
                 raise ValueError(
                     f"Command at index {self.command_idx} is "
                     f"{self.command_name}, which is not a supported blob-returning Find* command.")
         else:
             for i in range(len(query)):
                 name = list(query[i].keys())[0]
-                if name in allowed_find_commands:
+                if name in BLOB_FIND_COMMANDS:
                     if self.command_idx is not None:
                         logger.warning(
                             "Multiple Find commands found. Selected %s at index %s.", self.command_name, self.command_idx)
@@ -61,7 +56,7 @@ def __init__(self, client: Connector, query, label_prop=None, batch_size=1, comm
                     self.command_name = name
 
         if self.command_idx is None:
-            msg = "Query error. The query must contain at least one supported blob-returning Find command (e.g., FindImage, FindVideo, FindBlob). The first one encountered will be used."
+            msg = "Query error. The query must contain at least one supported blob-returning Find command (e.g., FindImage, FindVideo, FindBlob, FindFrame). The first one encountered will be used."
             logger.error(msg)
             raise ValueError(msg)
 
@@ -77,7 +72,7 @@ def __init__(self, client: Connector, query, label_prop=None, batch_size=1, comm
 
         for i in range(len(self.query)):
             name = list(self.query[i].keys())[0]
-            if name in allowed_find_commands and i != self.command_idx:
+            if name in BLOB_FIND_COMMANDS and i != self.command_idx:
                 self.query[i][name]["blobs"] = False
 
         self.query[self.command_idx][self.command_name]["batch"] = {}
@@ -111,7 +106,7 @@ def __getitem__(self, index):
         blob = self.batch_blobs[idx]
         label = self.batch_labels[idx]
 
-        if self.command_name == "FindImage":
+        if self.command_name in OPENCV_DECODE_FIND_COMMANDS:
             nparr = np.frombuffer(blob, dtype=np.uint8)
             blob = cv2.imdecode(nparr, cv2.IMREAD_COLOR)
             if blob is None:

aperturedb/Query.py

@@ -227,7 +227,7 @@ def generate_add_query(
                 params.pop("properties", None)
                 query.append(
                     QueryBuilder.find_command(obj.type.value, params=params))
-        if obj.type in [ObjectType.IMAGE, ObjectType.VIDEO, ObjectType.BLOB]:
+        if obj.type in [ObjectType.IMAGE, ObjectType.VIDEO, ObjectType.BLOB, ObjectType.FRAME]:
             # Do not send blob, if Node has been added to set of commands.
             if obj.id not in cached:
                 if obj.url:

aperturedb/TensorFlowDataset.py

@@ -5,6 +5,7 @@
 
 from aperturedb.CommonLibrary import execute_query
 from aperturedb.Connector import Connector
+from aperturedb.Constants import BLOB_FIND_COMMANDS, OPENCV_DECODE_FIND_COMMANDS
 
 logger = logging.getLogger(__name__)
 
@@ -14,7 +15,7 @@ class ApertureDBTensorFlowDataset:
     This class implements a TensorFlow Dataset for ApertureDB.
     It is used to load blobs returned by a `Find*` command from ApertureDB into a TensorFlow model.
     It can be initialized with a query that will be used to retrieve
-    the blobs from ApertureDB. Note that only `FindImage` blobs are decoded via OpenCV.
+    the blobs from ApertureDB. Note that only `FindImage` and `FindFrame` blobs are decoded via OpenCV.
     """
 
     def __init__(self, client: Connector, query, label_prop=None, batch_size=1, command_idx=None):
@@ -33,10 +34,7 @@ def __init__(self, client: Connector, query, label_prop=None, batch_size=1, comm
         self.label_prop = label_prop
         self.label_type = None
 
-        allowed_find_commands = {
-            "FindImage", "FindVideo", "FindBlob",
-            "FindDescriptor", "FindBoundingBox"
-        }
+        allowed_find_commands = BLOB_FIND_COMMANDS
 
         if self.command_idx is not None:
             if not (0 <= self.command_idx < len(query)):
@@ -59,7 +57,7 @@ def __init__(self, client: Connector, query, label_prop=None, batch_size=1, comm
                     self.command_name = name
 
         if self.command_idx is None:
-            msg = "Query error. The query must contain at least one supported blob-returning Find command (e.g., FindImage, FindVideo, FindBlob). The first one encountered will be used."
+            msg = "Query error. The query must contain at least one supported blob-returning Find command (e.g., FindImage, FindVideo, FindBlob, FindFrame). The first one encountered will be used."
             logger.error(msg)
             raise ValueError(msg)
 
@@ -177,7 +175,7 @@ def generator(self):
             blob = self.batch_blobs[idx]
             label = self.batch_labels[idx]
 
-            if self.command_name == "FindImage":
+            if self.command_name in OPENCV_DECODE_FIND_COMMANDS:
                 nparr = np.frombuffer(blob, dtype=np.uint8)
                 blob = cv2.imdecode(nparr, cv2.IMREAD_COLOR)
                 if blob is None:
@@ -226,7 +224,7 @@ def get_dataset(self):
             else:
                 self.label_type = tf.string
 
-        if self.command_name == "FindImage":
+        if self.command_name in OPENCV_DECODE_FIND_COMMANDS:
             tensor_shape = (None, None, 3)
             tensor_dtype = tf.uint8
         else:

aperturedb/Utils.py

@@ -914,6 +914,7 @@ def remove_all_objects(self) -> bool:
         transaction = [
             {"DeleteImage": cmd},
             {"DeleteVideo": cmd},
+            {"DeleteFrame": cmd},
             {"DeleteBlob": cmd},
             {"DeleteClip": cmd},
             # DeleteDescriptorSet also deletes the descriptors
@@ -924,7 +925,6 @@ def remove_all_objects(self) -> bool:
             # We keep them here until ApertureDB fully implements this.
             {"DeleteBoundingBox": cmd},
             {"DeletePolygon": cmd},
-            {"DeleteFrame": cmd},
             {"DeleteEntity": cmd},
             {"GetSchema": {"refresh": True}}
         ]

aperturedb/cli/ingest.py

@@ -194,6 +194,7 @@ def from_csv(filepath: Annotated[str, typer.Argument(
     Ingest data from a pre generated CSV file.
     """
     from aperturedb.ImageDataCSV import ImageDataCSV
+    from aperturedb.FrameDataCSV import FrameDataCSV
     from aperturedb.BBoxDataCSV import BBoxDataCSV
     from aperturedb.EntityDataCSV import EntityDataCSV
     from aperturedb.BlobDataCSV import BlobDataCSV
@@ -210,6 +211,7 @@ def from_csv(filepath: Annotated[str, typer.Argument(
         IngestType.DESCRIPTOR: DescriptorDataCSV,
         IngestType.DESCRIPTORSET: DescriptorSetDataCSV,
         IngestType.ENTITY: EntityDataCSV,
+        IngestType.FRAME: FrameDataCSV,
         IngestType.IMAGE: ImageDataCSV,
         IngestType.POLYGON: PolygonDataCSV,
         IngestType.VIDEO: VideoDataCSV

aperturedb/transformers/clip_pytorch_embeddings.py

@@ -1,3 +1,4 @@
+from aperturedb.Constants import BLOB_ADD_COMMANDS
 import hashlib
 import logging
 from aperturedb.Subscriptable import Subscriptable
@@ -95,7 +96,7 @@ def getitem(self, subscript):
                     except Exception as e:
                         logger.warning(
                             f"Failed to generate embedding or descriptor: {e}", exc_info=True)
-            if cmd_name in ["AddImage", "AddDescriptor", "AddVideo", "AddBlob"]:
+            if cmd_name in BLOB_ADD_COMMANDS:
                 blob_index += 1
 
         x[0].extend(new_descriptors)