Merge pull request #1290 from rohan-pandeyy/feat/adaptive-density-aware-face-clustering

 Face Quality and Adaptive Density-Aware Face Clustering

Author: rahulharpal1603

backend/app/config/settings.py

@@ -1,8 +1,13 @@
+from __future__ import annotations
+
+import logging
 import os
 import sys
-
 from platformdirs import user_data_dir
 
+logger = logging.getLogger(__name__)
+
+
 if getattr(sys, "frozen", False):
     MODEL_EXPORTS_PATH = os.path.join(user_data_dir("PictoPy"), "models")
 else:
@@ -35,3 +40,99 @@
     DATABASE_PATH = os.path.join(user_data_dir("PictoPy"), "database", "PictoPy.db")
 THUMBNAIL_IMAGES_PATH = os.path.join(user_data_dir("PictoPy"), "thumbnails")
 IMAGES_PATH = "./images"
+
+
+def _get_env_float(
+    name: str,
+    default: float,
+    min_value: float | None = None,
+    max_value: float | None = None,
+) -> float:
+    raw = os.getenv(name)
+    if raw is None:
+        return default
+    try:
+        value = float(raw)
+    except ValueError:
+        logger.warning(
+            "Invalid value %r for %s (expected float); using default %s",
+            raw,
+            name,
+            default,
+        )
+        return default
+    if (min_value is not None and value < min_value) or (
+        max_value is not None and value > max_value
+    ):
+        logger.warning(
+            "Out-of-range value %s for %s (expected [%s, %s]); using default %s",
+            value,
+            name,
+            min_value,
+            max_value,
+            default,
+        )
+        return default
+    return value
+
+
+def _get_env_int(
+    name: str,
+    default: int,
+    min_value: int | None = None,
+    max_value: int | None = None,
+) -> int:
+    raw = os.getenv(name)
+    if raw is None:
+        return default
+    try:
+        value = int(raw)
+    except ValueError:
+        logger.warning(
+            "Invalid value %r for %s (expected int); using default %s",
+            raw,
+            name,
+            default,
+        )
+        return default
+    if (min_value is not None and value < min_value) or (
+        max_value is not None and value > max_value
+    ):
+        logger.warning(
+            "Out-of-range value %s for %s (expected [%s, %s]); using default %s",
+            value,
+            name,
+            min_value,
+            max_value,
+            default,
+        )
+        return default
+    return value
+
+
+# Clustering Configuration
+PICTO_CLUSTERING_EPS = _get_env_float("PICTO_CLUSTERING_EPS", 0.75, min_value=0.0)
+PICTO_CLUSTERING_MIN_SAMPLES = _get_env_int(
+    "PICTO_CLUSTERING_MIN_SAMPLES", 2, min_value=1
+)
+if PICTO_CLUSTERING_MIN_SAMPLES < 2:
+    logger.warning(
+        f"PICTO_CLUSTERING_MIN_SAMPLES={PICTO_CLUSTERING_MIN_SAMPLES} is invalid "
+        f"(minimum is 2). Resetting to 2 to prevent cluster chaining."
+    )
+    PICTO_CLUSTERING_MIN_SAMPLES = 2
+PICTO_CLUSTERING_SIMILARITY_THRESHOLD = _get_env_float(
+    "PICTO_CLUSTERING_SIMILARITY_THRESHOLD", 0.85, min_value=0.0, max_value=1.0
+)
+PICTO_CLUSTERING_MERGE_THRESHOLD = _get_env_float(
+    "PICTO_CLUSTERING_MERGE_THRESHOLD", 0.7, min_value=0.0, max_value=1.0
+)
+PICTO_CLUSTERING_CONF_THRESHOLD = _get_env_float(
+    "PICTO_CLUSTERING_CONF_THRESHOLD", 0.45, min_value=0.0, max_value=1.0
+)
+PICTO_CLUSTERING_BLUR_THRESHOLD = _get_env_float(
+    "PICTO_CLUSTERING_BLUR_THRESHOLD", 80.0, min_value=0.0
+)
+PICTO_CLUSTERING_MIN_FACE_SIZE = _get_env_int(
+    "PICTO_CLUSTERING_MIN_FACE_SIZE", 1600, min_value=1
+)

