Faceplugin-ltd / Open-Source-Face-Recognition-SDK

# Open Source Face Recognition SDK
 **The world's first completely free and open-source face recognition SDK for Windows and Linux from Faceplugin**
---
## 🚀 Overview
The **Open Source Face Recognition SDK** by Faceplugin 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)
 [code] 
2. **Create and activate conda environment**
 [code] 
3. **Install dependencies**
 [code] 
4. **Test the installation**
 [code] 
---
## 📖 Quick Start
### Basic Usage
 [code] 
### Example: Face Comparison
 [code] 
---
## 🔧 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 custome