IBM Code Model Asset Exchange: Facial Recognizer

This repository contains code to instantiate and deploy a face detection and feature extraction model. The model first detects faces in an input image and then generates an embedding vector for each face. The generated embeddings can be used for downstream tasks such as classification, clustering, verification etc. The model accepts an image as input and returns the bounding box coordinates, probability and embedding vector for each face detected in the image.

The model is based on the FaceNet model. The model files are hosted on IBM Cloud Object Storage. The code in this repository deploys the model as a web service in a Docker container. This repository was developed as part of the IBM Code Model Asset Exchange.

Model Metadata

Domain	Application	Industry	Framework	Training Data	Input Data Format
Vision	Face Detection	General	TensorFlow	VGGFace2	Image (RGB)

References

Florian Schroff, Dmitry Kalenichenko, James Philbin, "FaceNet: A Unified Embedding for Face Recognition and Clustering", CVPR 2015.
Q. Cao, L. Shen, W. Xie, O. M. Parkhi, A. Zisserman, "VGGFace2: A dataset for recognising face across pose and age", International Conference on Automatic Face and Gesture Recognition, 2018.
FaceNet Github Repository.

Licenses

Component	License	Link
This repository	Apache 2.0	LICENSE
Model Weights	MIT	LICENSE
Model Code (3rd party)	MIT	LICENSE
Test assets	Various	Asset README

Pre-requisites:

docker: The Docker command-line interface. Follow the installation instructions for your system.
The minimum recommended resources for this model is 2GB Memory and 1 CPUs.

Steps

Deploy from Docker Hub
Deploy on Kubernetes
Run Locally

Deploy from Docker Hub

To run the docker image, which automatically starts the model serving API, run:

$ docker run -it -p 5000:5000 codait/max-facial-recognizer

This will pull a pre-built image from Docker Hub (or use an existing image if already cached locally) and run it. If you'd rather checkout and build the model locally you can follow the run locally steps below.

Deploy on Kubernetes

You can also deploy the model on Kubernetes using the latest docker image on Docker Hub.

On your Kubernetes cluster, run the following commands:

$ kubectl apply -f https://github.com/IBM/MAX-Facial-Recognizer/raw/master/max-facial-recognizer.yaml

The model will be available internally at port 5000, but can also be accessed externally through the NodePort.

1. Build the Model

Clone this repository locally. In a terminal, run the following command:

$ git clone https://github.com/IBM/MAX-Facial-Recognizer.git

Change directory into the repository base folder:

$ cd MAX-Facial-Recognizer

To build the docker image locally, run:

$ docker build -t max-facial-recognizer .

All required model assets will be downloaded during the build process. Note that currently this docker image is CPU only (we will add support for GPU images later).

2. Deploy the Model

To run the docker image, which automatically starts the model serving API, run:

$ docker run -it -p 5000:5000 max-facial-recognizer

3. Use the Model

The API server automatically generates an interactive Swagger documentation page. Go to http://localhost:5000 to load it. From there you can explore the API and also create test requests. Use the model/predict endpoint to load a test image (you can use one of the test images from the assets folder) and get predicted labels for the image from the API.

You can also test it on the command line, for example:

$ curl -F "image=@assets/Lenna.jpg" -XPOST http://localhost:5000/model/predict

You should see a JSON response like that below:

{
  "status": "ok",
  "predictions": [
    {
      "detection_box": [
        85.5373387336731,
        77.938033670187,
        149.2407527267933,
        170.62581571377814
      ],
      "probability": 0.9959015250205994,
      "embedding": [
        -0.016315622255206108,
        -0.04482162743806839,
        -0.02662980556488037,
        -0.003268358064815402,
        0.0253919567912817,
        0.07166660577058792,
        -0.0225024726241827,
        ...
        -0.05647726729512215
      ]
    }
  ]
}

4. Run the Notebook

Once the model server is running, you can see how to use it by walking through the demo notebook. Note the demo requires jupyter, numpy, scipy, matplotlib, Pillow, and requests.

Run the following command from the model repo base folder, in a new terminal window (leaving the model server running in the other terminal window):

$ jupyter notebook

This will start the notebook server. You can open the simple demo notebook by clicking on demo.ipynb. There is also a second demo illustrating a privacy use-case, which you can open by clicking on demo_gdpr.ipynb.

5. Development

To run the Flask API app in debug mode, edit config.py to set DEBUG = True under the application settings. You will then need to rebuild the docker image (see step 1).

6. Cleanup

To stop the Docker container, type CTRL + C in your terminal.

yvescabral / MAX-Facial-Recognizer