From 467fcd8f9e02bd71ee024eae0d77dc2f17e76316 Mon Sep 17 00:00:00 2001
From: Manuel Gunther <siebenkopf@googlemail.com>
Date: Mon, 5 Jun 2017 14:45:13 -0600
Subject: [PATCH] Added citation recommendations
---
README.rst | 26 +++++++++++++++++++++++++-
doc/index.rst | 31 ++++++++++++++++++++++++++++++-
2 files changed, 55 insertions(+), 2 deletions(-)
diff --git a/README.rst b/README.rst
index 38a669bb..f11a2da3 100644
--- a/README.rst
+++ b/README.rst
@@ -26,12 +26,36 @@ Bob_. It provides tools to run comparable and reproducible biometric
recognition experiments on publicly available databases.
The `User Guide`_ provides installation and usage instructions.
+If you run biometric recognition experiments using the bob.bio framework, please cite at least one of the following in your scientific publication::
+ @inbook{guenther2016face,
+ chapter = {Face Recognition in Challenging Environments: An Experimental and Reproducible Research Survey},
+ author = {G\"unther, Manuel and El Shafey, Laurent and Marcel, S\'ebastien},
+ editor = {Bourlai, Thirimachos},
+ title = {Face Recognition Across the Imaging Spectrum},
+ edition = {1},
+ year = {2016},
+ month = feb,
+ publisher = {Springer}
+ }
+
+ @inproceedings{guenther2012facereclib,
+ title = {An Open Source Framework for Standardized Comparisons of Face Recognition Algorithms},
+ author = {G\"unther, Manuel and Wallace, Roy and Marcel, S\'ebastien},
+ editor = {Fusiello, Andrea and Murino, Vittorio and Cucchiara, Rita},
+ booktitle = {European Conference on Computer Vision (ECCV) Workshops and Demonstrations},
+ series = {Lecture Notes in Computer Science},
+ volume = {7585},
+ year = {2012},
+ month = oct,
+ pages = {547-556},
+ publisher = {Springer},
+ }
Installation
------------
-Complete Bob's `installation`_ instructions. Then, to install this pacakge,
+Complete Bob's `installation`_ instructions. Then, to install this package,
run::
$ conda install bob.bio.base
diff --git a/doc/index.rst b/doc/index.rst
index 19d064b0..2d305108 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -17,7 +17,7 @@ To design a biometric recognition experiment, you must choose:
* A biometric matching algorithm,
* An evaluation method to make sense of the matching scores.
-The ``bob.bio`` packages contain several implementations of each of the above steps, so you can either choose from the existing methods or use your own.
+The ``bob.bio`` packages contain several implementations of each of the above steps, so you can either choose from the existing methods or use your own.
.. note::
The ``bob.bio`` packages are derived from the former `FaceRecLib <http://pypi.python.org/pypi/facereclib>`__, which is herewith outdated.
@@ -36,6 +36,35 @@ Here is a growing list of derived packages:
* `bob.bio.csu <http://pypi.python.org/pypi/bob.bio.csu>`__ for wrapper classes of the `CSU Face Recognition Resources <http://www.cs.colostate.edu/facerec>`__ (see `Installation Instructions <http://pythonhosted.org/bob.bio.csu/installation.html>`__ of ``bob.bio.csu``).
+If you run biometric recognition experiments using the bob.bio framework, please cite at least one of the following in your scientific publication:
+
+.. code-block:: tex
+
+ @inbook{guenther2016face,
+ chapter = {Face Recognition in Challenging Environments: An Experimental and Reproducible Research Survey},
+ author = {G\"unther, Manuel and El Shafey, Laurent and Marcel, S\'ebastien},
+ editor = {Bourlai, Thirimachos},
+ title = {Face Recognition Across the Imaging Spectrum},
+ edition = {1},
+ year = {2016},
+ month = feb,
+ publisher = {Springer}
+ }
+
+ @inproceedings{guenther2012facereclib,
+ title = {An Open Source Framework for Standardized Comparisons of Face Recognition Algorithms},
+ author = {G\"unther, Manuel and Wallace, Roy and Marcel, S\'ebastien},
+ editor = {Fusiello, Andrea and Murino, Vittorio and Cucchiara, Rita},
+ booktitle = {European Conference on Computer Vision (ECCV) Workshops and Demonstrations},
+ series = {Lecture Notes in Computer Science},
+ volume = {7585},
+ year = {2012},
+ month = oct,
+ pages = {547-556},
+ publisher = {Springer},
+ }
+
+
===========
Users Guide
===========
--
GitLab