# Open Source Face Recognition SDK
**The world's first completely free and open-source face recognition SDK for Windows and Linux from [Faceplugin](https://faceplugin.com/)**
[](https://github.com/Faceplugin-ltd/Open-Source-Face-Recognition-SDK)
[](https://www.python.org/)
[](https://github.com/Faceplugin-ltd/Open-Source-Face-Recognition-SDK)
[](https://faceplugin.com/)
---
## ๐ Overview
The **Open Source Face Recognition SDK** by [Faceplugin](https://faceplugin.com/) is a powerful, privacy-focused solution for integrating face recognition capabilities into your applications. Built with deep learning models, this SDK provides high-accuracy face detection and recognition while ensuring complete data privacy through on-premise processing.
### โจ Key Features
- ๐ **100% On-Premise**: All processing happens locally - no data leaves your device
- ๐ฏ **High Accuracy**: Powered by state-of-the-art deep learning models
- โก **Real-Time Processing**: Fast face detection and recognition capabilities
- ๐ง **Easy Integration**: Simple Python APIs for seamless development
- ๐ **Cross-Platform**: Compatible with Windows and Linux systems
- ๐ฑ **GPU Optional**: Works efficiently on CPU-only systems
- ๐ **Completely Free**: Open source with no licensing fees
### ๐ฏ Current Capabilities
- Face detection and bounding box extraction
- Facial landmark detection
- Feature embedding generation
- Face similarity comparison
- Support for multiple image formats (JPG, PNG, etc.)
---
## ๐ ๏ธ Installation
### Prerequisites
- **Python 3.9 or higher**
- **Anaconda** (recommended for dependency management)
- **Windows or Linux** operating system
### Setup Instructions
1. **Install Anaconda** (if not already installed)
```bash
# Download from: https://www.anaconda.com/products/distribution
```
2. **Create and activate conda environment**
```bash
conda create -n facesdk python=3.9
conda activate facesdk
```
3. **Install dependencies**
```bash
pip install -r requirements.txt
```
4. **Test the installation**
```bash
python run.py
```
---
## ๐ Quick Start
### Basic Usage
```python
from face_recognition_sdk import FaceRecognition
# Initialize the SDK
face_sdk = FaceRecognition()
# Process an image
image_path = "path/to/your/image.jpg"
face_info = face_sdk.GetImageInfo(image_path, faceMaxCount=10)
# Compare two faces
similarity = face_sdk.get_similarity(feature1, feature2)
```
### Example: Face Comparison
```python
# Compare two images
image1 = "test/1.jpg"
image2 = "test/2.png"
# Get face information from both images
faces1 = face_sdk.GetImageInfo(image1, faceMaxCount=1)
faces2 = face_sdk.GetImageInfo(image2, faceMaxCount=1)
if faces1 and faces2:
# Compare the first face from each image
similarity = face_sdk.get_similarity(faces1[0]['embedding'], faces2[0]['embedding'])
print(f"Similarity: {similarity}%")
# Check if it's the same person (threshold = 75)
is_same_person = similarity >= 75
print(f"Same person: {is_same_person}")
```
---
## ๐ง API Reference
### Core Functions
#### `GetImageInfo(image_path, faceMaxCount)`
Extracts face information from an image.
**Parameters:**
- `image_path` (str): Path to the input image
- `faceMaxCount` (int): Maximum number of faces to detect
**Returns:**
- List of dictionaries containing:
- `bbox`: Face bounding box coordinates
- `landmarks`: Facial landmark points
- `embedding`: Feature embedding vector
#### `get_similarity(feature1, feature2)`
Compares two face feature embeddings.
**Parameters:**
- `feature1` (array): First face embedding
- `feature2` (array): Second face embedding
**Returns:**
- Similarity score (0-100), where higher values indicate greater similarity
### Configuration
- **Default Threshold**: 75 (for determining if two faces belong to the same person)
- **Supported Formats**: JPG, PNG, BMP, TIFF
- **Face Detection**: Automatic detection of multiple faces per image
---
## ๐ฏ Use Cases
This SDK is ideal for various applications:
### ๐ Security & Authentication
- **Access Control Systems**: Secure entry points with face recognition
- **User Authentication**: Biometric login for applications
- **Surveillance**: Real-time monitoring and alerting
### ๐ฅ Business Applications
- **Time & Attendance**: Automated employee check-in/check-out
- **Customer Analytics**: Retail customer tracking and analytics
- **Smart Offices**: Automated visitor management
### ๐ฑ Mobile & IoT
- **Smart Devices**: Integration with IoT devices
- **Mobile Apps**: Face recognition in mobile applications
- **Augmented Reality**: AR applications with facial recognition
---
## ๐ข More Biometric SDKs from Faceplugin
This project is developed by **[Faceplugin](https://faceplugin.com/)**, a provider of on-premise biometric and identity verification SDKs.
If you need capabilities beyond this open-source SDK, explore Faceplugin's commercial SDKs for:
| Solution | Description |
|---|---|
| ๐ค **Face Recognition** | Face recognition, verification, identification, attributes, and biometric authentication |
| ๐ก๏ธ **Face Liveness Detection** | Detect presentation attacks during face verification and authentication |
| ๐ **ID Document Recognition** | OCR, MRZ, barcode recognition, and document classification |
| ๐ **ID Document Liveness Detection** | Detect presentation attacks involving identity documents |
Explore our complete suite of **biometric and identity verification solutions**, including face recognition, face liveness detection, ID document recognition and ID document liveness detection SDKs.
### Face Recognition SDKs
- [Face Recognition + Liveness โ Android](https://github.com/Faceplugin-ltd/FaceRecognition-Android) ยท Java, Kotlin
- [Face Recognition + Liveness โ iOS](https://github.com/Faceplugin-ltd/FaceRecognition-iOS) ยท Objective-C, Swift
- [Face Recognition + Liveness โ Flutter](https://github.com/Faceplugin-ltd/FaceRecognition-Flutter)
- [Face Recognition + Liveness โ React Native](https://github.com/Faceplugin-ltd/FaceRecognition-React-Native)
- [Face Recognition + Liveness โ Ionic Cordova](https://github.com/Faceplugin-ltd/FaceRecognition-Ionic-Cordova)
- [Face Recognition + Liveness โ Ionic Capacitor](https://github.com/Faceplugin-ltd/FaceRecognition-Ionic-Capacitor)
- [Face Recognition + Liveness โ Docker for Linux](https://github.com/Faceplugin-ltd/FaceRecognition-Docker)
- [Face Recognition + Liveness โ Windows](https://github.com/Faceplugin-ltd/FaceRecognition-Windows)
- [Face Recognition + Liveness โ .NET MAUI](https://github.com/Faceplugin-ltd/FaceRecognition-.Net)
- [Face Recognition + Liveness โ .NET WPF](https://github.com/Faceplugin-ltd/FaceRecognition-WPF-.Net)
### ID Document Recognition SDKs
- [ID Document Recognition โ Android](https://github.com/Faceplugin-ltd/ID-Document-Recognition-Android) ยท Java, Kotlin
- [ID Document Recognition โ iOS](https://github.com/Faceplugin-ltd/ID-Document-Recognition-iOS) ยท Objective-C, Swift
- [ID Document Recognition โ Flutter](https://github.com/Faceplugin-ltd/ID-Document-Recognition-Flutter)
- [ID Document Recognition โ React Native](https://github.com/Faceplugin-ltd/ID-Document-Recognition-React-Native)
- [ID Document Recognition โ Ionic Cordova](https://github.com/Faceplugin-ltd/ID-Document-Recognition-Ionic-Cordova)
- [ID Document Recognition โ Ionic Capacitor](https://github.com/Faceplugin-ltd/ID-Document-Recognition-Ionic-Capacitor)
- [ID Document Recognition โ Docker for Linux](https://github.com/Faceplugin-ltd/ID-Document-Recognition-Docker)
- [ID Document Recognition โ Windows](https://github.com/Faceplugin-ltd/ID-Document-Recognition-Windows)
### ID Document Liveness Detection SDK
- [ID Document Liveness Detection](https://github.com/Faceplugin-ltd/ID-Document-Liveness-Detection-Docker)
---
## ๐ค Support & Contact
While there are many ways to support this project, starring โญ๏ธ this GitHub repository is one of the simplest and most impactful. It increases discoverability and helps the project reach a wider audience. Thank you for your support ๐
