CompreFace - open-source face recognition system from Exadel

CompreFace is a free face recognition service that can be easily integrated into
any system without prior machine learning skills.

Official website

Contributing · Submit an Issue · Blog · Community chat

   

---

Table Of Contents

• Overview
• Features
• Getting started
• Documentation
  • How to Use CompreFace
  • Face Services and Plugins
  • Rest API Description
  • Configuration
  • Architecture and Scalability
  • Custom Builds
  • Gathering Anonymous Statistics
• 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.

Feedback survey

We are constantly improving our product. But for better understanding which features we should add or improve we need your help! Feedback form is totally anonymous, it will take just 2 minutes of your time to answer the questions: 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

To get started (Linux, MacOS):

1. Install Docker and Docker-Compose
2. Download the archive from our latest release: https://github.com/exadel-inc/CompreFace/releases
3. Unzip the archive
4. Run command: docker-compose up -d

To get started (Windows):

1. Install Docker
2. Download the archive from our latest release: https://github.com/exadel-inc/CompreFace/releases
3. Unzip the archive
4. Run Docker
5. Windows search bar-> cmd->in the Command prompt-> cd ->paste the path to the extracted zip folder
6. Run command: docker-compose up -d
7. Open http://localhost:8000/login

Contributing

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 PR with a special message.

Formatting standards

For java just import dev/team_codestyle.xml file in your IntelliJ IDEA

Report Bugs

Report bugs at https://github.com/exadel-inc/CompreFace/issues.

If you are reporting a bug, please include:

• 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 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 software released under the Apache 2.0 license.