Face verification using Bob
===========================

.. note::
  If you are reading this page through our GitHub portal and not through PyPI, note the development tip of the package may not be stable or become unstable in a matter of moments.

  Go to http://pypi.python.org/pypi/xbob.example.faceverify to download the latest stable version of this package.

Overview
--------

This example demonstrates how to use Bob to build different face verification systems.
It includes examples with three different complexities:

* A simple eigenface based example
* An example using Gabor jets in a grid graph
* An example building an UBM/GMM model on top of DCT blocks.

Requirements
------------

To use this example, you will require Bob in version of at least 1.2.0. and the AT&T database.

The AT&T database
.................
The AT&T image database is quite small, but sufficient to show how the face verification methods work.
Still, the results may not be meaningful.
One good thing about the AT&T database is that it is freely available.
You can download it from http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html.

Bob
...
If you do not have a Bob version yet, or your Bob version is too old, you can get a new one from http://www.idiap.ch/software/bob.

If your Bob version is not installed globally or not in the default path, you have to edit the *buildout.cfg* file in the root directory of this package.
In the ``[buildout]`` section, please add a line ``prefixes = <BOB_INSTALL_DIRECTORY>``, where ``<BOB_INSTALL_DIRECTORY>`` points to the root directory of your local Bob installation.

.. note::
  If you are at Idiap, Bob is installed globally, so there is no need to specify the ``prefixes``, unless you want to use another version of it.



Download
--------

Finally, to download this package, you can extract the .zip file from the link below, or you open a shell in a directory of your choice and call::

  $ wget https://pypi.python.org/packages/source/b/xbob.example.faceverify/xbob.example.faceverify-<version>.zip
  $ unzip xbob.example.faceverify-<version>.zip
  $ cd xbob.example.faceverify-<version>

where <version> should be replaced with a (the current) version of this package, or you can clone our git repository::

  $ git clone https://github.com/bioidiap/xbob.example.faceverify.git
  $ cd xbob.example.faceverify

Afterwards, please call::

  $ python bootstrap.py
  $ ./bin/buildout

to generate the scripts that, amongst others, will run the face verification algorithms. Please verify your installation by running the test cases. For more details, please refer to the documentation, which you might create and open yourself by::

  $ ./bin/sphinx-build doc sphinx
  $ firefox sphinx/index.html

(or use any other browser of your choice).

If you have questions to or problems with this package, please send a request to bob-devel@googlegroups.com, or file a bug under https://github.com/bioidiap/xbob.example.faceverify/issues.

