update readme

fdemusso · fdemusso · commit 8b896e89eb23 · 2025-12-14T17:02:41.000+01:00
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 <p align="center">
   <img src="https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white" alt="Python"/>
-  <img src="https://img.shields.io/badge/FaceRecognition-%23007ACC?style=for-the-badge&logo=python&logoColor=white" alt="FaceRecognition"/>
+  <img src="https://img.shields.io/badge/InsightFace-%23007ACC?style=for-the-badge&logo=python&logoColor=white" alt="InsightFace"/>
   <img src="https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white" alt="MongoDB"/>
   <img src="https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB" alt="React"/>
   <img src="https://img.shields.io/badge/Uvicorn-2C3E50?style=for-the-badge&logo=fastapi&logoColor=white" alt="Uvicorn"/>
@@ -51,7 +51,7 @@ The system's long-term memory, essential for flexible data storage.
 * **MongoDB:** A document-oriented NoSQL database chosen for its scalability in managing complex data structures, such as relative registries and biometric vectors.
 
 ### Computer Vision (AI)
-* **Face Recognition (Python Lib):** The biometric recognition engine. This library maps and identifies known faces with a high degree of reliability.
+* **InsightFace:** Advanced face recognition framework providing state-of-the-art face detection and embedding extraction. The system uses InsightFace's pre-trained models to map and identify known faces with high accuracy and reliability. The engine supports GPU acceleration (CUDA, CoreML, DML) when available, with automatic fallback to CPU execution.
 
 ## Installation
 
diff --git a/docs/models/person.md b/docs/models/person.md
@@ -7,3 +7,4 @@ Person data model with validation and computed fields.
 ::: app.models.person.Person
 
 
+
diff --git a/docs/scripts/insertdata.md b/docs/scripts/insertdata.md
@@ -9,3 +9,4 @@ Utility script for inserting demo person data into the database.
 ::: app.insertdata.main
 
 
+
diff --git a/docs/services/database.md b/docs/services/database.md
@@ -7,3 +7,4 @@ MongoDB database service for person data management.
 ::: app.services.database.Database
 
 
+
diff --git a/docs/services/recognition.md b/docs/services/recognition.md
@@ -7,3 +7,4 @@ Face detection and recognition engine using InsightFace and FAISS.
 ::: app.services.recognition.FaceEngine
 
 
+
diff --git a/docs/utils/constants.md b/docs/utils/constants.md
@@ -11,3 +11,4 @@ Enumeration types for the application.
 ::: app.utils.constants.RoleType
 
 
+
diff --git a/docs/utils/img.md b/docs/utils/img.md
@@ -7,3 +7,4 @@ Image validation and conversion utility.
 ::: app.utils.img.ImgValidation
 
 
+
diff --git a/frontend/src/components/CameraToggle.js b/frontend/src/components/CameraToggle.js
@@ -24,3 +24,4 @@ export default React.memo(CameraToggle);
 
 
 
+
diff --git a/frontend/src/components/DebugInfo.js b/frontend/src/components/DebugInfo.js
@@ -47,3 +47,4 @@ export default DebugInfo;
 
 
 
+
diff --git a/frontend/src/components/FaceBox.js b/frontend/src/components/FaceBox.js
@@ -66,3 +66,4 @@ export default React.memo(FaceBox, (prevProps, nextProps) => {
 
 
 
+
diff --git a/frontend/src/components/WebcamView.js b/frontend/src/components/WebcamView.js
@@ -56,3 +56,4 @@ export default React.memo(WebcamView);
 
 
 
+
diff --git a/frontend/src/hooks/useFaceDetection.js b/frontend/src/hooks/useFaceDetection.js
@@ -19,3 +19,4 @@ export const useFaceDetection = () => {
 
 
 
+
diff --git a/frontend/src/hooks/useLatency.js b/frontend/src/hooks/useLatency.js
@@ -48,3 +48,4 @@ export const useLatency = () => {
 
 
 
+
diff --git a/frontend/src/hooks/useWebSocket.js b/frontend/src/hooks/useWebSocket.js
@@ -98,3 +98,4 @@ export const useWebSocket = (onMessage) => {
 
 
 
+
diff --git a/frontend/src/utils/videoCapture.js b/frontend/src/utils/videoCapture.js
@@ -68,3 +68,4 @@ export const captureAndSend = (video, ws, canvasRef) => {
 
 
 
+
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -5,3 +5,4 @@ mkdocstrings[python]>=0.24.0
 pymdown-extensions>=10.0.0
 
 
+

Original file line number	Diff line number	Diff line change
`@@ -7,3 +7,4 @@ Person data model with validation and computed fields.`
`7`	`7`	`::: app.models.person.Person`
`8`	`8`
`9`	`9`
	`10`	`+`
Original file line number	Diff line number	Diff line change
`@@ -9,3 +9,4 @@ Utility script for inserting demo person data into the database.`
`9`	`9`	`::: app.insertdata.main`
`10`	`10`
`11`	`11`
	`12`	`+`
Original file line number	Diff line number	Diff line change
`@@ -7,3 +7,4 @@ MongoDB database service for person data management.`
`7`	`7`	`::: app.services.database.Database`
`8`	`8`
`9`	`9`
	`10`	`+`
Original file line number	Diff line number	Diff line change
`@@ -7,3 +7,4 @@ Face detection and recognition engine using InsightFace and FAISS.`
`7`	`7`	`::: app.services.recognition.FaceEngine`
`8`	`8`
`9`	`9`
	`10`	`+`
Original file line number	Diff line number	Diff line change
`@@ -11,3 +11,4 @@ Enumeration types for the application.`
`11`	`11`	`::: app.utils.constants.RoleType`
`12`	`12`
`13`	`13`
	`14`	`+`
Original file line number	Diff line number	Diff line change
`@@ -7,3 +7,4 @@ Image validation and conversion utility.`
`7`	`7`	`::: app.utils.img.ImgValidation`
`8`	`8`
`9`	`9`
	`10`	`+`
Original file line number	Diff line number	Diff line change
`@@ -24,3 +24,4 @@ export default React.memo(CameraToggle);`
`24`	`24`
`25`	`25`
`26`	`26`
	`27`	`+`
Original file line number	Diff line number	Diff line change
`@@ -47,3 +47,4 @@ export default DebugInfo;`
`47`	`47`
`48`	`48`
`49`	`49`
	`50`	`+`
Original file line number	Diff line number	Diff line change
`@@ -66,3 +66,4 @@ export default React.memo(FaceBox, (prevProps, nextProps) => {`
`66`	`66`
`67`	`67`
`68`	`68`
	`69`	`+`