chore: Update docstrings and comments (#119)

Bumps [gitpython](https://github.com/gitpython-developers/GitPython) from 3.1.49 to 3.1.50.
- [Release notes](https://github.com/gitpython-developers/GitPython/releases)
- [Changelog](https://github.com/gitpython-developers/GitPython/blob/main/CHANGES)
- [Commits](https://github.com/gitpython-developers/GitPython/compare/3.1.49...3.1.50)

---
updated-dependencies:
- dependency-name: gitpython
  dependency-version: 3.1.50
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

uniface/detection/retinaface.py

@@ -202,7 +202,7 @@ class RetinaFace(BaseDetector):
         height, width, _ = image.shape
         image_tensor = self.preprocess(image)
 
-        # ONNXRuntime inference
+        # Inference
         outputs = self.inference(image_tensor)
 
         # Postprocessing

uniface/detection/scrfd.py

@@ -247,9 +247,10 @@ class SCRFD(BaseDetector):
 
         image_tensor = self.preprocess(image)
 
-        # ONNXRuntime inference
+        # Inference
         outputs = self.inference(image_tensor)
 
+        # Postprocessing
         scores_list, bboxes_list, kpss_list = self.postprocess(outputs, image_size=image.shape[:2])
 
         # Handle case when no faces are detected

uniface/detection/yolov8.py

@@ -2,13 +2,6 @@
 # Author: Yakhyokhuja Valikhujaev
 # GitHub: https://github.com/yakhyo
 
-"""
-YOLOv8-Face detector implementation.
-
-Uses anchor-free design with DFL (Distribution Focal Loss) for bbox regression.
-Reference: https://github.com/yakhyo/yolov8-face-onnx-inference
-"""
-
 from typing import Any, Literal
 
 import numpy as np
@@ -273,16 +266,14 @@ class YOLOv8Face(BaseDetector):
         if len(keep) == 0:
             return np.array([]), np.array([])
 
-        # Limit to max_det
+        # Filter detections and limit to max_det
         keep = keep[: self.max_det]
         boxes = boxes[keep]
         scores = scores[keep]
         landmarks = landmarks[keep]
 
-        # === SCALE TO ORIGINAL IMAGE COORDINATES ===
+        # Scale back to original image coordinates
         pad_w, pad_h = padding
-
-        # Scale boxes back to original image coordinates
         boxes[:, [0, 2]] = (boxes[:, [0, 2]] - pad_w) / scale
         boxes[:, [1, 3]] = (boxes[:, [1, 3]] - pad_h) / scale
 
@@ -297,7 +288,7 @@ class YOLOv8Face(BaseDetector):
         # Reshape landmarks to (N, 5, 2)
         landmarks = landmarks.reshape(-1, 5, 2)
 
-        # Combine box and score
+        # Combine results
         detections = np.concatenate([boxes, scores[:, None]], axis=1)
 
         return detections, landmarks

uniface/gaze/models.py

@@ -179,6 +179,13 @@ class MobileGaze(BaseGazeEstimator):
 
         This method orchestrates the full pipeline: preprocessing the input,
         running inference, and postprocessing to return the gaze direction.
+
+        Args:
+            face_image (np.ndarray): A cropped face image in BGR format with shape (H, W, 3).
+
+        Returns:
+            GazeResult: Estimated gaze direction containing ``pitch`` (vertical) and
+                ``yaw`` (horizontal) angles in radians.
         """
         input_tensor = self.preprocess(face_image)
         outputs = self.session.run(self.output_names, {self.input_name: input_tensor})

uniface/headpose/models.py

@@ -170,6 +170,13 @@ class HeadPose(BaseHeadPoseEstimator):
 
         This method orchestrates the full pipeline: preprocessing the input,
         running inference, and postprocessing to return the head orientation.
+
+        Args:
+            face_image (np.ndarray): A cropped face image in BGR format with shape (H, W, 3).
+
+        Returns:
+            HeadPoseResult: Estimated head orientation containing ``pitch`` (vertical),
+                ``yaw`` (horizontal), and ``roll`` (in-plane) angles in degrees.
         """
         input_tensor = self.preprocess(face_image)
         outputs = self.session.run(self.output_names, {self.input_name: input_tensor})

uv.lock

@@ -249,14 +249,14 @@ wheels = [
 
 [[package]]
 name = "gitpython"
-version = "3.1.49"
+version = "3.1.50"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "gitdb" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/e1/63/210aaa302d6a0a78daa67c5c15bbac2cad361722841278b0209b6da20855/gitpython-3.1.49.tar.gz", hash = "sha256:42f9399c9eb33fc581014bedd76049dfbaf6375aa2a5754575966387280315e1", size = 219367, upload-time = "2026-04-29T00:31:20.478Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/33/f6/354ae6491228b5eb40e10d89c4d13c651fe1cf7556e35ebdded50cff57ce/gitpython-3.1.50.tar.gz", hash = "sha256:80da2d12504d52e1f998772dc5baf6e553f8d2fcfe1fcc226c9d9a2ee3372dcc", size = 219798, upload-time = "2026-05-06T04:01:26.571Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/fd/6f/b842bfa6f21d6f87c57f9abf7194225e55279d96d869775e19e9f7236fc5/gitpython-3.1.49-py3-none-any.whl", hash = "sha256:024b0422d7f84d15cd794844e029ffebd4c5d42a7eb9b936b458697ef550a02c", size = 212190, upload-time = "2026-04-29T00:31:18.412Z" },
+    { url = "https://files.pythonhosted.org/packages/20/7a/1c6e3562dfd8950adbb11ffbc65d21e7c89d01a6e4f137fa981056de25c5/gitpython-3.1.50-py3-none-any.whl", hash = "sha256:d352abe2908d07355014abdd21ddf798c2a961469239afec4962e9da884858f9", size = 212507, upload-time = "2026-05-06T04:01:23.799Z" },
 ]
 
 [[package]]