Skip to main content

EmotiEffLib Python Library for Facial Emotion and Engagement Recognition

Project description

EmotiEffLib: Library for Efficient Emotion Analysis and Facial Expression Recognition

Tests pypi package License Downloads Downloads Downloads PWC GitHub stars

EmotiEffLib (ex-HSEmotion) is a lightweight library for emotion and engagement recognition in photos and videos. It can be used in Python and C++. It provides flexibility with backend support for Pytorch and ONNX, enabling efficient real-time analysis across various platforms.

This repository contains two implementations of EmotiEffLib: Python and C++.

Documentation

Full documentation is available here.

Installing

Detailed building and installing instruction provided in the pages related to each library: Python and C++.

Quick start guide

Python interface of EmotiEffLib

  • One image emotion recognition notebook Open In Colab
  • Predict emotions on video notebook Open In Colab
  • Predict engagement and emotions on video notebook Open In Colab

C++ interface of EmotiEffLib

  • One image emotion recognition notebook Open In MyBinder
  • Predict emotions on video notebook Open In MyBinder
  • Predict engagement and emotions on video notebook

Usage

Detailed examples of using the Python and C++ modules are provided in the Tutorials.

If you want to run EmotiEffCppLib then prepare the models for inference with C++ library:

python models/prepare_models_for_emotieffcpplib.py

Also, in the folder training_and_examples you can find a number of examples of usage our models and training process. This folder also contains an example of mobile application for recognizing user emotions.

In order to run our code on the datasets, please prepare them firstly using our TensorFlow notebooks: train_emotions.ipynb, AFEW_train.ipynb and VGAF_train.ipynb.

NOTE!!! The models were updated so that they should work with timm library of version 0.9.*. However, for v0.1 version, please be sure that EfficientNet models for PyTorch are based on old timm 0.4.5 package, so that exactly this version should be installed by the following command:

pip install timm==0.4.5

News

  • Our models let our team HSEmotion took the 1st places in the Expression Recognition and Ambivalence/Hesitancy Recognition Challenges and the 3rd places in the Action Unit Detection and Emotional Mimicry Intensity Estimation challenges during the eighth Affective Behavior Analysis in-the-wild (ABAW) Competition
  • Our models let our team HSEmotion took the second place in the Compound Expression Recognition Challenge and the 3rd place in the Action Unit Detection during the sixth ABAW Competition
  • The paper "Facial Expression Recognition with Adaptive Frame Rate based on Multiple Testing Correction" has been accepted as Oral talk at ICML 2023. The source code to reproduce the results of this paper are available at this repository, see subsections "Adaptive Frame Rate" at abaw3_train.ipynb and train_emotions-pytorch-afew-vgaf.ipynb
  • Our models let our team HSE-NN took the first place in the Learning from Synthetic Data (LSD) Challenge and the 3rd place in the Multi-Task Learning (MTL) Challenge in the fourth ABAW Competition
  • Our models let our team HSE-NN took the 3rd place in the multi-task learning challenge, 4th places in Valence-Arousal and Expression challenges and 5th place in the Action Unite Detection Challenge in the third ABAW Competition. Our approach is presented in the paper accepted at CVPR 2022 ABAW Workshop.

Details

All the models were pre-trained for face identification task using VGGFace2 dataset. In order to train PyTorch models, SAM code was borrowed.

We upload several models that obtained the state-of-the-art results for AffectNet dataset. The facial features extracted by these models lead to the state-of-the-art accuracy of face-only models on video datasets from EmotiW 2019, 2020 challenges: AFEW (Acted Facial Expression In The Wild), VGAF (Video level Group AFfect), EngageWild; and ABAW CVPR 2022 and ECCV 2022 challenges: Learning from Synthetic Data (LSD) and Multi-task Learning (MTL).

Here are the performance metrics (accuracy on AffectNet, AFEW and VGAF), F1-score on LSD, on the validation sets of the above-mentioned datasets and the mean inference time for our models on Samsung Fold 3 device with Qualcomm 888 CPU and Android 12:

