dg-face-tracking 0.0.4

DeGirum Face Tracking Application Package

Face Tracking Demo

Demonstrates the following technologies:

• Face Detection in a video stream. Yolo models from DeGirum zoo are used.
• Creating face embeddings by DeepFace
• Saving face metadata, including embeddings, in a vector database (LanceDB)
• Recognition of detected faces, using saved faces metadata.

Used as a mock-up for development of hybrid deployment of a vector db.

1. Installation

Create a new conda environment:

conda env create -f environment.yml

Activate it:

conda activate dg_face_tracking

Create a database folder:

mkdir db

Change the cuurent directory to src:

cd src

Open env.ini file and fill the DEGIRUM_CLOUD_TOKEN field with a valid DeGirum cloud platform API access token.

2. Running

A laptop with an enabled camera must be used.

Start the labelling app:

python DataFaceApp.py

Start the face tracking app:

python DataFace.py  face_tracker_camera

Faces will be detected and recognized in camera's stream, then displayed in app window. The identification results will be displayed above each face.

If a new person is detected, his/her face will appear with "unknown" label in the labelling app.
The operator must enter person's name and press OK button.

The system may also ask for operator's confirmation for such faces, that were recognized with a low confidence. In this case, the operator may perform one of the following:

• skip this face image by pressing Skip button;
• confirm recognition results by pressing OK button;
• override recognition results by entering the correct name.

Press OK button to finalize keying.

Ctrl+C stops the app.

3. Creating a dataset.

1. Edit the face_tracker_camera.cfg config file by adding

 [${data_source.id}, ${dataset_writer}]

line in data_connections section.

2. In dataset section of LocalDBWriter.cfg config file:

• Set the valid paths for catalogue (catalogue_path) and the datasets path (datasets_path);
• Set dataset name dataset_name
• If you want to overwrite the existing dataset, set write_mode as "overwrite"

Run the application.

To stop data collection, press Ctrl+C

4. Running on a dataset

python DataFace.py  face_tracker_dataset

dataset section of FaceTrackerDataset.cfg must contain the valid parameters of the dataset to be used:

• Set the valid paths for catalogue (catalogue_path) and the datasets path (datasets_path);
• Set the dataset name (dataset_name)

Run the application.

To stop running, press Ctrl+C

5. CI/CD

To make new release perform the following steps:

1. Assign new git tag by running the following command:

   ./rel-tag.sh x.y.z
   

   where x.y.z is semantic version of new release.

2. Open Github Release action page and configure release action by clicking Run workflow combo box, selecting Tags tab in Branch combo box, and specifying the tag, which corresponds to the released version:

   

3. Start release action by pressing green Run workflow button.

4. Make sure Release action finishes successfully (green checkmark new recent Release action run status)

5. Open Github Upload action page and configure upload action by clicking Run workflow combo box and specifying the release version tag in Release tag containing wheels to upload edit box:

   

6. Start upload action by pressing green Run workflow button.

7. Make sure Upload action finishes successfully (green checkmark new recent Upload action run status)

8. Verify, that release is avaiable for installation by running the following command:

   pip uninstall -y dg_face_tracking && pip install -U dg_face_tracking
   

   You should see the following prompt:

   Successfully installed dg_face_tracking-x.y.z