Package: deepface
deepfaceDeepface is a lightweightface recognitionand facial attribute analysis (age,gender,emotionandrace) framework for python. It is a hybrid face recognition framework wrappingstate-of-the-artmodels:VGG-Face,Google FaceNet,OpenFace,Facebook DeepFace,DeepID,ArcFace,DlibandSFace.Experiments show that human beings have 97.53% accuracy on facial recognition tasks whereas those models already reached and passed that accuracy level.InstallationThe easiest way to install deepface is to download it fromPyPI. It's going to install the library itself and its prerequisites as well.$pipinstalldeepfaceSecondly, DeepFace is also available atConda. You can alternatively install the package via conda.$condainstall-cconda-forgedeepfaceThirdly, you can install deepface from its source code.$gitclonehttps://github.com/serengil/deepface.git
$cddeepface
$pipinstall-e.Then you will be able to import the library and use its functionalities.fromdeepfaceimportDeepFaceFacial Recognition-DemoA modernface recognition pipelineconsists of 5 common stages:detect,align,normalize,representandverify. While Deepface handles all these common stages in the background, you don’t need to acquire in-depth knowledge about all the processes behind it. You can just call its verification, find or analysis function with a single line of code.Face Verification-DemoThis function verifies face pairs as same person or different persons. It expects exact image paths as inputs. Passing numpy or base64 encoded images is also welcome. Then, it is going to return a dictionary and you should check just its verified key.result=DeepFace.verify(img1_path="img1.jpg",img2_path="img2.jpg")Verification function can also handle many faces in the face pairs. In this case, the most similar faces will be compared.Face recognition-DemoFace recognitionrequires applying face verification many times. Herein, deepface has an out-of-the-box find function to handle this action. It's going to look for the identity of input image in the database path and it will return list of pandas data frame as output. Meanwhile, facial embeddings of the facial database are stored in a pickle file to be searched faster in next time. Result is going to be the size of faces appearing in the source image. Besides, target images in the database can have many faces as well.dfs=DeepFace.find(img_path="img1.jpg",db_path="C:/workspace/my_db")EmbeddingsFace recognition models basically represent facial images as multi-dimensional vectors. Sometimes, you need those embedding vectors directly. DeepFace comes with a dedicated representation function. Represent function returns a list of embeddings. Result is going to be the size of faces appearing in the image path.embedding_objs=DeepFace.represent(img_path="img.jpg")This function returns an array as embedding. The size of the embedding array would be different based on the model name. For instance, VGG-Face is the default model and it represents facial images as 4096 dimensional vectors.embedding=embedding_objs[0]["embedding"]assertisinstance(embedding,list)assertmodel_name="VGG-Face"andlen(embedding)==4096Here, embedding is alsoplottedwith 4096 slots horizontally. Each slot is corresponding to a dimension value in the embedding vector and dimension value is explained in the colorbar on the right. Similar to 2D barcodes, vertical dimension stores no information in the illustration.Face recognition models-DemoDeepface is ahybridface recognition package. It currently wraps manystate-of-the-artface recognition models:VGG-Face,Google FaceNet,OpenFace,Facebook DeepFace,DeepID,ArcFace,DlibandSFace. The default configuration uses VGG-Face model.models=["VGG-Face","Facenet","Facenet512","OpenFace","DeepFace","DeepID","ArcFace","Dlib","SFace",]#face verificationresult=DeepFace.verify(img1_path="img1.jpg",img2_path="img2.jpg",model_name=models[0])#face recognitiondfs=DeepFace.find(img_path="img1.jpg",db_path="C:/workspace/my_db",model_name=models[1])#embeddingsembedding_objs=DeepFace.represent(img_path="img.jpg",model_name=models[2])FaceNet, VGG-Face, ArcFace and Dlib areoverperformingones based on experiments. You can find out the scores of those models below on bothLabeled Faces in the Wildand YouTube Faces in the Wild data sets declared by its creators.ModelLFW ScoreYTF ScoreFacenet51299.65%-SFace99.60%-ArcFace99.41%-Dlib99.38 %-Facenet99.20%-VGG-Face98.78%97.40%Human-beings97.53%-OpenFace93.80%-DeepID-97.05%SimilarityFace recognition models are regularconvolutional neural networksand they are responsible to represent faces as vectors. We expect that a face pair of same person should bemore similarthan a face pair of different persons.Similarity could be calculated by different metrics such asCosine Similarity, Euclidean Distance and L2 form. The default configuration uses cosine similarity.metrics=["cosine","euclidean","euclidean_l2"]#face verificationresult=DeepFace.verify(img1_path="img1.jpg",img2_path="img2.jpg",distance_metric=metrics[1])#face recognitiondfs=DeepFace.find(img_path="img1.jpg",db_path="C:/workspace/my_db",distance_metric=metrics[2])Euclidean L2 formseemsto be more stable than cosine and regular Euclidean distance based on experiments.Facial Attribute Analysis-DemoDeepface also comes with a strong facial attribute analysis module includingage,gender,facial expression(including angry, fear, neutral, sad, disgust, happy and surprise) andrace(including asian, white, middle eastern, indian, latino and black) predictions. Result is going to be the size of faces appearing in the source image.objs=DeepFace.analyze(img_path="img4.jpg",actions=['age','gender','race','emotion'])Age model got ± 4.65 MAE; gender model got 97.44% accuracy, 96.29% precision and 95.05% recall as mentioned in itstutorial.Face Detectors-DemoFace detection and alignment are important early stages of a modern face recognition pipeline. Experiments show that just alignment increases the face recognition accuracy almost 1%.OpenCV,SSD,Dlib,MTCNN,Faster MTCNN,RetinaFace,MediaPipe,YOLOv8 FaceandYuNetdetectors are wrapped in deepface.All deepface functions accept an optional detector backend input argument. You can switch among those detectors with this argument. OpenCV is the default detector.backends=['opencv','ssd','dlib','mtcnn','retinaface','mediapipe','yolov8','yunet','fastmtcnn',]#face verificationobj=DeepFace.verify(img1_path="img1.jpg",img2_path="img2.jpg",detector_backend=backends[0])#face recognitiondfs=DeepFace.find(img_path="img.jpg",db_path="my_db",detector_backend=backends[1])#embeddingsembedding_objs=DeepFace.represent(img_path="img.jpg",detector_backend=backends[2])#facial analysisdemographies=DeepFace.analyze(img_path="img4.jpg",detector_backend=backends[3])#face detection and alignmentface_objs=DeepFace.extract_faces(img_path="img.jpg",target_size=(224,224),detector_backend=backends[4])Face recognition models are actually CNN models and they expect standard sized inputs. So, resizing is required before representation. To avoid deformation, deepface adds black padding pixels according to the target size argument after detection and alignment.RetinaFaceandMTCNNseem to overperform in detection and alignment stages but they are much slower. If the speed of your pipeline is more important, then you should use opencv or ssd. On the other hand, if you consider the accuracy, then you should use retinaface or mtcnn.The performance of RetinaFace is very satisfactory even in the crowd as seen in the following illustration. Besides, it comes with an incredible facial landmark detection performance. Highlighted red points show some facial landmarks such as eyes, nose and mouth. That's why, alignment score of RetinaFace is high as well.The Yellow Angels - Fenerbahce Women's Volleyball TeamYou can find out more about RetinaFace on thisrepo.Real Time Analysis-DemoYou can run deepface for real time videos as well. Stream function will access your webcam and apply both face recognition and facial attribute analysis. The function starts to analyze a frame if it can focus a face sequentially 5 frames. Then, it shows results 5 seconds.DeepFace.stream(db_path="C:/User/Sefik/Desktop/database")Even though face recognition is based on one-shot learning, you can use multiple face pictures of a person as well. You should rearrange your directory structure as illustrated below.user
├──database
│├──Alice
││├──Alice1.jpg
││├──Alice2.jpg
│├──Bob
││├──Bob.jpgAPI-DemoDeepFace serves an API as well - seeapi folderfor more details. You can clone deepface source code and run the api with the following command. It will use gunicorn server to get a rest service up. In this way, you can call deepface from an external system such as mobile app or web.cdscripts
./service.shFace recognition, facial attribute analysis and vector representation functions are covered in the API. You are expected to call these functions as http post methods. Default service endpoints will behttp://localhost:5000/verifyfor face recognition,http://localhost:5000/analyzefor facial attribute analysis, andhttp://localhost:5000/representfor vector representation. You can pass input images as exact image paths on your environment, base64 encoded strings or images on web.Here, you can find a postman project to find out how these methods should be called.Dockerized ServiceYou can deploy the deepface api on a kubernetes cluster with docker. The followingshell scriptwill serve deepface onlocalhost:5000. You need to re-configure theDockerfileif you want to change the port. Then, even if you do not have a development environment, you will be able to consume deepface services such as verify and analyze. You can also access the inside of the docker image to run deepface related commands. Please follow the instructions in theshell script.cdscripts
./dockerize.shCommand Line Interface-DemoDeepFace comes with a command line interface as well. You are able to access its functions in command line as shown below. The command deepface expects the function name as 1st argument and function arguments thereafter.#face verification$deepfaceverify-img1_pathtests/dataset/img1.jpg-img2_pathtests/dataset/img2.jpg#facial analysis$deepfaceanalyze-img_pathtests/dataset/img1.jpgYou can also run these commands if you are running deepface with docker. Please follow the instructions in theshell script.ContributionPull requests are more than welcome! You should run the unit tests and linting locally by runningmake test && make lintbefore creating a PR. Once a PR sent, GitHub test workflow will be run automatically and unit test results will be available inGitHub actionsbefore approval. Besides, workflow will evaluate the code with pylint as well.SupportThere are many ways to support a project - starring⭐️ the GitHub repo is just one 🙏You can also support this work onPatreonorGitHub Sponsors.CitationPlease cite deepface in your publications if it helps your research - seeCITATIONSfor more details. Here are its BibTex entries:If you use deepface in your research for facial recogntion purposes, please cite this publication.@inproceedings{serengil2020lightface,title={LightFace: A Hybrid Deep Face Recognition Framework},author={Serengil, Sefik Ilkin and Ozpinar, Alper},booktitle={2020 Innovations in Intelligent Systems and Applications Conference (ASYU)},pages={23-27},year={2020},doi={10.1109/ASYU50717.2020.9259802},url={https://doi.org/10.1109/ASYU50717.2020.9259802},organization={IEEE}}If you use deepface in your research for facial attribute analysis purposes such as age, gender, emotion or ethnicity prediction or face detection purposes, please cite this publication.@inproceedings{serengil2021lightface,title={HyperExtended LightFace: A Facial Attribute Analysis Framework},author={Serengil, Sefik Ilkin and Ozpinar, Alper},booktitle={2021 International Conference on Engineering and Emerging Technologies (ICEET)},pages={1-4},year={2021},doi={10.1109/ICEET53442.2021.9659697},url={https://doi.org/10.1109/ICEET53442.2021.9659697},organization={IEEE}}Also, if you use deepface in your GitHub projects, please adddeepfacein therequirements.txt.LicenceDeepFace is licensed under the MIT License - seeLICENSEfor more details.DeepFace wraps some external face recognition models:VGG-Face,Facenet,OpenFace,DeepFace,DeepID,ArcFace,Dlib, andSFace. Besides, age, gender and race / ethnicity models were trained on the backbone of VGG-Face with transfer learning. Licence types will be inherited if you are going to use those models. Please check the license types of those models for production purposes.DeepFacelogois created byAdrien Coquetand it is licensed underCreative Commons: By Attribution 3.0 License.