example_doc.md

Step-by-step to use FACE01 library

Welcome to FACE01 world!

In this article, I will introduce the necessary knowledge and techniques to create an application that uses face recognition using FACE01 with an example program.

Are you ready?

Let's check the checks you must pass as step. 1.

TOC

1. Step-by-step to use FACE01 library
   1. Checks you must pass
   2. Register face images
   3. activate virtual python mode
   4. Check vim installed
2. Simple flow for using FACE01
3. Simple face recognition
4. Display GUI window
5. Display 'telop' and 'logo' images which you're company's.
6. Want to benchmark?
7. Example list
8. Troubleshooting:thinking:
   1. CUDA not working
   2. What to do when dlib.DLIB_USE_CUDA is False

Checks you must pass

✅

• Basic operation of Python
• Basic operation of Docker
• Basic operation of Linux terminal
• (If using Nvidia GPU) CUDA driver is already installed

Have you checked everything?
OK! Let's get started!

Register face images

This article describes how to register face images.

See here.

activate virtual python mode

Start the virtual environment using venv of the Python standard library.

# activate venv
. bin/activate

Check vim installed

The Docker Image comes with vim installed so you can edit conf.ini.

# Check vim installed
which vim

Simple flow for using FACE01

It is an example of how to use FACE01, but let's look at a simple flow.

See here.

Simple face recognition

Let' try simple.py. simple.py is an example script for CUI behavior.

python example/simple.py

See here.

Display GUI window

Want to display in a cool GUI window?
Try example/display_GUI_window.py.
See here.

python example/display_GUI_window.py

See here.

Display 'telop' and 'logo' images which you're company's.

Do you want your window to display your company logo or something?
Of course you can!
See here.

Want to benchmark?

See here.

Example list

# 1. Simple
python example/simple.py

# 2. Display GUI window
python example/display_GUI_window.py

# 3. logging
python example/example_logging.py

# 4. data structure
python example/data_structure.py

# 5. Benchmark with CUI mode
python example/benchmark_CUI.py

# 6. Benchmark with GUI mode
python example/benchmark_GUI_window.py

# Other
- example/aligned_crop_face.py
- example/anti_spoof.py
- example/distort_barrel.py
- example/draw_datas.py
- example/face_coordinates.py
- example/get_encoded_data.py
- example/lightweight_GUI.py
...and others.

For more information about FACE01 many Classes and methods, see FACE01 document.

Troubleshooting:thinking:

CUDA not working

See Remove all cuda lib and re-install method

What to do when dlib.DLIB_USE_CUDA is False

See What to do when dlib.DLIB_USE_CUDA is False