finished README.md

README.md

@@ -1,7 +1,8 @@
 # 🚀 BoostFace 🚀
 
 Welcome to **BoostFace**! The cutting-edge, high-performance face recognition system designed to revolutionize the way we think about real-time identification and tracking. Built with a powerful stack of technologies, BoostFace is your go-to solution for handling high-load, high-concurrency scenarios with ease and efficiency. 🌟
-
+## Demo
+![img.png](assets/img.png)
 ## 🛠 Tech Stack
 
 - **Frontend**: Leveraging [Streamlit](https://streamlit.io/) for an intuitive, user-friendly interface, combined with SCRFD for efficient and accurate face detection, and SORT for multi-object tracking. Real-time image transmission is facilitated through Websockets, ensuring a seamless and dynamic user experience. 🖥️
@@ -27,16 +28,40 @@ git clone https://github.com/Atticuszz/boostface.git
 cd boostface
 ```
 
+### prepare
 - download arcface_onnx model
 ```bash
 cd src/Demo/backend/services/inference/model_zoo
 wget https://github.com/Atticuszz/BoostFace/releases/download/dataset/models.zip
 unzip models.zip
 rm -rf models.zip
 ```
-
-- install env
+- init env
 ```bash
 cd src/Demo
 conda env create -f environment.yml
+conda activate BoostFace-demo
+```
+- register demo face after backend start
+```bash
+# register demo
+python src/Demo/web/inference/utils/register.py
+```
+
+### run 
+
+- start vector database
+```bash
+docker-compose up src/Demo/backend/services/db/milvus-standalone-docker-compose.yml
+```
+
+- start backend
+```bash
+# run backend
+python src/Demo/backend/main.py
+```
+
+- start web
+```bash
+streamlit run src/Demo/web/main.py
 ```

src/Demo/backend/common/web_socket_manager.py

@@ -1,10 +1,11 @@
 from contextlib import asynccontextmanager
 
-from backend.core.config import logger
 from fastapi import WebSocket
 from pydantic import BaseModel
 from starlette.websockets import WebSocketState
 
+from ..core.config import logger
+
 
 class WebSocketManager:
     """WebSocket manager"""

src/Demo/backend/main.py

@@ -1,11 +1,12 @@
 import subprocess
 
 import uvicorn
-from backend.core.events import lifespan
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from pygizmokit.rich_logger import set_up_logging
 
+from src.Demo.backend.core.events import lifespan
+
 set_up_logging()
 
 
@@ -22,7 +23,7 @@ def create_app() -> FastAPI:
     )
 
     # Include the routers
-    from backend.api import auth_router, identify_router
+    from src.Demo.backend.api import auth_router, identify_router
 
     app.include_router(auth_router)
     app.include_router(identify_router)

src/Demo/backend/services/db/operations.py

@@ -28,7 +28,6 @@ def __init__(self, threshold=0.5):
             self._client.collection.load(timeout=10)
             utility.wait_for_loading_complete(self._client.collection.name, timeout=10)
 
-    # @profile
     def search(self, embedding: Embedding) -> MatchedResult:
         """
         :param embedding: must be normed
@@ -53,9 +52,6 @@ def stop_client(self):
         self._client.shut_down()
 
 
-# TODO: register if the operation is registered instead of identify
-
-
 class Registrar:
     def __init__(self):
         self._client = MilvusClient()

src/Demo/web/inference/utils/register.py

@@ -10,15 +10,12 @@
 from pathlib import Path
 
 import cv2
-from web.inference.common import ImageFaces
-from web.inference.component.detector import Detector
-from web.settings import DetectorConfig
 
-IMAGE_PATH = r"/home/atticuszz/DevSpace/python/BoostFace/src/boostface/dataset_loader/data/lfw-deepfunneled/lfw-deepfunneled"
-# IMAGE_PATH = (
-#     "/home/atticuszz/DevSpace/python/BoostFace/src/Demo/web/data/image/Friends/simple"
-# )
-# paper: 高并发注册人脸
+from src.Demo.web.inference.common import ImageFaces
+from src.Demo.web.inference.component.detector import Detector
+from src.Demo.web.inference.settings import DetectorConfig
+
+IMAGE_PATH = Path(__file__).parents[2] / r"data/image/Friends/simple"
 
 import asyncio