Face Recognition SDK - Server
This stands for face recognition docker, facial recognition docker, face matching docker, face comparison docker, face search engine docker, face identification docker, face search ID docker on server
We implemented face recognition SDK on docker container
We provide the Face Recognition SDK for both Windows and Linux.
Features
License
We offer lifetime licenses per machine for Servers (Windows, Linux).
To request a license, please contact us:
Email: contact@kby-ai.com
Telegram: @kbyai
WhatsApp: +19092802609
Skype: live:.cid.66e2522354b1049b
System Requirements
1. Windows
CPU: 2 cores or more (Recommended: 2 cores)
RAM: 4 GB or more (Recommended: 8 GB)
HDD: 4 GB or more (Recommended: 8 GB)
OS: Windows 7 or later
Architecture: x64
Dependency: OpenVINO™ Runtime (Version: 2022.3), ncnn Runtime(20220721), Vulkan SDK Runtime(1.3.250)
2. Linux
CPU: 2 cores or more (Recommended: 2 cores)
RAM: 4 GB or more (Recommended: 8 GB)
HDD: 4 GB or more (Recommended: 8 GB)
OS: Ubuntu 20.04 or later
Architecture: x64
Dependency: OpenVINO™ Runtime (Version: 2022.3)
Import SDK
Python
C++
Initializing SDK
Step one
First, obtain the machine code for activation and request a license based on the machine code.
Step Two
Next, activate the SDK using the received license.
If activation is successful, the return value will be SDK_SUCCESS. Otherwise, an error value will be returned.
Step Three
After activation, call the initialization function of the SDK.
The first parameter is the path to the model.
If initialization is successful, the return value will be SDK_SUCCESS. Otherwise, an error value will be returned.
Enums and Structure
1. SDK_ERROR
This enumeration represents the return value of the 'initSDK' and 'setActivation' functions.
Feature | Value | Name |
---|---|---|
Successful activation or initialization | 0 | SDK_SUCCESS |
License key error | -1 | SDK_LICENSE_KEY_ERROR |
AppID error (Not used in Server SDK) | -2 | SDK_LICENSE_APPID_ERROR |
License expiration | -3 | SDK_LICENSE_EXPIRED |
Not activated | -4 | SDK_NO_ACTIVATED |
Failed to initialize SDK | -5 | SDK_INIT_ERROR |
2. FaceBox
This class represents the output of the face detection function that contains the detected face rectangle, liveness score, and facial angles such as yaw, roll, and pitch.
Feature | Type | Name |
---|---|---|
Face rectangle | int | x1, y1, x2, y2 |
Face angles (-45 ~ 45) | float | yaw, roll, pitch |
Face quality (0 ~ 1) | float | face_quality |
Face luminance (0 ~ 255) | float | face_luminance |
Eye distance (pixels) | float | eye_dist |
Eye closure (0 ~ 1) | float | left_eye_closed, right_eye_closed |
Face occlusion (0 ~ 1) | float | face_occlusion |
Mouth opening (0 ~ 1) | float | mouth_opened |
68 points facial landmark | float[68 * 2] | landmarks_68 |
Face templates | unsigned char [2048] | templates |
![](https://docs.kby-ai.com/~gitbook/image?url=https%3A%2F%2F2589216230-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1WwtQK0VFwKRGmIjGA3I%252Fuploads%252Fj4XxekdSV6Q6cW9KZhPr%252Fimage.png%3Falt%3Dmedia%26token%3D5ace558a-3793-48f0-9324-e1ec8fe80561&width=768&dpr=4&quality=100&sign=f727f6dc&sv=1)
![](https://docs.kby-ai.com/~gitbook/image?url=https%3A%2F%2F2589216230-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F1WwtQK0VFwKRGmIjGA3I%252Fuploads%252FUIRrOk6XwkLE9EFC5G4k%252Fimage.png%3Falt%3Dmedia%26token%3D564744e4-1b2f-4f00-9ace-afc84bb9f17e&width=768&dpr=4&quality=100&sign=5e9ac073&sv=1)
APIs
1. getMachineCode
First, obtain the machine code for activation and request a license based on the machine code.
2. setActivation
Next, activate the SDK using the received license.
If activation is successful, the return value will be SDK_SUCCESS. Otherwise, an error value will be returned.
3. initSDK
After activation, call the initialization function of the SDK.
The first parameter is the path to the model.
When using Windows, it is necessary to provide the complete file path for the model.
Example:
model_path = "C:\path\to\model"
If initialization is successful, the return value will be SDK_SUCCESS. Otherwise, an error value will be returned.
4. faceDetection
The Face SDK provides a single API for detecting faces, performing liveness detection, determining face orientation (yaw, roll, pitch), assessing face quality, detecting facial occlusion, eye closure, mouth opening, and identifying facial landmarks.
The function can be used as follows:
This function requires 5 parameters.
The first parameter: the byte array of the RGB image buffer.
The second parameter: the width of the image.
The third parameter: the height of the image.
The fourth parameter: the 'FaceBox' array allocated with 'maxFaceCount' for storing the detected faces.
The fifth parameter: the count allocated for the maximum 'FaceBox' objects.
The function returns the count of the detected face.
5. templateExtraction
The SDK provides a function that enables the generation of templates from RGB data. These templates can be used for face verification between two faces.
The function can be used as follows:
This function requires 4 parameters.
The first parameter: the byte array of the RGB image buffer.
The second parameter: the width of the image.
The third parameter: the height of the image.
The fourth parameter: the 'FaceBox' object obtained from the 'faceDetection' function.
If the template extraction is successful, the function will return 0. Otherwise, it will return -1.
6. similarityCalculation
The 'similarityCalculation' function takes a byte array of two templates as a parameter.
It returns the similarity value between the two templates, which can be used to determine the level of likeness between the two individuals.
Default Thresholds
If the similarity value between the two templates is high, it indicates that the faces are the same.
Last updated