installation.rst

Installation Instructions

As noted before, this package is part of the bob.bio packages, which in turn are part of the signal-processing and machine learning toolbox Bob_. To install Bob_, please read the `Installation Instructions <bobinstall_>`_.

Note

Running Bob_ under MS Windows in not yet supported. However, we found that running Bob_ in a virtual Unix environment such as the one provided by VirtualBox_ is a good alternative.

Then, to install the bob.bio packages and in turn maybe the database packages that you want to use, use conda_ to install them:

$ conda search bob.bio  # searching
$ conda search bob.db  # searching
$ conda install bob.bio.base bob.bio.<bioname> bob.db.<dbname>

where you would replace <bioname> and <dbname> with the name of packages that you want to use.

An example installation

For example, you might want to run a video face recognition experiments using the :py:class:`bob.bio.face.preprocessor.FaceDetect` and the :py:class:`bob.bio.face.extractor.DCTBlocks` feature extractor defined in :ref:`bob.bio.face <bob.bio.face>`, the :py:class:`bob.bio.gmm.algorithm.IVector` algorithm defined in :ref:`bob.bio.gmm <bob.bio.gmm>` and the video extensions defined in :ref:`bob.bio.video <bob.bio.video>`, using the YouTube faces database interface defined in :ref:`bob.db.youtube <bob.db.youtube>`. Running the command line below will install all the required packages:

$ source activate <bob_conda_environment>
$ conda install bob.bio.base \
                bob.bio.face \
                bob.bio.gmm \
                bob.bio.video \
                bob.db.youtube \
                gridtk

Databases

With bob.bio you will run biometric recognition experiments using some default biometric recognition databases. Though the verification protocols are implemented in bob.bio, the original data are not included. To download the original data of the databases, please refer to the according Web-pages. For a list of supported databases including their download URLs, please refer to the `verification_databases <packages_>`_.

After downloading the original data for the databases, you will need to tell bob.bio, where these databases can be found. For this purpose, we have decided to implement a special file, where you can set your directories. By default, this file is located in ~/.bob_bio_databases.txt, and it contains several lines, each line looking somewhat like:

[YOUR_ATNT_DIRECTORY] = /path/to/your/directory

Note

If this file does not exist, feel free to create and populate it yourself.

Please use databases.py for a list of known databases, where you can see the raw [YOUR_DATABASE_PATH] entries for all databases that you haven't updated, and the corrected paths for those you have.

Note

If you have installed only bob.bio.base, there is no database listed -- as all databases are included in other packages, such as :ref:`bob.bio.face <bob.bio.face>` or :ref:`bob.bio.spear <bob.bio.spear>`.

Test your Installation