feat: Make face recognition learning rate and model configurable through env vars

Author: dormant-user

docs/_sources/index.rst.txt

@@ -766,6 +766,12 @@ Enums
 
 ====
 
+.. autoclass:: jarvis.modules.models.enums.FaceRecognitionModel(Enum)
+   :members:
+   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
+
+====
+
 .. autoclass:: jarvis.modules.models.enums.ReminderOptions(Enum)
    :members:
    :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_

docs/index.html

@@ -7338,6 +7338,7 @@ <h1>Enums<a class="headerlink" href="#enums" title="Link to this heading">¶</a>
 
 </dd></dl>
 
+<hr class="docutils" />
 <hr class="docutils" />
 <dl class="py class">
 <dt class="sig sig-object py" id="jarvis.modules.models.enums.ReminderOptions">

docs_gen/index.rst

@@ -766,6 +766,12 @@ Enums
 
 ====
 
+.. autoclass:: jarvis.modules.models.enums.FaceRecognitionModel(Enum)
+   :members:
+   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
+
+====
+
 .. autoclass:: jarvis.modules.models.enums.ReminderOptions(Enum)
    :members:
    :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_

jarvis/modules/facenet/face.py

@@ -105,10 +105,6 @@ class FaceNet:
         If unable to connect to the camera.
     """
 
-    # TODO: Allow config via env vars
-    LEARNING_RATE = 0.6  # tolerance level - keep switching this until you find perfection in recognition
-    MODEL = "hog"  # model using which the images are matched
-
     def __init__(self):
         """Instantiates the ``Processor`` object and sources the camera hardware."""
         self.validation_video = cv2.VideoCapture(models.env.camera_index or 0)
@@ -161,12 +157,16 @@ def recognizer(self, location: str | FilePath, retry_count: int = 20) -> str | N
                 logger.warning("Unable to read from camera index: %d", models.env.camera_index or 0)
                 continue
             # gets image from the video read above
-            identifier = face_recognition.face_locations(img, model=self.MODEL)
+            identifier = face_recognition.face_locations(img, model=models.env.face_recognition_model)
             # creates an encoding for the image
-            encoded_ = face_recognition.face_encodings(img, identifier)
+            encoded_ = face_recognition.face_encodings(face_image=img, known_face_locations=identifier)
             for face_encoding, face_location in zip(encoded_, identifier):
                 # using learning_rate, the encoding is matched against the encoded matrix for images in named directory
-                results = face_recognition.compare_faces(self.train_faces, face_encoding, self.LEARNING_RATE)
+                results = face_recognition.compare_faces(
+                    known_face_encodings=self.train_faces,
+                    face_encoding_to_check=face_encoding,
+                    tolerance=models.env.face_recognition_learning_rate,
+                )
                 # if a match is found the directory name is rendered and returned as match value
                 if True in results:
                     return self.train_names[results.index(True)]

jarvis/modules/models/classes.py

@@ -45,6 +45,7 @@
 from jarvis import indicators, scripts
 from jarvis.modules.exceptions import InvalidEnvVars, UnsupportedOS
 from jarvis.modules.models import enums, env_file, squire
+from jarvis.modules.models.enums import FaceRecognitionModel
 
 AUDIO_DRIVER = pyttsx3.init()
 platform_info: List[str] = platform.platform(terse=True).split("-")
@@ -346,6 +347,10 @@ class EnvConfig(BaseSettings):
     wifi_ssid: str | None = None
     wifi_password: str | None = None
 
+    # Face Recognition
+    face_recognition_learning_rate: int | float = Field(0.5, le=1, ge=0)
+    face_recognition_model: enums.FaceRecognitionModel = FaceRecognitionModel.hog
+
     wake_words: List[str] = Field(["jarvis"])
 
     class Config:

jarvis/modules/models/enums.py

@@ -60,6 +60,13 @@ class StartupOptions(StrEnum):
     thermostat = "thermostat"
 
 
+class FaceRecognitionModel(StrEnum):
+    """Face recognition model supported by Jarvis."""
+
+    hog = "hog"
+    cnn = "cnn"
+
+
 class TemperatureUnits(StrEnum):
     """Types of temperature units supported by Jarvis.