README.rst 2.63 KB
Newer Older
1
.. vim: set fileencoding=utf-8 :
André Anjos's avatar
André Anjos committed
2
.. Tue 16 Aug 15:00:20 CEST 2016
3

4
.. image:: https://img.shields.io/badge/docs-available-orange.svg
Jaden's avatar
Jaden committed
5
   :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/master/index.html
6 7 8 9
.. image:: https://gitlab.idiap.ch/bob/bob.bio.base/badges/master/pipeline.svg
   :target: https://gitlab.idiap.ch/bob/bob.bio.base/commits/master
.. image:: https://gitlab.idiap.ch/bob/bob.bio.base/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/bob/bob.bio.base/commits/master
André Anjos's avatar
André Anjos committed
10 11
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/bob/bob.bio.base
12

13

André Anjos's avatar
André Anjos committed
14 15 16
================================================
 Tools to run biometric recognition experiments
================================================
Manuel Günther's avatar
Manuel Günther committed
17

André Anjos's avatar
André Anjos committed
18 19 20
This package is part of the signal-processing and machine learning toolbox
Bob_. It provides tools to run comparable and reproducible biometric
recognition experiments on publicly available databases.
21

André Anjos's avatar
André Anjos committed
22
The `User Guide`_ provides installation and usage instructions.
23
If you run biometric recognition experiments using the bob.bio framework, please cite at least one of the following in your scientific publication::
24

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
  @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},
  }
48

André Anjos's avatar
André Anjos committed
49 50
Installation
------------
51

52
Complete Bob's `installation`_ instructions. Then, to install this package,
53
run::
Elie KHOURY's avatar
Elie KHOURY committed
54

55
  $ conda install bob.bio.base
56

Elie KHOURY's avatar
Elie KHOURY committed
57

André Anjos's avatar
André Anjos committed
58 59
Contact
-------
60

André Anjos's avatar
André Anjos committed
61 62
For questions or reporting issues to this software package, contact our
development `mailing list`_.
63

64

André Anjos's avatar
André Anjos committed
65
.. Place your references here:
66
.. _bob: https://www.idiap.ch/software/bob
67
.. _installation: https://www.idiap.ch/software/bob/install
68
.. _mailing list: https://www.idiap.ch/software/bob/discuss
69
.. _user guide: https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/stable/index.html