SDK Evaluation Getting Started Guide

This guide outlines the steps for getting started with an evaluation of the Trueface SDK.

Prerequisite: Ensure your target hardware meets the minimum and recommended hardware requirements.

Visit the following page and ensure your runtime hardware meets the minimum required hardware specified for the SDK.

Minimum & Recommended Hardware Requirements

1. Visit our benchmarks page to get an understanding of the performance to expect.

Visit the following page and view the CPU and GPU benchmarks for the hardware and target which is most similar to your deployment environment. This should give you an idea of the performance to expect.


2. Download the appropriate SDK for your target platform.

Go to the SDK downloads page and download the appropriate SDK for your target platform and language of choice.

3. Run the sample code which comes shipped with the SDK.

The SDK download bundle contains sample code that demonstrates the ideal usage of all the SDK modules. Start by extracting the download bundle, then be sure to read all the provided readme.md files as they contain further information and build/run instructions. The sample code also contains helpful comments for more detailed guidance.

4. Consult the documentation.

While running the sample code, simultaneously read through the documentation in order to start familiarizing yourself with the SDK API.

5. Consult the FAQ page.

Now that you have an overview of how the SDK works, it's time to gain a better understanding of the internals. Consult our FAQ page for details on optimizations, threading, and recommended design patterns.

6. If running face recognition, consult our ROC curves in order to choose an optimal operating threshold.

We advise each of our clients to choose an operating threshold that is best suited for their use case. By knowing your desired False Positive Rate or False Negative Rate, you can use the ROC curve to choose an operating threshold.

ROC Curves

7. View our sample apps.

Our sample apps are an extension of our sample code and demonstrate how to build more involved applications, often involving things like video decoding and multithreaded models.

8. Upgrade your SDK version. [optional]

We tend to push out new features and bug fixes relatively often, so it is a good idea to upgrade your SDK version when a new one is available. Be sure to consult the Changelog file and read through all the changes before upgrading to ensure your existing applications don't break.