Python Bindings Reference - Stable¶
Version 2.0.28060
Getting Started¶
Start by downloading 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 must then add the path to the directory containing any dependency libraries such as onnxruntime to your LD_LIBRARY_PATH
environment variable (if the dependency libraries are not in the same directory as the Trueface python bindings library).
The SDK must first be configured to your desired settings. Consult the general section for the various configuration options.
- General
- License Validation
- Input Image
- Face Detection
- Face Image Quality
- 1 to 1 Face Recognition
- 1 to N Identification
- Object Detection
- Spoof Detection
- Body Pose Estimation
- Blink Detection
- Mask Detection
- Eye glasses Detection
- Image Annotation
- Environment Variables
- Frequently Asked Questions
- How many threads does the SDK use for inference?
- How can I reduce the number of threads used by the SDK?
- How can I run inference with multiple instances of the SDK on a single CPU?
- How can I increase throughput?
- Is the SDK threadsafe?
- How do I choose a similarity threshold for face recognition?
- What are the differences between the face recognition models?
- Are Faceprints compatible between models?
- How can I upgrade my collection if is filled with Faceprints from a deprecated model?
- What is the difference between similarity score and match probability?
- Why are small faces not being detected in my very high resolution images?
- What is the impact of various factors on the face recognition similarity score?
- How to select the best image for enrollment?
- What is the difference between the static library and the dynamic library?
- What hardware does the GPU library support?
- What is the TensorRT engine file and what is it used for?
- Why is my license key not working with the GPU library?
- Why does the first call to an inference function take much longer than the subsequent calls?
- What does a typical 1 to N face recognition pipeline involve?
- What architecture should I use when I have multiple camera streams producing lots of data?
- Why was setImage replaced by preprocessImage?
- How do I use the python bindings for the SDK?
- How do createDatabaseConnection and createLoadCollection work?
- What does the frVectorCompression flag do? When should I use it?
- Changelog
- v2.0 August 21, 2023
- v1.8 July 24, 2023
- v1.7 June 23, 2023
- v1.6 March 30, 2023
- v1.5: February 22, 2023
- v1.4: December 29, 2022
- v1.3: October 13, 2022
- v1.2: July 22, 2022
- v1.1: June 10, 2022
- v1.0: May 10, 2022
- v0.33: November 15, 2021
- v0.32: October 15, 2021
- v0.31: October 15, 2021
- v0.30: September 24, 2021
- v0.29: September 13, 2021
- v0.28: August 18, 2021
- v0.27: August 2, 2021
- v0.26: July 6, 2021
- v0.25: June 22, 2021
- v0.24: June 8, 2021
- v0.23: May 27, 2021
- v0.22: May 12, 2021
- v0.21: May 4, 2021
- v0.20: April 26, 2021
- v0.19: April 14, 2021
- v0.18: March 29, 2021
- v0.17: March 11, 2021
- v0.16: February 25, 2021
- v0.15: February 16, 2021
- v0.14: January 25, 2021
- v0.13: January 15, 2021
- v0.12: January 4, 2021
- v0.11: December 23, 2020
- v0.10: December 11, 2020
- v0.9: November 20, 2020
- v0.8: November 9, 2020
- v0.7: August 14, 2020
- v0.6: July 7, 2020
- Previous Stable Releases
- 2.0.27928
- 1.8.27271
- 1.7.26589
- 1.6.25368
- 1.5.24600
- 1.4.23700
- 1.3.21916
- 1.2.20713
- 1.1.19673
- 1.0.19187
- 1.0.18283
- 0.33.14634
- 0.33.13850
- 0.32.13387
- 0.32.13359
- 0.32.13313
- 0.30.12706
- 0.29.12214
- 0.29.12111
- 0.28.11386
- 0.27.10876
- 0.26.10390
- 0.25.10099
- 0.24.9786
- 0.24.9740
- 0.23.9508
- 0.23.9476
- 0.22.9292
- 0.22.9196
- 0.21.8922
- 0.20.8553
- 0.19.8416
- 0.18.7976
- 0.17.7745
- 0.17.7722
- 0.16.7561
- 0.16.7542
- 0.15.7233
- 0.15.7198
- 0.15.7184
- 0.14.6743
- 0.14.6732
- 0.14.6709
- 0.14.6699
- 0.13.6676
- 0.13.6670
- 0.13.6500
- 0.12.6330
- 0.12.6300
- 0.11.6229
- 0.10.5855
- 0.10.5732
- 0.9.5131
- 0.8.4786
- 0.7.3005