Model AffectNet (8 classes) AffectNet (7 classes) AFEW VGAF LSD MTL Inference time, ms Model size, MB
mobilenet_7.h5 - 64.71 55.35 68.92 - 1.099 16 ± 5 14
enet_b0_8_best_afew.pt 60.95 64.63 59.89 66.80 59.32 1.110 59 ± 26 16
enet_b0_8_best_vgaf.pt 61.32 64.57 55.14 68.29 59.72 1.123 59 ± 26 16
enet_b0_8_va_mtl.pt 61.93 64.94 56.73 66.58 60.94 1.276 60 ± 32 16
enet_b0_7.pt - 65.74 56.99 65.18 - 1.111 59 ± 26 16
enet_b2_7.pt - 66.34 59.63 69.84 - 1.134 191 ± 18 30
enet_b2_8.pt 63.03 66.29 57.78 70.23 52.06 1.147 191 ± 18 30
enet_b2_8_best.pt 63.125 66.51 56.73 71.12 - - 191 ± 18 30

Please note, that we report the accuracies for AFEW and VGAF only on the subsets, in which MTCNN detects facial regions. The code contains also computation of overall accuracy on the complete testing set, which is slightly lower due to the absence of faces or failed face detection.

Additional models trained using Neural Architecture Search (SuperNet and two subnetworks) are available here

Research papers

If you use our models, please cite the following papers:

@inproceedings{savchenko2023facial,
  title = 	 {Facial Expression Recognition with Adaptive Frame Rate based on Multiple Testing Correction},
  author =       {Savchenko, Andrey},
  booktitle = 	 {Proceedings of the 40th International Conference on Machine Learning (ICML)},
  pages = 	 {30119--30129},
  year = 	 {2023},
  editor = 	 {Krause, Andreas and Brunskill, Emma and Cho, Kyunghyun and Engelhardt, Barbara and Sabato, Sivan and Scarlett, Jonathan},
  volume = 	 {202},
  series = 	 {Proceedings of Machine Learning Research},
  month = 	 {23--29 Jul},
  publisher =    {PMLR},
  url={https://proceedings.mlr.press/v202/savchenko23a.html}
}
@article{savchenko2022classifying,
  title={Classifying emotions and engagement in online learning based on a single facial expression recognition neural network},
  author={Savchenko, Andrey V and Savchenko, Lyudmila V and Makarov, Ilya},
  journal={IEEE Transactions on Affective Computing},
  year={2022},
  publisher={IEEE},
  url={https://ieeexplore.ieee.org/document/9815154}
}

License

The code of EmotiEffLib is released under the Apache-2.0 License. There is no limitation for both academic and commercial usage.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emotiefflib-1.1.1.tar.gz (34.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

emotiefflib-1.1.1-py3-none-any.whl (35.1 kB view details)

Uploaded Python 3

File details

Details for the file emotiefflib-1.1.1.tar.gz.

File metadata

  • Download URL: emotiefflib-1.1.1.tar.gz
  • Upload date:
  • Size: 34.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for emotiefflib-1.1.1.tar.gz
Algorithm Hash digest
SHA256 c775c1bde17108042855fa914a2e5e2d5aaa7f61520fd3c1b757fc39e0bde027
MD5 39bcffc644fbbb0a535e535120875a46
BLAKE2b-256 fe7af50f2e22cd82a49a09bb178ba12482a849c362265f0e3aa63330bd4dfba6

See more details on using hashes here.

File details

Details for the file emotiefflib-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: emotiefflib-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 35.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for emotiefflib-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ba44da2b3d6120375d76a1e7571f8b2234f4eab5109f05c1f34ad5d5aa8e6242
MD5 b75bb989dad550e8fb90e62932077ccf
BLAKE2b-256 5c17b8e3cd65ed401418e242138be69a6440e2ecce6ea5a5c9e3880dda2b3db5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page