openface README

The project's README from github.com/cmusatyalab/openface. As one markdown file: README.md.

OpenFace • Build Status Release License Gitter

Free and open source face recognition with deep neural networks.



This research was supported by the National Science Foundation (NSF) under grant number CNS-1518865. Additional support was provided by the Intel Corporation, Google, Vodafone, NVIDIA, and the Conklin Kistler family fund. Any opinions, findings, conclusions or recommendations expressed in this material are those of the authors and should not be attributed to their employers or funding sources.

What's in this repository?

Citations

Please cite OpenFace in your publications if it helps your research. The following is a BibTeX and plaintext reference for our OpenFace tech report.

@techreport{amos2016openface,
  title={OpenFace: A general-purpose face recognition
    library with mobile applications},
  author={Amos, Brandon and Bartosz Ludwiczuk and Satyanarayanan, Mahadev},
  year={2016},
  institution={CMU-CS-16-118, CMU School of Computer Science},
}

B. Amos, B. Ludwiczuk, M. Satyanarayanan,
"Openface: A general-purpose face recognition library with mobile applications,"
CMU-CS-16-118, CMU School of Computer Science, Tech. Rep., 2016.

Licensing

Unless otherwise stated, the source code and trained Torch and Python model files are copyright Carnegie Mellon University and licensed under the Apache 2.0 License. Portions from the following third party sources have been modified and are included in this repository. These portions are noted in the source files and are copyright their respective authors with the licenses listed.

Project Modified License
Atcold/torch-TripletEmbedding No MIT
facebook/fbnn Yes BSD
dlib-models (68 face landmark detector) No CC0

openface (cmusatyalab/openface)

Searching Database…

15.4K ·GitHub
What is this?OpenFace is a free, open-source face recognition toolkit built on deep neural networks, developed by Carnegie Mellon University.
Is this a ready-made app or something I plug into my own code?It is mainly a Python library (the 'openface' package) backed by a Torch/Lua neural network, plus standalone demo scripts for comparison, classification and a real-time web demo rather than one polished application.
How do I try it out?Start with the scripts in demos/: 'compare.py' checks if two photos match, 'classifier.py' trains and runs a classifier, 'classifierwebcam.py' applies a trained classifier to a live webcam feed, and 'batch-represent' generates embeddings for a batch of images.
Do I need Torch and dlib set up before using it?Yes - the recognition network itself runs on Torch (Lua), face alignment reuses dlib's 68-point landmark detector, and a Docker image is provided so you do not have to assemble this stack by hand.
Who is this meant for?It's built for researchers and developers who want to experiment with deep-learning face recognition, verification, and clustering, not end users looking for a plug-and-play consumer app.
Can I train my own face recognition model instead of using the bundled one?Yes, the training/ directory contains scripts to train new OpenFace neural network models from scratch.
How is accuracy measured?The evaluation/ folder has scripts that benchmark the model on the LFW (Labeled Faces in the Wild) dataset.
Who funded this research?Development was backed by an NSF grant, with additional support from Intel, Google, Vodafone, and NVIDIA.
Do I need to cite OpenFace if I use it in my work?Yes, the README asks that publications using OpenFace cite the project's tech report, and it provides a ready-made BibTeX entry.
Size
24.1 MB
Stars
15.4K
Age
11y
Commits · 90 Days