backend/app/database/images.py

@@ -457,18 +457,22 @@ def db_toggle_image_favourite_status(image_id: str) -> bool:
     finally:
         conn.close()
 
+
 def db_get_image_by_id(image_id: str) -> Optional[dict]:
     """
     Get a single image by ID with its favorite status.
     """
     conn = _connect()
     cursor = conn.cursor()
     try:
-        cursor.execute("""
+        cursor.execute(
+            """
             SELECT id, path, folder_id, thumbnailPath, metadata, isTagged, isFavourite
             FROM images
             WHERE id = ?
-        """, (image_id,))
+        """,
+            (image_id,),
+        )
         row = cursor.fetchone()
         if not row:
             return None
@@ -488,6 +492,7 @@ def db_get_image_by_id(image_id: str) -> Optional[dict]:
     finally:
         conn.close()
 
+
 # ============================================================================
 # MEMORIES FEATURE - Location and Time-based Queries
 # ============================================================================

backend/app/models/FaceDetector.py

@@ -7,6 +7,12 @@
 from app.models.YOLO import YOLO
 from app.database.faces import db_insert_face_embeddings_by_image_id
 from app.logging.setup_logging import get_logger
+from app.config.settings import (
+    PICTO_CLUSTERING_CONF_THRESHOLD,
+    PICTO_CLUSTERING_BLUR_THRESHOLD,
+    PICTO_CLUSTERING_MIN_FACE_SIZE,
+)
+from app.utils.face_quality import face_passes_quality_gate
 
 # Initialize logger
 logger = get_logger(__name__)
@@ -16,7 +22,7 @@ class FaceDetector:
     def __init__(self):
         self.yolo_detector = YOLO(
             YOLO_util_get_model_path("face"),
-            conf_threshold=0.45,
+            conf_threshold=PICTO_CLUSTERING_CONF_THRESHOLD,
             iou_threshold=0.45,
         )
         self.facenet = FaceNet(FaceNet_util_get_model_path())
@@ -34,26 +40,38 @@ def detect_faces(self, image_id: str, image_path: str, forSearch: bool = False):
         logger.info(f"Detected {len(boxes)} faces in image {image_id}.")
 
         processed_faces, embeddings, bboxes, confidences = [], [], [], []
+        faces_skipped = 0
 
         for box, score in zip(boxes, scores):
-            if score > self.yolo_detector.conf_threshold:
-                x1, y1, x2, y2 = map(int, box)
+            x1, y1, x2, y2 = map(int, box)
 
-                # Create bounding box dictionary in JSON format
-                bbox = {"x": x1, "y": y1, "width": x2 - x1, "height": y2 - y1}
-                bboxes.append(bbox)
-                confidences.append(float(score))
+            padding = 20
+            face_img = img[
+                max(0, y1 - padding) : min(img.shape[0], y2 + padding),
+                max(0, x1 - padding) : min(img.shape[1], x2 + padding),
+            ]
 
-                padding = 20
-                face_img = img[
-                    max(0, y1 - padding) : min(img.shape[0], y2 + padding),
-                    max(0, x1 - padding) : min(img.shape[1], x2 + padding),
-                ]
-                processed_face = FaceNet_util_preprocess_image(face_img)
-                processed_faces.append(processed_face)
+            if not face_passes_quality_gate(
+                face_crop=face_img,
+                bbox=(x1, y1, x2, y2),
+                conf_score=float(score),
+                conf_threshold=self.yolo_detector.conf_threshold,
+                blur_threshold=PICTO_CLUSTERING_BLUR_THRESHOLD,
+                min_face_size=PICTO_CLUSTERING_MIN_FACE_SIZE,
+            ):
+                faces_skipped += 1
+                continue
 
