CompreFace is a free and open-source face recognition system from Exadel
CompreFace can be easily integrated into any system without prior machine learning skills. CompreFace provides REST API for face recognition, face verification, face detection, landmark detection, age, and gender recognition and is easily deployed with docker
Contributing · Submit an Issue · Blog · Community chat
Table Of Contents
- Overview
- Screenshots
- Feedback survey
- Features
- Getting Started with CompreFace
- CompreFace SDKs
- Documentation
- Contributing
- License info
Overview
CompreFace is a free and open-source face detection and recognition GitHub project. Essentially, it is a docker-based application that can be used as a standalone server or deployed in the cloud. You don’t need prior machine learning skills to set up and use CompreFace.
CompreFace provides REST API for face recognition, face verification, face detection, landmark detection, age, and gender recognition. The solution also features a role management system that allows you to easily control who has access to your Face Recognition Services.
CompreFace is delivered as a docker-compose config and supports different models that work on CPU and GPU. Our solution is based on state-of-the-art methods and libraries like FaceNet and InsightFace.
Screenshots
Feedback survey
We need your help to better understand which features we should add to the service and how we can improve it further! Our feedback form is totally anonymous, and answering the questions will take just 2 minutes of your time: https://forms.gle/ybAEPc3XmzEcpv4M8
Features
The system can accurately identify people even when it has only “seen” their photo once. Technology-wise, CompreFace has several advantages over similar free face recognition solutions. CompreFace:
- Supports many face recognition services: face identification, face verification, face detection, landmark detection, and age and gender recognition
- Supports both CPU and GPU and is easy to scale up
- Is open source and self-hosted, which gives you additional guarantees for data security
- Can be deployed either in the cloud or on premises
- Can be set up and used without machine learning expertise
- Uses FaceNet and InsightFace libraries, which use state-of-the-art face recognition methods
- Features a UI panel for convenient user roles and access management
- Starts quickly with just one docker command
Getting Started with CompreFace
Requirements
- Docker and Docker compose (or Docker Desktop)
- CompreFace could be run on most modern computers with x86 processor and AVX support. To check AVX support on Linux run
lscpu | grep avx
command
To get started (Linux, MacOS):
- Install Docker and Docker Compose
- Download the archive from our latest release: https://github.com/exadel-inc/CompreFace/releases
- Unzip the archive
- Open the terminal in this folder and run this command:
docker-compose up -d
- Open the service in your browser: http://localhost:8000/login
To get started (Windows):
- Install Docker Desktop
- Download the archive from our latest release: https://github.com/exadel-inc/CompreFace/releases
- Unzip the archive
- Run Docker
- Open Command prompt (write
cmd
in windows search bar) - Open folder where you extracted zip archive (Write
cd path_of_the_folder
, press enter). - Run command:
docker-compose up -d
- Open http://localhost:8000/login
Getting started for devs
Follow this link: https://github.com/exadel-inc/CompreFace/tree/develop/dev
CompreFace SDKs
SDK | Repository |
---|---|
JavaScript | https://github.com/exadel-inc/compreface-javascript-sdk |
Documentation
More documentation is available here
Contributing
We want to improve our open-source face recognition solution, so your contributions are welcome and greatly appreciated. After creating your first contributing pull request, you will receive a request to sign our Contributor License Agreement by commenting your pull request with a special message.
Formatting standards
For java just import dev/team_codestyle.xml file in your IntelliJ IDEA.
Report Bugs
Please report any bugs here.
If you are reporting a bug, please specify:
- Your operating system name and version
- Any details about your local setup that might be helpful in troubleshooting
- Detailed steps to reproduce the bug
Submit Feedback
The best way to send us feedback is to file an issue at https://github.com/exadel-inc/CompreFace/issues.
If you are proposing a feature, please:
- Explain in detail how it should work.
- Keep the scope as narrow as possible to make it easier to implement.
License info
CompreFace is open-source real-time facial recognition software released under the Apache 2.0 license.