.. _requirements:

***********************************
Requirements
***********************************

.. rubric:: In this chapter:

.. contents::
   :local:



System Requirements for Basic Configuration
=================================================


To calculate the FindFace host(s) characteristics, use the requirements provided below.

.. tip::
   Be sure to learn about the FindFace :ref:`architecture <architecture>` first.

.. important::
   If the video resolution is more than 1280x720px, it is strongly recommended to use the GPU-accelerated package ``findface-video-worker-gpu``. 

.. important::
   On AMD CPU servers, the full functionality of the CPU-accelerated ``findface-extraction-api`` service is not guaranteed. Use the GPU-accelerated service ``findface-extraction-api-gpu`` along with the GPU-version of neural networks instead.

.. note::
   In the case of a high-load system (~> 15 events per second), we recommend using an SSD.


+------------------+------------------------------------------------------------------------+------------------------------------------------------------------+
|                  | Minimum                                                                | Recommended                                                      |
+==================+========================================================================+==================================================================+
| CPU              | Intel Core i5 CPU with 4+ physical cores 3+ GHz. AVX2 support          | Intel Xeon Silver/Gold with 6+ physical cores                    |
|                  +------------------------------------------------------------------------+------------------------------------------------------------------+
|                  | The own needs of FindFace require 2 cores HT > 2.5 GHz. The characteristics also depend on the number of                                  |
|                  | video files in process. A single video file ``720p@25FPS`` requires 2 cores >2.5 GHz. AVX2 support.                                       |
+------------------+------------------------------------------------------------------------+------------------------------------------------------------------+
| GPU (optional)   | NVIDIA GeForce® GTX 1060 6 GB                                          | NVIDIA GeForce® GTX 1080Ti+ with 11+ GB RAM                      |
|                  +------------------------------------------------------------------------+------------------------------------------------------------------+
|                  | Supported devices: NVIDIA, Pascal architecture and above.                                                                                 |
|                  |                                                                                                                                           |
|                  | *Note: NVIDIA GeForce RTX 40 Series graphics cards are currently not supported*.                                                          |
+------------------+------------------------------------------------------------------------+------------------------------------------------------------------+
| RAM              | 10 Gb                                                                  | 16+ Gb                                                           |
|                  +------------------------------------------------------------------------+------------------------------------------------------------------+
|                  | The own needs of FindFace require 8 Gb.                                                                                                   |
|                  | The RAM consumption also depends on the number of video files in process. A single video file ``720p@25FPS`` requires 2 GB RAM.           |           
+------------------+------------------------------------------------------------------------+------------------------------------------------------------------+
| HDD (SSD for     | 16 Gb                                                                  | 16+ Gb                                                           |
| best             +------------------------------------------------------------------------+------------------------------------------------------------------+
| performance)     | The own needs of the operating system and FindFace require 15 GB. The total volume is subject to the required depth of the event          |
|                  | archive in the database and in the log, at the rate of 1.5 Mb per 1 event.                                                                |      
+------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Operating system | Ubuntu from 18 to 22, x64 only,                                                                                                           |
|                  | RHEL / CentOS 7, Debian 11.                                                                                                               |
+------------------+-------------------------------------------------------------------------------------------------------------------------------------------+


.. note::
   You can also use an Intel-based VM if there is AVX2 support, and eight physical cores are allocated exclusively to the VM.

.. tip::
   For more accurate hardware selection, contact our support team by support@ntechlab.com.



Required Administrator Skills
================================

A FindFace Multi administrator must know and understand OS, on which the product instance is deployed, at the level of an advanced user.

.. _video-files:

Video File Formats
==============================

FindFace Multi supports a wide variety of file formats depending on the acceleration type, CPU or GPU.

Both CPU- and GPU-accelerated instances support all FFmpeg codecs. In addition to that, the following codecs are supported:

* :guilabel:`CPU-based acceleration`: FLV (both as a codec and as a container), H263, H264, H265, MJPEG, VP8, VP9, MPEG1VIDEO, MPEG2VIDEO, MSMPEG4v2, MSMPEG4v3.
* :guilabel:`GPU-based acceleration`: MJPEG, H264, H265, VP9, and others, depending on the list of codecs supported by the used video card. Apart from that, for instances with ``video-worker-gpu``, you can expand the number of supported codecs by enabling video decoding on the CPU, which is not available by default.	

To enable video decoding on the CPU for GPU-based acceleration, do the following:

#. Open the ``/opt/findface-multi/configs/findface-video-worker/findface-video-worker.yaml`` file.

   .. code::

      sudo vi /opt/findface-multi/configs/findface-video-worker/findface-video-worker.yaml

#. Set ``cpu: true`` in the ``video_decoder`` section.

   .. code::
     
     ...
     video_decoder:
       cpu: true
     ...

#. Restart ``findface-multi-findface-video-worker-1`` container.

   .. code::

      sudo docker container restart findface-multi-findface-video-worker-1