-                embedding = self.facenet.get_embedding(processed_face)
-                embeddings.append(embedding)
+            # Create bounding box dictionary in JSON format
+            bbox = {"x": x1, "y": y1, "width": x2 - x1, "height": y2 - y1}
+            bboxes.append(bbox)
+            confidences.append(float(score))
+
+            processed_face = FaceNet_util_preprocess_image(face_img)
+            processed_faces.append(processed_face)
+
+            embedding = self.facenet.get_embedding(processed_face)
+            embeddings.append(embedding)
 
         if not forSearch and embeddings:
             db_insert_face_embeddings_by_image_id(
@@ -64,6 +82,7 @@ def detect_faces(self, image_id: str, image_path: str, forSearch: bool = False):
             "ids": f"{class_ids}",
             "processed_faces": processed_faces,
             "num_faces": len(embeddings),
+            "faces_skipped": faces_skipped,
         }
 
     def close(self):

backend/app/routes/face_clusters.py

@@ -9,8 +9,9 @@
     db_get_cluster_by_id,
     db_update_cluster,
     db_get_all_clusters_with_face_counts,
-    db_get_images_by_cluster_id,  # Add this import
+    db_get_images_by_cluster_id,
 )
+from app.utils.face_clusters import cluster_util_face_clusters_sync
 from app.schemas.face_clusters import (
     RenameClusterRequest,
     RenameClusterResponse,
@@ -313,24 +314,27 @@ def trigger_global_reclustering():
     try:
         logger.info("Starting manual global face reclustering...")
 
-        # Use the smart clustering function with force flag set to True
-        from app.utils.face_clusters import cluster_util_face_clusters_sync
-
-        result = cluster_util_face_clusters_sync(force_full_reclustering=True)
+        result, total_faces_skipped = cluster_util_face_clusters_sync(
+            force_full_reclustering=True
+        )
 
         if result == 0:
             return GlobalReclusterResponse(
                 success=True,
                 message="No faces found to cluster",
-                data=GlobalReclusterData(clusters_created=0),
+                data=GlobalReclusterData(
+                    clusters_created=0, faces_skipped=total_faces_skipped
+                ),
             )
 
         logger.info("Global reclustering completed successfully")
 
         return GlobalReclusterResponse(
             success=True,
             message="Global reclustering completed successfully.",
-            data=GlobalReclusterData(clusters_created=result),
+            data=GlobalReclusterData(
+                clusters_created=result, faces_skipped=total_faces_skipped
+            ),
         )
 
     except Exception as e:

backend/app/routes/images.py

@@ -106,15 +106,15 @@ def toggle_favourite(req: ToggleFavouriteRequest):
         success = db_toggle_image_favourite_status(image_id)
         if not success:
             raise HTTPException(
-                status_code=status.HTTP_404_NOT_FOUND, 
-                detail="Image not found or failed to toggle"
+                status_code=status.HTTP_404_NOT_FOUND,
+                detail="Image not found or failed to toggle",
             )
         # Fetch updated status to return
         image = db_get_image_by_id(image_id)
         if not image:
             raise HTTPException(
-                status_code=status.HTTP_404_NOT_FOUND, 
-                detail="Image not found after toggle"
+                status_code=status.HTTP_404_NOT_FOUND,
+                detail="Image not found after toggle",
             )
         return {
             "success": True,
@@ -126,10 +126,11 @@ def toggle_favourite(req: ToggleFavouriteRequest):
     except Exception as e:
         logger.error(f"error in /toggle-favourite route: {e}")
         raise HTTPException(
-            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, 
-            detail=f"Internal server error: {e}"
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            detail=f"Internal server error: {e}",
         )
 
+
 class ImageInfoResponse(BaseModel):
     id: str
     path: str

backend/app/schemas/face_clusters.py

@@ -76,6 +76,7 @@ class GetClusterImagesResponse(BaseModel):
 
 class GlobalReclusterData(BaseModel):
     clusters_created: Optional[int] = None
+    faces_skipped: Optional[int] = None
 
 
 class GlobalReclusterResponse(BaseModel):