General

SDK.__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: tfsdk.SDK) -> None

2. __init__(self: tfsdk.SDK, arg0: Trueface::ConfigurationOptions) -> None

static SDK.get_version() → str

Get the SDK version

class tfsdk.FACIALRECOGNITIONMODEL

Members:

LITE : Lightweight model with faster inference time, ideal for embedded systems

FULL : Full model with improved accuracy

class tfsdk.OBJECTDETECTIONMODEL

Members:

ACCURATE

FAST

class tfsdk.FACEDETECTIONMODE

Members:

ROBUST : The ROBUST mode is optimized for face recognition, smallestFaceHeight less than 80 pixels will be overridden.

VERSATILE : The VERSATILE mode can detect small faces (as small as 16x16 pixel) and can be faster than the ROBUST mode.

class tfsdk.FACEDETECTIONFILTER

Members:

HIGH_RECALL : The detected face scores are thresholded to have a low precision and a high recall rate.

HIGH_PRECISION : The detected face scores are thresholded to have a high precision and a low recall rate.

BALANCED : The detected face scores are thresholded to have a medium precision and recall rate.

UNFILTERED : The detected face scores are not thresholded.

class tfsdk.DATABASEMANAGEMENTSYSTEM

Members:

SQLITE : Use sqlite backend. Write templates to local disk. Ideal for embedded systems or use cases where only one process connects to the database.

POSTGRESQL : Use PostgreSQL backend. Ideal for distributed systems requiring synchronization.

NONE : Do not write template to disk, only store in ram. Warning, enrolled templates will not be saved after the program terminates

class tfsdk.ConfigurationOptions

property GPU_device_index

GPU device index (default is 0)

property dbms

Database management system for storing templates (default is SQLITE). See DATABASEMANAGEMENTSYSTEM

property enable_GPU

Enable GPU support (default is false). Note, GPU support requires a different version of the SDK.

property fd_filter

The face detection precision-recall mode (default is BALANCED). See FACEDETECTIONFILTER

property fd_mode

The face detection mode (default is VERSATILE). See FACEDETECTIONMODE

property fr_model

The model to be used for facial recognition (default is LITE model). See FACIALRECOGNITIONMODEL

property fr_vector_compression

Improves the computation speed for 1 to 1 comparisons and 1 to N searches.Also reduces the feature vector length. (default is False)

property models_path

The directory path containing the model files (default is ./ )

property obj_model

The model to be used for object detection (default is ACCURATE model). See OBJECTDETECTIONMODEL

property smallest_face_height

The smallest face height that the face detector can detect (default is 20 pixels). The face detector has a detection scale range of about 5 octaves. Ex. 40 pixels yields the detection scale range of ~40 pixels to 1280 (=40x2^5) pixels. If set to -1, will dynamically adjusts the face detection scale range from image-height/32 to image-height to ensure that large faces are detected in high resolution images.

class tfsdk.ERRORCODE

Members:

NO_ERROR

INVALID_LICENSE

FILE_READ_FAIL

UNSUPPORTED_IMAGE_FORMAT

UNSUPPORTED_MODEL

NO_FACE_IN_FRAME

COLLECTION_CREATION_ERROR

DATABASE_CONNECTION_ERROR

ENROLLMENT_ERROR

FAILED