Open Source

Free on-premise Python Face Recognition sample for Windows and Linux. Detect, embed, and compare faces locally. Lower accuracy than Faceplugin’s commercial HTTP API on port 8083.

Code

GitHub - Faceplugin-ltd/Open-Source-Face-Recognition-SDK: Face Recognition, Face Liveness Detection, Face Anti-Spoofing, Face Detection, Face Landmarks, Face Compare, Face Matching, Face Pose, Face Expression, Face Attributes, Face Templates Extraction, Face LandmarksGitHub

Overview

The Open Source Face Recognition SDK is a free Python sample for Windows and Linux. It detects faces, extracts embeddings, and compares them on your machine (no Faceplugin cloud).

Accuracy is lower than the commercial Face Recognition SDK. Contact Faceplugin if you need the higher-accuracy native engine. This sample is not the commercial Android/iOS or HTTP engine.

Setup

Prerequisites

Python 3.9 or higher
Anaconda (recommended for dependency management)
Windows or Linux operating system

Setup Instructions

Install Anaconda (if not already installed)

# Download from: https://www.anaconda.com/products/distribution

Create and activate conda environment

conda create -n facesdk python=3.9
conda activate facesdk

Install dependencies
```
pip install -r requirements.txt
```
Test the installation
```
python run.py
```

Quick Start

Basic Usage

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

# 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}")

APIs

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

FAQ

Is this the commercial SDK? No. Contact Faceplugin for the higher-accuracy native engine.

Does it run on-premise? Yes. Processing stays on the user’s Windows or Linux machine.

PreviousWindows

NextLinux

Last updated 8 days ago