README.rst 2.93 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:: http://img.shields.io/badge/docs-stable-yellow.svg
5
   :target: http://pythonhosted.org/bob.bio.base/index.html
6
.. image:: http://img.shields.io/badge/docs-latest-orange.svg
7
   :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob.bio.base/master/index.html
8
9
10
11
.. image:: https://gitlab.idiap.ch/bob/bob.bio.base/badges/master/build.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
12
13
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/bob/bob.bio.base
14
.. image:: http://img.shields.io/pypi/v/bob.bio.base.svg
15
   :target: https://pypi.python.org/pypi/bob.bio.base
16
.. image:: http://img.shields.io/pypi/dm/bob.bio.base.svg
17
   :target: https://pypi.python.org/pypi/bob.bio.base
18

19

André Anjos's avatar
André Anjos committed
20
21
22
================================================
 Tools to run biometric recognition experiments
================================================
Manuel Günther's avatar
Manuel Günther committed
23

André Anjos's avatar
André Anjos committed
24
25
26
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.
27

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

31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
  @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},
  }
54

André Anjos's avatar
André Anjos committed
55
56
Installation
------------
57

58
Complete Bob's `installation`_ instructions. Then, to install this package,
59
run::
Elie KHOURY's avatar
Elie KHOURY committed
60

61
  $ conda install bob.bio.base
62

Elie KHOURY's avatar
Elie KHOURY committed
63

André Anjos's avatar
André Anjos committed
64
65
Contact
-------
66

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

70

André Anjos's avatar
André Anjos committed
71
.. Place your references here:
72
.. _bob: https://www.idiap.ch/software/bob
73
.. _installation: https://www.idiap.ch/software/bob/install
74
.. _mailing list: https://www.idiap.ch/software/bob/discuss
André Anjos's avatar
André Anjos committed
75
.. _user guide: http://pythonhosted.org/bob.bio.base