.. 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.
Note, the CPU python bindings library contains the static SDK library (so you do not need to download libtf.a library separately).
If using the GPU python bindings library, then you will require both the python bindings library as well as libtf.so (both are packaged in the download zip).
Ensure that libtf.so is in your ``LD_LIBRARY_PATH``. You can confirm this by running ``ldd`` on the bindings library and ensuring that all dependencies are met.


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
   identification
   object
   spoof
   pose
   liveness
   mask
   eyeglasses
   environment
   faq
   changelog
   releases

* :ref:`genindex`