Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shubham0204/facerecognition_with_facenet_android

Face Recognition using the FaceNet model and MLKit on Android.
https://github.com/shubham0204/facerecognition_with_facenet_android

android android-application android-studio embeddings face-detection face-recognition facenet-model firebase-mlkit kotlin kotlin-android machine-learning tensorflow2

Last synced: 3 days ago
JSON representation

Face Recognition using the FaceNet model and MLKit on Android.

Awesome Lists containing this project

README 

        




  
Face Recognition and Classification With FaceNet On Android





> **Store images of people who you would like to recognize and the app, using these images, will classify those people. 

We don't need to modify the app/retrain any ML model to add more people ( subjects ) for classification**  



![banner](https://github.com/shubham0204/FaceRecognition_With_FaceNet_Android/assets/41076823/5922415d-ff61-4276-9817-7e472ebac7c4)



Do check an enhanced version of this project,



* [On-Device Face Recognition In Android](https://github.com/shubham0204/OnDevice-Face-Recognition-Android)  

 

 

### Features



* Asynchronous processing with [Kotlin Coroutines](https://developer.android.com/kotlin/coroutines)

* Quick labelling of faces with C++ computation (See [`native`](https://github.com/shubham0204/FaceRecognition_With_FaceNet_Android/tree/native) branch)

* Use of latest Android development practices with configurable camera facing, GPU usage and mask detection.



---

![Working of the app](images/app_1.gif)



If you're ML developer, you might have heard about FaceNet, Google's state-of-the-art model for generating face embeddings. In this   

project, we'll use the FaceNet model on Android and generate embeddings ( fixed size vectors ) which hold information of the face.  

  

> The accuracy of the face detection system ( with FaceNet ) may not have a considerable accuracy. Make sure you explore other options as well while considering your app's production.  

  

## FaceNet



![Working of the FaceNet model](images/fig_1.png)



So, the aim of the FaceNet model is to generate a 128 dimensional vector of a given face. It takes in an 160 * 160 RGB image and   

outputs an array with 128 elements. How is it going to help us in our face recognition project?   

Well, the FaceNet model generates similar face vectors for similar faces. Here, by the term "similar", we mean   

the vectors which point out in the same direction.

In this app, we'll generate two such vectors and use a suitable metric to compare them ( either L2norm or cosine similarity ). 

The one which is the closest will form our desired output.  

  

You can download the FaceNet Keras `.h5` file from this [repo](https://github.com/nyoki-mtl/keras-facenet) and TFLite model 

from the [`assets`](https://github.com/shubham0204/FaceRecognition_With_FaceNet_Android/tree/master/app/src/main/assets) folder.

  

## Usage



![Intended File Structure](images/fig_2.png)

  

So, an user can store images in his/her device in a specific folder. If, for instance, the user wants the app to recognize  

two people namely "Rahul" and "Neeta". So the user needs to store the images by creating two directories namely "Rahul" and "Neeta"   

and store their images inside of these directories. For instance, the file structure for the working example ( as shown above in the GIF ),



![Intended File Structure](images/fig_4.png)



The app will then process these images and classify these people thereafter. For face recognition, Firebase MLKit is used which   

fetches bounding boxes for all the faces present in the camera frame.  

  

> For better performance, we recommend developers to use more images of the subjects, they need to recognize.



## Working  



![Sample Prediction](images/fig_3.png)

  

The app's working is described in the steps below:

  

1. Scan the `images` folder present in the internal storage. Next, parse all the images present within `images` folder and store   

the names of sub directories within `images`. For every image, collect bounding box coordinates ( as a `Rect` ) using MLKit.

   Crop the face from the image ( the one which was collected from user's storage ) using the bounding box coordinates.   

  

2. Finally, we have a list of cropped `Bitmap` of the faces present in the images. Next, feed the cropped `Bitmap` to the FaceNet   

model and get the embeddings ( as `FloatArray` ). Now, we create a `HashMap` object where we store the names of   

the sub directories as keys and the embeddings as their corresponding values. 

   

See [`MainActivity.kt`](https://github.com/shubham0204/FaceRecognition_With_FaceNet_Android/blob/master/app/src/main/java/com/ml/quaterion/facenetdetection/MainActivity.kt) and [`FileReader.kt`](https://github.com/shubham0204/FaceRecognition_With_FaceNet_Android/blob/master/app/src/main/java/com/ml/quaterion/facenetdetection/FileReader.kt) for the code.

  

The above procedure is carried out only on the app's startup. The steps below will execute on each camera frame.  

  

1. Using `androidx.camera.core.ImageAnalysis`, we construct a `FrameAnalyser` class which processes the camera frames. Now, for a   

given frame, we first get the bounding box coordinates ( as a `Rect` ) of all the faces present in the frame. Crop the face from   

the frame using these boxes.  

2. Feed the cropped faces to the FaceNet model to generate embeddings for them. We compare the embedding with a suitable metric and

form clusters for each user. We compute the average score for each cluster. The cluster with the best score is our output.

The final output is then stored as a `Prediction` and passed to the `BoundingBoxOverlay` which draws boxes and   

text.  

3. For multiple images for a single user, we compute the score for each image. An average score is computed for each group.

  The group with the best score is chosen as the output. See `FrameAnalyser.kt`.



```  

images ->  

    Rahul -> 

         image_rahul_1.png -> score=0.6 --- | average = 0.65 --- |

         image_rahul_2.png -> score=0.5 ----|                    | --- output -> "Rahul"

    Neeta ->                                                     |

         image_neeta_1.png -> score=0.4 --- | average = 0.35 --- |

         image_neeta_2.png -> score=0.3 ----|             

 ```



See [`FaceNetModel.kt`](https://github.com/shubham0204/FaceRecognition_With_FaceNet_Android/blob/master/app/src/main/java/com/ml/quaterion/facenetdetection/FaceNetModel.kt) and [`FrameAnalyser.kt`](https://github.com/shubham0204/FaceRecognition_With_FaceNet_Android/blob/master/app/src/main/java/com/ml/quaterion/facenetdetection/FrameAnalyser.kt) for the code.

  

## Limitations  

  

Predictions may go wrong as FaceNet does not always produce similar embeddings for the same person. 

Consider the accuracy of the FaceNet model while using it in your apps. In that case, you may learn to use the `FaceNetModel` class separating for using FaceNet in some other tasks.  



## Important Resources  



- [FaceNet: A Unified Embedding for Face Recognition and Clustering](https://arxiv.org/abs/1503.03832)

- [MLKit](https://developers.google.com/ml-kit/vision/face-detection) for face recognition.  

- [TensorFlow Lite Android](https://www.tensorflow.org/lite)  

- [TensorFlow Lite Android Support Library](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/lite/experimental/support/java)  

- [CameraX](https://developer.android.com/training/camerax)