Installation
On this page, you will find the installation prerequisites for Face SDK Web Service, an overview of installation types and supported features, and links to platform-specific installation guides.
- General Prerequisites
- GPU Prerequisites
- Installation Types and Features
- Installation Guides
- Processing Versions Types
General Prerequisites
The Face SDK Web Service includes four main features:
- Detection
- Comparison 1:1 (aka Match)
- Liveness Assessment
- Identification 1:N (aka Search)
To use Detection and Comparison, you do not need any additional components.
For Liveness Assessment and Identification, you should install and configure the following components:
| Milvus | Storage | Database | |
|---|---|---|---|
| Liveness Assessment | ✅ | ✅ | |
| Identification (aka Search) |
✅ | ✅ | ✅ |
For more information about the additional components and why they are required, see the Product Architecture page.
Refer to the performance and scaling recommendations here: Face SDK Performance Guide.
GPU Prerequisites
If you plan to use the GPU processing version, make sure the target machine has a supported NVIDIA GPU and that the required GPU software stack is installed.
Container installations:
- NVIDIA driver >= 570
Package installations:
- NVIDIA driver >= 570
- CUDA 12.8
- cuDNN 9.17.1
Supported GPUs:
- The GPU must support NVIDIA CUDA Compute Capability >= 7.5, see CUDA GPU Compute Capability for details.
- Supported NVIDIA GPU architectures: Turing, Ampere, Ada Lovelace, Hopper, Blackwell.
In containerized environments, ensure that memory requests and limits are set and properly configured to prevent unpredictable resource consumption and avoid Out-Of-Memory (OOM) events.
Installation Types and Features
Depending on the required functionality, you should choose one of the following installation types:
- Basic
- Advanced: Liveness
- Advanced: Identification
- Advanced: Full Functionality
Each installation type supports a certain set of features:
| Detection | Comparison (aka Match) |
Identification (aka Search) |
Liveness Assessment | |
|---|---|---|---|---|
| Basic | ✅ | ✅ | ||
| Advanced: Liveness |
✅ | ✅ | ✅ | |
| Advanced: Identification |
✅ | ✅ | ✅ | |
| Advanced: Full |
✅ | ✅ | ✅ | ✅ |
Warning
For using the Liveness feature, you need to provide secure communication over the Internet and use only HTTPS. Thus, for the Advanced: Liveness and Advanced: Full Functionality types make sure to enable SSL, see the Configuration page for details.
Installation Guides
Here are the installation guides for different configurations.
Note that Windows supports only the Basic and Advanced: Liveness installation types.
| Platforms | Basic | Advanced: Liveness |
Advanced: Identification |
Advanced: Full |
|---|---|---|---|---|
| Containers | open guide | open Helm guide open Docker guide |
open Helm guide open Docker guide |
open guide |
| Windows | open guide | open guide | ❌ | ❌ |
| Linux | open guide | open guide | ❌ | ❌ |
Processing Versions Types
- CPU
- GPU