.. TFSDK documentation master file, created by
   sphinx-quickstart on Wed Oct 16 20:57:00 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Python Bindings Reference - Stable
=========================

Version ``SDK_VERSION``

- `Alpha <https://reference.trueface.ai/cpp/dev/latest/py/index.html>`_
- `Beta <https://reference.trueface.ai/cpp/staging/latest/py/index.html>`_
- `Stable <https://reference.trueface.ai/cpp/master/latest/py/index.html>`_

Getting Started
###############

Start by `downloading <../index.html>`_ the correct version of the python bindings library.
Next, place the python bindings library in the same directory containing your python script.
Alternatively, you can add the path to the directory containing the python bindings library to your ``PYTHONPATH`` environment variable.
You may also need to add this directory to your ``LD_LIBRARY_PATH`` environment variable.

The SDK must first be configured to your desired settings. Consult the general section for the various configuration options.

.. toctree::
   :maxdepth: 2
   :caption: Python Bindings (Stable) - Contents:

   general
   license
   image
   face_detection
   face_recognition
   identification
   object
   spoof
   pose
   liveness
   mask
   eyeglasses
   environment
   faq
   changelog
   releases

* :ref:`genindex`