diff --git a/README.md b/README.md index 64dbf09..1a932bb 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # OpenFace +*Free and open source face recognition with +deep neural networks.* + [ ![Build Status] [travis-image] ] [travis] [ ![Release] [release-image] ] [releases] [ ![License] [license-image] ] [license] -[ ![DOI] [doi-image] ] [doi] [ ![Gitter] [gitter-image] ] [gitter] [travis-image]: https://travis-ci.org/cmusatyalab/openface.png?branch=master @@ -15,9 +17,6 @@ [license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat [license]: LICENSE -[doi-image]: https://zenodo.org/badge/doi/10.5281/zenodo.32148.svg -[doi]: http://dx.doi.org/10.5281/zenodo.32148 - [gitter-image]: https://badges.gitter.im/Join%20Chat.svg [gitter]: https://gitter.im/cmusatyalab/openface @@ -32,6 +31,29 @@ + Development discussions and bugs reports are on the [issue tracker](https://github.com/cmusatyalab/openface/issues). +# Citations + +The following is a [BibTeX](http://www.bibtex.org/) +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 diff --git a/docs/index.md b/docs/index.md index d9991fe..661f1d5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,13 +2,14 @@
*Free and open source face recognition with -Google's FaceNet deep neural network.* +deep neural networks.*
--- -OpenFace is a Python and [Torch](http://torch.ch) implementation of the CVPR -2015 paper +OpenFace is a Python and [Torch](http://torch.ch) implementation of +face recognition with deep neural networks and is based on +the CVPR 2015 paper [FaceNet: A Unified Embedding for Face Recognition and Clustering](http://www.cv-foundation.org/openaccess/content_cvpr_2015/app/1A_089.pdf) by Florian Schroff, Dmitry Kalenichenko, and James Philbin at Google. Torch allows the network to be executed on a CPU or with CUDA. @@ -100,20 +101,25 @@ image of Sylvestor Stallone from the publicly available # Citations -[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.32041.svg)](http://dx.doi.org/10.5281/zenodo.32041) - -Please cite this repository if you use this in academic works. - +The following is a [BibTeX](http://www.bibtex.org/) +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}, - title = {OpenFace 0.1.1: Face recognition with Google's FaceNet deep neural network}, - month = oct, - year = 2015, - doi = {10.5281/zenodo.32148}, - url = {http://dx.doi.org/10.5281/zenodo.32148} + 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. ``` # Acknowledgements