==============================
|product-name|
==============================

.. meta::
   :robots: noindex, nofollow

.. toctree::
   :maxdepth: 1
   :hidden:

   introduction
   requirements
   quick_start
   licensing
   distribution
   troubleshooting

.. toctree::
   :maxdepth: 1
   :caption: Usage
   :hidden:

   usage/usage
   usage/license_handling
   usage/image_handling
   usage/error_handling
   usage/ai_models
   usage/face_analysis
   usage/face_background_removal
   usage/face_comparison
   usage/face_comparison_on_card
   usage/face_detection
   usage/face_encoding
   usage/face_tracking
   usage/face_search
   usage/liveness_detection
   usage/portrait_processing

.. toctree::
   :maxdepth: 1
   :caption: Reference
   :hidden:

   reference/face/api

.. toctree::
   :maxdepth: 1
   :caption: ABOUT
   :hidden:

   release_notes
   license_agreement
   third-party-libraries
   terms
   faq


|product-name| is a cross-platform library aimed at system integrators willing to quickly add face detection, recognition, PAD and/or analysis capabilities to their products. It is available as a Software Development Kit (SDK) offering a comprehensive interface to simplify integration of the library on servers, desktops/laptops, mobile and edge devices.

This user guide is intended to help developers quickly get started with the SDK, covering the setup, basic operations, advanced features, and troubleshooting tips to ensure a smooth integration process.

Features 
========

|product-name| offers the following features and benefits:

- Top performance facial biometrics, AI powered
- Optimized for AI hardware, including GPU acceleration, for fast operation
- Robust human face detection and tracking in digital images or video frames
- Small facial features template (268 bytes or 140 bytes)
- Ultra-fast face template matching in one-to-one comparison and one-to-many search modes
- Multiple face analysis functionalities: landmarks estimation, pose estimation, mask detection, etc.
- Facial attributes determination for ICAO compliant portraits
- Face image quality assessment
- Accurate passive liveness detection methods to protect against biometric fraud, e.g. presentation attacks with photos and videos
- Compact library designed to run on most hardware configurations from high-end workstations to low-power edge devices
- Compatible with Windows, Linux, MacOS, Android and iOS operating systems
- Simple and comprehensive programming interface in various languages

Applications
============

- Public Safety
- Border Control
- Mobile apps
- ID Management
- Banking \& Payment
- Automobile \& Transportation
- Healthcare

Editions
========

|product-name| is available in the following editions:

.. list-table:: 
  :width: 100%
  :widths: 15 30 55
  :header-rows: 1

  * - Edition
    - Platforms
    - Description
  * - Server
    - Windows, Linux or macOS
    - | Full-featured edition generally used for server or desktop-based applications.
      | Enables one-to-many search mode.
  * - Mobile
    - Android, iOS
    - This edition is for mobile applications.
..   * - Edge
..     - Raspberry PI, NXP iMX
..     - This edition is optimized for embedded systems.

Support
=======

Should you encounter any issues or have questions while using the SDK, our dedicated support team is ready to assist you. Visit our Customer Portal Page (https://customer.id3.eu) or contact us directly at support@id3.eu for help.


Indices and tables
==================

* :ref:`genindex`

