installation.rst 3.11 KB
Newer Older
1 2 3 4 5 6 7
.. vim: set fileencoding=utf-8 :
.. author: Manuel Günther <manuel.guenther@idiap.ch>
.. author: Pavel Korshunov <pavel.korshunov@idiap.ch>
.. date: Wed Apr 27 14:58:21 CEST 2016

.. _bob.pad.base.installation:

8

9 10 11
===========================
 Installation Instructions
===========================
12

13
As noted before, this package is part of the ``bob.pad`` packages, which in
Yannick DAYER's avatar
Yannick DAYER committed
14
turn are part of the signal processing and machine learning toolbox Bob_. To
15
install Bob_, please read the `Installation Instructions <bobinstall_>`_.
16

Yannick DAYER's avatar
Yannick DAYER committed
17
Then, to install the ``bob.pad`` packages and in turn, maybe the database
18
packages that you want to use, use conda_ to install them:
19

20
.. code-block:: sh
21

22 23 24
    $ conda search bob.pad # searching
    $ conda search bob.db  # searching
    $ conda install bob.pad.base bob.pad.<padname> bob.db.<dbname>
25

26 27
where you would replace ``<padname>`` and ``<dbname>`` with the name of
packages that you want to use.
28

29 30
An example installation
-----------------------
31

32 33 34 35 36 37 38
For example, to run a speech presentation attack detection experiments,
you need preprocessor, extractor, classifier, and
a database. Preprocessors and extractors can be reused from ``bob.bio`` packages, while classifier is normally
provided in ``bob.pad``. Hence for speech PAD, you can take
the :py:class:`bob.bio.spear.preprocessor.Energy_2Gauss` and the
:py:class:`bob.bio.spear.extractor.Cepstral` feature extractor defined in
:ref:`bob.bio.spear <bob.bio.spear>`, and the
39 40
:py:class:`bob.pad.base.algorithm.OneClassGMM` algorithm defined in
:ref:`bob.pad.base <bob.pad.base>`, using voicePA database (contains speech presentation attacks)
41 42
interface defined in :ref:`bob.db.voicepa <bob.db.voicepa>`. Running the
command line below will install all the required packages:
43

44
.. code-block:: sh
45

46
    $ conda activate <bob_conda_environment>
47 48 49 50 51 52
    $ conda install bob.bio.base \
                    bob.bio.spear \
                    bob.pad.base \
                    bob.pad.voice \
                    bob.db.voicepa \
                    gridtk
53 54

Databases
55
---------
56 57 58

With ``bob.pad`` you will run biometric recognition experiments using databases that contain presentation attacks.
Though the PAD protocols are implemented in ``bob.pad``, the original data are **not included**.
Yannick DAYER's avatar
Yannick DAYER committed
59
To download the original data of the databases, please refer to the corresponding Web-pages.
60 61
For a list of supported databases including their download URLs,
please refer to the `spoofing_databases <https://gitlab.idiap.ch/bob/bob/wikis/Packages>`_.
62 63

After downloading the original data for the databases, you will need to tell ``bob.pad``, where these databases can be found.
64
For this purpose, a command exist to define your directories:
65

66
.. code-block:: sh
67

68
   $ bob config set bob.db.<dbname> /path/to/the/db/data/folder
69 70


71
Please use ``resources.py -t database`` for a list of known databases, where you can see the default entries for all databases that you haven't updated, and the corrected paths for those you have.
72 73 74


.. note::
75
   If you have installed only ``bob.pad.base``, there is no database listed -- as all databases are included in other extension packages, such as ``bob.pad.voice``.
76 77 78


.. include:: links.rst