Go to file

Brandon Amos 3ba7574e4d Add test for SVM classifier training.		2016-01-11 12:00:22 -05:00
api-docs	Fix flake8 warnings.	2016-01-07 18:43:25 -05:00
batch-represent	Fix luacheck warning.	2016-01-11 08:47:34 -05:00
demos	Web Demo: Use outer eyes and nose.	2016-01-11 10:31:38 -05:00
docs	Code Citation: Add @melgor.	2016-01-11 11:03:11 -05:00
evaluation	lfw: Output accuracy.	2016-01-11 08:11:37 -05:00
images	Update code to nn4.v2 for #55 .	2016-01-07 18:28:11 -05:00
models	DNN Models: Add parameters as comment and use opt.embSize	2016-01-08 11:18:30 -05:00
openface	Update code to nn4.v2 for #55 .	2016-01-07 18:28:11 -05:00
training	Fix luacheck warning in sanitize.	2016-01-11 07:48:01 -05:00
util	Update code to nn4.v2 for #55 .	2016-01-07 18:28:11 -05:00
.gitignore	Initial commit of Sphinx API docs.	2015-12-24 13:23:45 -05:00
.gitmodules	Add torch-TripletEmbedding submodule.	2015-09-18 16:57:25 -04:00
.travis.yml	Add test for SVM classifier training.	2016-01-11 12:00:22 -05:00
Dockerfile	Dockerfile: Install nose from apt-get.	2016-01-11 11:20:44 -05:00
LICENSE	Add LICENSE.	2015-09-23 19:28:51 -04:00
README.md	Code Citation: Add @melgor.	2016-01-11 11:03:11 -05:00
cloc.sh	Update cloc.sh	2015-10-13 08:03:08 -04:00
mkdocs.yml	docs: Update title.	2016-01-07 19:12:22 -05:00
requirements.txt	Requirements: Add ranges.	2016-01-11 11:20:44 -05:00
setup.py	Refactor Python interface.	2015-12-29 19:57:29 -05:00
test.py	Add test for SVM classifier training.	2016-01-11 12:00:22 -05:00

README.md

OpenFace

Free and open source face recognition with deep neural networks.

[ ![Build Status] travis-image ] travis [ ![Release] release-image ] releases [ license-image ] license [ gitter-image ] gitter

Website: http://cmusatyalab.github.io/openface/
API Documentation
Join the cmu-openface group or the gitter chat for discussions and installation issues.
Development discussions and bugs reports are on the issue tracker.

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?

batch-represent: Generate representations from a batch of images, stored in a directory by names.
demos/web: Real-time web demo.
demos/compare.py: Demo to compare two images.
demos/vis-outputs.lua: Demo to visualize the network's outputs.
demos/classifier.py: Demo to train and use classifiers.
evaluation: LFW accuracy evaluation scripts.
openface: Python library code.
models: Model directory for openface and 3rd party libraries.
training: Scripts to train new OpenFace models.
util: Utility scripts.

Citations

The following is a BibTeX and plaintext reference for the OpenFace GitHub repository. The reference may change in the future. The BibTeX entry requires the url LaTeX package.

@misc{amos2016openface,
    title        = {{OpenFace: Face Recognition with Deep Neural Networks}},
    author       = {Amos, Brandon and Ludwiczuk, Bartosz and Harkes, Jan and
                    Pillai, Padmanabhan and Elgazzar, Khalid and Satyanarayanan, Mahadev},
    howpublished = {\url{http://github.com/cmusatyalab/openface}},
    note         = {Accessed: 2016-01-11}
}

Brandon Amos, Bartosz Ludwiczuk, Jan Harkes, Padmanabhan Pillai,
Khalid Elgazzar, and Mahadev Satyanarayanan.
OpenFace: Face Recognition with Deep Neural Networks.
http://github.com/cmusatyalab/openface.
Accessed: 2016-01-11

Licensing

The source code and trained models nn4.v*.t7 and celeb-classifier.nn4.v*.t7 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