Licensing

Licensing

The FaceSDK is licensed by

• modules (modules) and its versions
• expiration date
• CPU or CPU+GPU mode
• batch size (for GPU)
• number of faces in the enrolment DB (fir_list_size) for 1:N matching

Licenses are valid for the specific version of the SDK.

License can be obtained automatically via Tech5 server of licenses or via manual request.

Type of license

FaceSDK provides two types of licenses: HW-bound (default) and Time-bound.
HW-bound license works only on devices for which were issued. Time-bound license works on any device, but it can't be issued for more than five years.
NOTE!!! Time-bound license is compatible with FaceSDK 1.14.0 or higher.

How to work with Tech5 server of licenses

Server of licenses allows to obtain licenses for Tech5 FaceSDK automatically, if you can bring your devices (or machines) online.

Server of licenses: scheme of work

1. Receive Project Token from Tech5 Support Team or your personal manager.
2. Call one of face_sdk::make_remote_license methods to get an license object and pass the object to SDK module factory methods.
   OR
   Set environment variables FACE_SDK_REMOTE_LICENSE_DEFAULT=1 and FACE_SDK_REMOTE_LICENSE_TOKEN=YOUR_TOKEN to use remote licensing by default.

To use Time-bound license:
Call one of face_sdk::make_remote_license with specified time_bound flag methods
OR
Set environment variable FACE_SDK_REMOTE_LICENSE_TIME_BOUND=1
Server of licenses has the information about number of purchased licenses linked to your Project Token.
When your device (or machine) requires a license for a first time Server of licenses registers the device (or machine). When number of registered devices exceeds limit (number of purchased licenses) Server of licenses will decline the request and FaceSDK will throw the exception.

NOTE!!! By default FaceSDK stores the license in temporary directory. Use face_sdk::make_remote_license overload methods which allow to control where you store the license. If your devices or machines work offline after getting the license, make sure that license file is not stored in temporary directory.

How to get the license manually

1. Make face_sdk.req file.

Note: iOS license request (.req file) can only be obtained through call to face_sdk library function. Refer to license example

Run face_sdk_utils under root user:

sudo /usr/local/bin/face_sdk_utils --request --out $PWD/face_sdk.req

for GPU: pass GPU ids to the "--gpu-ids [list of GPU ids]" face_sdk_utils parameter, for example:

sudo /usr/local/bin/face_sdk_utils --request --out $PWD/face_sdk.req  --gpu-ids 0 1

where 0, 1 are GPU ids which FaceSDK uses
Run face_sdk_utils with "--print-uuid" key for print available uuids and GPU ids on local machine:

sudo /usr/local/bin/face_sdk_utils --print-uuid

output be like this:

MB: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
GPU [0]: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
GPU [1]: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

1. Send face_sdk.req to suppo.nosp@m.rt@t.nosp@m.ech5-.nosp@m.sa.c.nosp@m.om
2. Copy received face_sdk.lic to one of known paths (see ref known_paths) or put face_sdk.lic in process's working dir

License YML format

Look at example below:

face_sdk:
    gpu_support: on    
    face_detector:
        version: 200
        max_batch_size: 512
        expires: never
    alignment:
        version: 103
        max_batch_size: 512
        expires: never    
    builder:
        version: 105
        max_batch_size: 512
        expires: never    
    age_gender:
        version: 100
        max_batch_size: 512
        expires: never    
    matcher:
        version: 106
        fir_list_size: 50000000
        expires: never
    tracker:
        version: 101
        expires: never