Go to file

Brandon Amos 4883f106d1 API Docs: Name		2015-12-24 13:48:16 -05:00
api-docs	API Docs: Name	2015-12-24 13:48:16 -05:00
batch-represent	batch-represent: Set the default tensor type.	2015-11-09 11:12:10 -05:00
demos	flake8 improvements.	2015-12-24 11:45:00 -05:00
docs	Convert back to BGR for OpenCV write.	2015-12-24 11:07:19 -05:00
evaluation	flake8 improvements.	2015-12-24 11:45:00 -05:00
images	Update LFW results with changes from #50 .	2015-12-10 21:04:00 -05:00
models	nn4: Add LRN and remove 5x5 convolutions for #55 .	2015-12-20 22:29:55 -05:00
openface	flake8 improvements.	2015-12-24 11:45:00 -05:00
training	flake8 improvements.	2015-12-24 11:45:00 -05:00
util	flake8 improvements.	2015-12-24 11:45:00 -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	Travis: Move docker commands.	2015-12-24 11:45:41 -05:00
Dockerfile	Dockerfile: Make the default command start the web demo.	2015-12-23 18:42:40 -05:00
LICENSE	Add LICENSE.	2015-09-23 19:28:51 -04:00
README.md	Move repo contents from docs to README.	2015-12-05 09:09:02 -05:00
cloc.sh	Update cloc.sh	2015-10-13 08:03:08 -04:00
mkdocs.yml	Docs: Initial commit of FAQ.	2015-12-06 16:20:25 -05:00
requirements.txt	Requirements: Add nose.	2015-12-22 23:11:26 -05:00
setup.py	setup.py: Correct url.	2015-12-22 20:30:49 -05:00
test.py	flake8 improvements.	2015-12-24 11:45:00 -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/
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{amos2015openface,
    title        = {{OpenFace: Face Recognition with Deep Neural Networks}},
    author       = {Amos, Brandon and Harkes, Jan and Pillai, Padmanabhan and Elgazzar, Khalid and Satyanarayanan, Mahadev},
    howpublished = {\url{http://github.com/cmusatyalab/openface}},
    note         = {Accessed: 2015-11-11}
}

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

Licensing

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