README.rst 3.65 KB
Newer Older
1 2 3 4 5
.. vim: set fileencoding=utf-8 :
.. Manuel Guenther <manuel.guenther@idiap.ch>
.. Fri Sep 19 12:51:09 CEST 2014

.. image:: http://img.shields.io/badge/docs-stable-yellow.png
Manuel Günther's avatar
Manuel Günther committed
6
   :target: http://pythonhosted.org/bob.bio.csu/index.html
7
.. image:: http://img.shields.io/badge/docs-latest-orange.png
Manuel Günther's avatar
Manuel Günther committed
8
   :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.bio.csu/master/index.html
9 10 11 12
.. image:: http://travis-ci.org/bioidiap/bob.bio.csu.svg?branch=v2.0.3
   :target: https://travis-ci.org/bioidiap/bob.bio.csu?branch=v2.0.3
.. image:: https://coveralls.io/repos/bioidiap/bob.bio.csu/badge.png?branch=v2.0.3
   :target: https://coveralls.io/r/bioidiap/bob.bio.csu?branch=v2.0.3
13
.. image:: https://img.shields.io/badge/github-master-0000c0.png
Manuel Günther's avatar
Manuel Günther committed
14 15 16 17 18
   :target: https://github.com/bioidiap/bob.bio.csu/tree/master
.. image:: http://img.shields.io/pypi/v/bob.bio.csu.png
   :target: https://pypi.python.org/pypi/bob.bio.csu
.. image:: http://img.shields.io/pypi/dm/bob.bio.csu.png
   :target: https://pypi.python.org/pypi/bob.bio.csu
19 20 21 22
.. image:: https://img.shields.io/badge/original-software-a000a0.png
   :target: http://www.cs.colostate.edu/facerec


Manuel Günther's avatar
Manuel Günther committed
23 24 25
================================================================
 bob.bio Wrapper classes for the CSU Face Recognition Resources
================================================================
26

Manuel Günther's avatar
Manuel Günther committed
27 28 29 30
This package is part of the ``bob.bio`` packages, which allow to run comparable and reproducible biometric recognition experiments on publicly available databases.

This package provides wrapper classes for the CSU face recognition resources, which can be downloaded from http://www.cs.colostate.edu/facerec.
Two algorithms are provided by the CSU toolkit (and also by this package): the local region PCA (LRPCA) and the LDA-IR (also known as CohortLDA).
31

Manuel Günther's avatar
Manuel Günther committed
32
For more information about the LRPCA and the LDA-IR algorithm, please refer to the documentation on http://www.cs.colostate.edu/facerec.
Manuel Günther's avatar
Manuel Günther committed
33
For further information about ``bob.bio``, please read `its Documentation <http://pythonhosted.org/bob.bio.base/index.html>`_.
34 35 36 37 38 39 40 41 42 43 44 45


Installation Instructions
-------------------------

The current package is just a set of wrapper classes for the CSU facerec2010 module, which is contained in the `CSU Face Recognition Resources <http://www.cs.colostate.edu/facerec>`_, where you need to download the Baseline 2011 Algorithms.
Please make sure that you have read installation instructions in the Documentation_ of this package on how to patch the original source code to work with our algorithms, before you try to go on woth this package.

.. note::
   Since the original CSU resources are not Python3 compatible, this package only supports Python2.
   For external dependencies of the CSU resources, please read their `README <http://www.cs.colostate.edu/facerec/algorithms/README.pdf>`__.

Manuel Günther's avatar
Manuel Günther committed
46
The ``bob.bio`` packages and parts of this package rely on Bob_, an open-source signal-processing and machine learning toolbox.
47 48 49 50 51 52
For Bob_ to be able to work properly, some dependent packages are required to be installed.
Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system.


Documentation
-------------
Manuel Günther's avatar
Manuel Günther committed
53
For further documentation on this package, please read the `Stable Version <http://pythonhosted.org/bob.bio.csu/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.bio.csu/master/index.html>`_ of the documentation.
54 55 56 57 58

For a list of tutorials on packages ob Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website.


.. _bob: https://www.idiap.ch/software/bob
Manuel Günther's avatar
Manuel Günther committed
59
.. _documentation: http://pythonhosted.org/bob.bio.csu/index.html