Skip to content

Plumerai Familiar Face Identification demo on Arm/x86

This document describes the use of the familiar face identification demo: a ready-to-run binary to evaluate the Plumerai Familiar Face Identification library by running it live with a camera.

Please get in touch with our team to request the Plumerai Familiar Face Identification demo package if you haven't done so yet. Note that it is merely designed as a demo for evaluation purposes, and not for production usage. For production, we offer our Plumerai Familiar Face Identification library, as documented here, which can be integrated into your application.

This demo is an extension of the People Detection Demo. To run it, we recommend to start with the People Detection demo instructions:

After successfully running the regular demo, follow the next steps to enable familiar face identification. This uses the same demo executable.

Step 1: Commandline arguments

The familiar face identification demo has two additional commandline arguments, described below. Append these to the regular commandline arguments obtained in previous steps. For example:

./plumerai_demo <regular arguments> --face_library_filename=my_face_library.txt --face_enroll_names=Alice,Bob,Charlie

Face library filename

Syntax: --face_library_filename=<filename>

Example: --face_library_filename=my_face_library.txt

This argument specifies the path to a file in which enrolled face information is stored. This argument is required to use the familiar face identification features.

Face enroll names

Syntax: --face_enroll_names=<name1,name2,...>

Example: --face_enroll_names=Alice,Bob,Charlie

This argument is a comma-separated list of names. If set, it allows enrolling new faces into the face library.

To confirm that this works, check that the listed names now appear in the top left of the screen.

Step 2: Live enrollment

When both --face_library_filename and --face_enroll_names have been specified, new faces can be enrolled in the face library.

The procedure is as follows:

  1. Start the demo as described above
  2. Choose a person to enroll and make sure only their face is visible.
  3. Press the number key 1, 2, 3,... corresponding to the name of the person.
  4. The person should look into the camera and rotate their face.
  5. Finish enrollment either automatically by completing the progress bar, or by pressing any number key.