.. TruefaceSDK documentation master file, created by
   sphinx-quickstart on Mon Sep 16 22:16:39 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Trueface SDK Reference
======================

Downloads - TRUEFACE_RELEASE_TYPE Release
#############################
Version ``SDK_VERSION``

x86-64 C++
**********

| `C++ x86-64 CPU Linux <uploads/truefaceSDK.zip>`_
| sha256: ``SHA256_x86_cpu_linux_cpp...``

| `C++ x86-64 GPU CUDA-10.1 Linux <uploads/cuda/truefaceSDK_GPU.zip>`_
| sha256: ``SHA256_x86_gpu_linux_cpp...``

| `C++ x86-64 CPU macOS <uploads/mac/truefaceSDK.zip>`_
| sha256: ``SHA256_x86_cpu_macos_cpp...``

x86-64 Python bindings
**********************
| **Python bindings Documentation**
| Python bindings documentation can be found `here <py/index.html>`_

| `Python 3.6 64Bit CPU Linux <uploads/tfsdk_python3.6.zip>`_
| sha256: ``SHA256_x86_cpu_linux_python3_6...``

| `Python 3.6 64Bit GPU CUDA-10.1 Linux <uploads/cuda/tfsdk_python3.6.zip>`_
| sha256: ``SHA256_x86_gpu_linux_python3_6...``

| `Python 3.7 64Bit CPU Linux <uploads/tfsdk_python3.7.zip>`_
| sha256: ``SHA256_x86_cpu_linux_python3_7...``

| `Python 3.7 64Bit CPU macOS <uploads/mac/tfsdk_python3.7.zip>`_
| sha256: ``SHA256_x86_cpu_macos_python3_7...``

| `Python 3.7 64Bit GPU CUDA-10.1 Linux <uploads/cuda/tfsdk_python3.7.zip>`_
| sha256: ``SHA256_x86_gpu_linux_python3_7...``


Mobile
******

| `iOS <uploads/ios/tfsdk_ios.zip>`_
| sha256: ``SHA256_ios...``

`Android <https://docs.trueface.ai/Getting-started-with-the-Trueface-Android-SDK-5b24c4e92c44453c8ba52cbc4f4cdb03>`_

ARM
***

| `Aarch64 CPU Linux <uploads/arm/truefaceSDK_aarch64.zip>`_
| sha256: ``SHA256_aarch64_cpu_linux...``

| `Arm32 CPU Linux <uploads/arm/truefaceSDK_arm32.zip>`_
| sha256: ``SHA256_arm32_cpu_linux...``

For embedded devices with limited disk space, use the following libraries which have the full model disabled to reduce binary size.

| `Aarch64 CPU lite Linux <uploads/arm/truefaceSDK_aarch64_lite.zip>`_
| sha256: ``SHA256_aarch64_cpu_lite_linux...``

| `Arm32 CPU lite Linux <uploads/arm/truefaceSDK_arm32_lite.zip>`_
| sha256: ``SHA256_arm32_cpu_lite_linux...``

Sample Apps
===========
`Sample Apps <https://github.com/getchui/sample-apps>`_ which demonstrate full working applications.

Getting Started
===============
Start by downloading the correct version of the SDK. Next, the SDK must be initialized.
Refer to the general section for the various configuration options.


.. toctree::
   :maxdepth: 2
   :caption: C++ - Contents:

   usage/general
   usage/license
   usage/image
   usage/face
   usage/identification
   usage/object
   usage/spoof
   usage/pose
   usage/liveness
   usage/mask
   usage/eyeglasses
   ./faq
   ./changelog

* :ref:`genindex`