Skip to content
Snippets Groups Projects
Commit a1ef5efc authored by Yannick DAYER's avatar Yannick DAYER
Browse files

[doc] Removed references to spoof.py

parent d131a79e
No related branches found
No related tags found
1 merge request!114Updating to the documentation
Pipeline #47889 failed
...@@ -23,7 +23,7 @@ To see the description of the command, you can type in the console: ...@@ -23,7 +23,7 @@ To see the description of the command, you can type in the console:
This script is explained in more detail in :ref:`bob.pad.base <bob.pad.base.vanilla_pad_intro>`. This script is explained in more detail in :ref:`bob.pad.base <bob.pad.base.vanilla_pad_intro>`.
Usually it is a good idea to have at least verbose level 2 (i.e., calling Usually, it is a good idea to have at least verbose level 2 (i.e., calling
``bob pad vanilla-pad --verbose --verbose``, or the short version ``bob pad vanilla-pad --verbose --verbose``, or the short version
``bob pad vanilla-pad -vv``). ``bob pad vanilla-pad -vv``).
...@@ -48,13 +48,12 @@ is available on the section :ref:`bob.pad.face.resources`. ...@@ -48,13 +48,12 @@ is available on the section :ref:`bob.pad.face.resources`.
You **cannot** run experiments just by executing the command line You **cannot** run experiments just by executing the command line
instructions described in this guide. You **need first** to procure yourself instructions described in this guide. You **need first** to procure yourself
the raw data files that correspond to *each* database used here in order to the raw data files that correspond to *each* database used here to correctly
correctly run experiments with those data. Biometric data is considered run experiments with those data. Biometric data is considered private and,
private data and, under EU regulations, cannot be distributed without a under EU regulations, cannot be distributed without a consent or license.
consent or license. You may consult our You may consult our :ref:`bob.pad.face.resources.databases` resources
:ref:`bob.pad.face.resources.databases` resources section for checking section for checking currently supported databases and accessing download
currently supported databases and accessing download links for the raw data links for the raw data files.
files.
Once the raw data files have been downloaded, unpack the databases carefully Once the raw data files have been downloaded, unpack the databases carefully
and take a note of the root directory where they have been unpacked. and take a note of the root directory where they have been unpacked.
...@@ -86,7 +85,7 @@ REPLAY-ATTACK (`replayattack`_) database. ...@@ -86,7 +85,7 @@ REPLAY-ATTACK (`replayattack`_) database.
The description of the database-related settings, which are used to run face PAD The description of the database-related settings, which are used to run face PAD
baselines on the Replay-Attack is given here baselines on the Replay-Attack is given here
:ref:`bob.pad.face.resources.databases.replay`. To understand the settings in :ref:`bob.pad.face.resources.databases.replay`. To understand the settings in
more details you can check the corresponding configuration file : more detail you can check the corresponding configuration file:
``bob/pad/face/config/replay_attack.py``. ``bob/pad/face/config/replay_attack.py``.
...@@ -105,7 +104,7 @@ protocol, execute the following: ...@@ -105,7 +104,7 @@ protocol, execute the following:
.. tip:: .. tip::
If you are at `idiap`_ you can use SGE grid to speed-up the calculations. If you are at `idiap`_ you can use the SGE grid to speed-up the calculations.
Simply add the ``--dask-client sge`` (or ``-l sge``) argument to the above Simply add the ``--dask-client sge`` (or ``-l sge``) argument to the above
command. For example: command. For example:
...@@ -132,7 +131,7 @@ following command: ...@@ -132,7 +131,7 @@ following command:
-o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf -o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf
The error rates for `replayattack`_ database are summarized in the Table below: The error rates for `replayattack`_ database are summarized in the table below:
+-------------------+----------+----------+ +-------------------+----------+----------+
| Protocol | EER,\% | HTER,\% | | Protocol | EER,\% | HTER,\% |
...@@ -179,7 +178,7 @@ following command: ...@@ -179,7 +178,7 @@ following command:
--criterion eer \ --criterion eer \
-o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf -o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf
The EER/HTER errors for `replayattack`_ database are summarized in the Table below: The EER/HTER errors for `replayattack`_ database are summarized in the table below:
+-------------------+----------+----------+ +-------------------+----------+----------+
| Protocol | EER,\% | HTER,\% | | Protocol | EER,\% | HTER,\% |
...@@ -201,7 +200,7 @@ Baselines on REPLAY-MOBILE database ...@@ -201,7 +200,7 @@ Baselines on REPLAY-MOBILE database
-------------------------------------- --------------------------------------
This section summarizes the results of baseline face PAD experiments on the `Replay-Mobile`_ database. This section summarizes the results of baseline face PAD experiments on the `Replay-Mobile`_ database.
The description of the database-related settings, which are used to run face PAD baselines on the Replay-Mobile is given here :ref:`bob.pad.face.resources.databases.replay_mobile`. To understand the settings in more details you can check the corresponding configuration file : ``bob/pad/face/config/replay_mobile.py``. The description of the database-related settings, which are used to run face PAD baselines on the Replay-Mobile is given here :ref:`bob.pad.face.resources.databases.replay_mobile`. To understand the settings in more detail you can check the corresponding configuration file : ``bob/pad/face/config/replay_mobile.py``.
LBP features of facial region + SVM classifier LBP features of facial region + SVM classifier
...@@ -237,7 +236,7 @@ following command: ...@@ -237,7 +236,7 @@ following command:
--criterion eer \ --criterion eer \
-o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf -o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf
The EER/HTER errors for the `Replay-Mobile`_ database are summarized in the Table below: The EER/HTER errors for the `Replay-Mobile`_ database are summarized in the table below:
+-------------------+----------+----------+ +-------------------+----------+----------+
| Protocol | EER,\% | HTER,\% | | Protocol | EER,\% | HTER,\% |
...@@ -285,7 +284,7 @@ following command: ...@@ -285,7 +284,7 @@ following command:
--criterion eer \ --criterion eer \
-o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf -o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf
The EER/HTER errors for the `Replay-Mobile`_ database are summarized in the Table below: The EER/HTER errors for the `Replay-Mobile`_ database are summarized in the table below:
+-------------------+----------+----------+ +-------------------+----------+----------+
| Protocol | EER,\% | HTER,\% | | Protocol | EER,\% | HTER,\% |
...@@ -335,7 +334,7 @@ following command: ...@@ -335,7 +334,7 @@ following command:
--criterion eer \ --criterion eer \
-o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf -o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf
The EER/HTER errors for the MIFS database are summarized in the Table below: The EER/HTER errors for the MIFS database are summarized in the table below:
+-------------------+----------+----------+ +-------------------+----------+----------+
| Protocol | EER,\% | HTER,\% | | Protocol | EER,\% | HTER,\% |
...@@ -369,7 +368,7 @@ following command: ...@@ -369,7 +368,7 @@ following command:
--criterion eer \ --criterion eer \
-o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf -o <PATH_TO_STORE_THE_RESULTS>/ROC.pdf
The EER/HTER errors for the MIFS database are summarized in the Table below: The EER/HTER errors for the MIFS database are summarized in the table below:
+-------------------+----------+----------+ +-------------------+----------+----------+
| Protocol | EER,\% | HTER,\% | | Protocol | EER,\% | HTER,\% |
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
Library for Facial Presentation Attack Detection (PAD) Library for Facial Presentation Attack Detection (PAD)
======================================================== ========================================================
The Facial Presentation Attack Detection Library is an open source tool consisting of a The Facial Presentation Attack Detection Library is an open-source tool consisting of a
series of plugins for bob.pad.base_, our open-source biometric recognition series of plugins for bob.pad.base_, our open-source biometric recognition
platform. As a result, it is fully extensible using bob.pad.base_ documented platform. As a result, it is fully extensible using bob.pad.base_ documented
types and techniques. Please refer to the manual of that package for a thorough types and techniques. Please refer to the manual of that package for a thorough
......
...@@ -5,17 +5,17 @@ ...@@ -5,17 +5,17 @@
Setting up Databases Setting up Databases
====================== ======================
In order to run face PAD algorithms using this package, you'll need to make To run face PAD algorithms using this package, you'll need to make sure to
sure to download the raw files corresponding to the databases you'd like to download the raw files corresponding to the databases you'd like to process.
process. The raw files are **not** distributed with Bob_ software as biometric The raw files are **not** distributed with Bob_ software as biometric data is,
data is, to most countries, considered sensible data that cannot be obtained to most countries, considered sensible data that cannot be obtained without
without explicit licensing from a data controller. You must visit the websites explicit licensing from a data controller. You must visit the websites below,
below, sign the license agreements and then download the data before trying out sign the license agreements and then download the data before trying out to run
to run the baselines. the baselines.
.. note:: .. note::
If you're at the Idiap Research Institute in Switzlerand, the datasets in If you're at the Idiap Research Institute in Switzerland, the datasets in
the baselines mentioned in this guide are already downloaded and the baselines mentioned in this guide are already downloaded and
pre-installed on our shared file system. You don't need to re-download pre-installed on our shared file system. You don't need to re-download
databases. databases.
......
...@@ -12,27 +12,28 @@ in ``bob.pad.face``. ...@@ -12,27 +12,28 @@ in ``bob.pad.face``.
.. warning:: .. warning::
Algorithms introduced in this section might be in the process of publishing. Therefore, it is not Algorithms introduced in this section might be in the process of publishing.
allowed to publish results introduced in this section without permission of the owner of the package. Therefore, it is not allowed to publish results introduced in this section
If you are planning to use the results from this section, please contact the owner of the package first. without the permission of the owner of the package.
If you are planning to use the results from this section, please contact the
owner of the package first.
Please check the ``setup.py`` for contact information. Please check the ``setup.py`` for contact information.
Running face PAD Experiments Running face PAD Experiments
------------------------------ ------------------------------
To run the PAD experiments, the ``spoof.py`` script located in ``bin`` directory is used. To run the PAD experiments, use the ``bob pad`` command.
To see the description of the script you can type in the console: To see the description of this command you can type in the console:
.. code-block:: sh .. code-block:: sh
$ spoof.py --help $ bob pad --help
This script is explained in more detail in :ref:`bob.pad.base.experiments`. This script is explained in more detail in :ref:`bob.pad.base.experiments`.
Usually it is a good idea to have at least verbose level 2 (i.e., calling Usually, it is a good idea to have at least verbose level 2 (i.e., calling
``spoof.py --verbose --verbose``, or the short version ``spoof.py ``bob pad --verbose --verbose``, or the short version ``bob pad -vv``).
-vv``).
.. note:: **Running in Parallel** .. note:: **Running in Parallel**
...@@ -40,48 +41,43 @@ Usually it is a good idea to have at least verbose level 2 (i.e., calling ...@@ -40,48 +41,43 @@ Usually it is a good idea to have at least verbose level 2 (i.e., calling
(multi-processing) configurations as explained in (multi-processing) configurations as explained in
:ref:`running_in_parallel`. :ref:`running_in_parallel`.
In short, to run in the Idiap SGE grid, you can simply add the ``--grid`` In short, to run in the Idiap SGE grid, you can simply add the
command line option, with grid configuration parameters. To run experiments in parallel on ``--dask-client sge`` command line option. To run experiments in parallel on
the local machine, simply add a ``--parallel <N>`` option, where ``<N>`` the local machine, simply add the ``--dask-client local-parallel`` option.
specifies the number of parallel jobs you want to execute.
Database setups and face PAD algorithms are encoded using Database setups and face PAD algorithms are encoded using
``bob.bio.base.configuration-files``, all stored inside the package root, in ``bob.bio.base.configuration-files``, all stored inside the package structure,
the directory ``bob/pad/face/config``. Documentation for each resource in the directory ``bob/pad/face/config``. Documentation for each resource
is available on the section :ref:`bob.pad.face.resources`. is available on the section :ref:`bob.pad.face.resources`.
.. warning:: .. warning::
You **cannot** run experiments just by executing the command line You **cannot** run experiments just by executing the command line
instructions described in this guide. You **need first** to procure yourself instructions described in this guide. You **need first** to procure yourself
the raw data files that correspond to *each* database used here in order to the raw data files that correspond to *each* database used here to correctly
correctly run experiments with those data. Biometric data is considered run experiments with those data. Biometric data is considered private and,
private date and, under EU regulations, cannot be distributed without a under EU regulations, cannot be distributed without a consent or license.
consent or license. You may consult our You may consult our :ref:`bob.pad.face.resources.databases` resources
:ref:`bob.pad.face.resources.databases` resources section for checking section for checking currently supported databases and accessing download
currently supported databases and accessing download links for the raw data links for the raw data files.
files.
Once the raw data files have been downloaded, particular attention should be Once the raw data files have been downloaded, particular attention should be
given to the directory locations of those. Unpack the databases carefully given to the directory locations of those. Unpack the databases carefully
and annotate the root directory where they have been unpacked. and take note of the root directory where they have been unpacked.
Then, carefully read the *Databases* section of Then, carefully read the *Databases* section of
:ref:`bob.pad.base.installation` on how to correctly setup the :ref:`bob.pad.base.installation` on how to correctly setup the
``~/.bob_bio_databases.txt`` file. ``~/.bob_bio_databases.txt`` file.
Use the following keywords on the left side of the assignment (see Use the following command with the appropriate database name (see
:ref:`bob.pad.face.resources.databases`): :ref:`bob.pad.face.resources.databases`):
.. code-block:: text .. code-block:: sh
[YOUR_REPLAY_ATTACK_DIRECTORY] = /complete/path/to/replayattack-database/ bob config set bob.db.<dbname> /path/to/the/db/folder
Notice it is rather important to use the strings as described above, Once this step is done, you can proceed with the execution of the experiment.
otherwise ``bob.pad.base`` will not be able to correctly load your images.
Once this step is done, you can proceed with the instructions below.
.. include:: links.rst .. include:: links.rst
......
...@@ -18,7 +18,8 @@ Databases ...@@ -18,7 +18,8 @@ Databases
------------ ------------
These configuration files/resources contain parameters of available databases. These configuration files/resources contain parameters of available databases.
The configuration files contain at least the following arguments of the ``spoof.py`` script: The configuration files contain at least the following arguments of the
``bob pad vanilla-pad`` command:
* ``database`` * ``database``
* ``protocol`` * ``protocol``
...@@ -57,13 +58,12 @@ MIFS Database ...@@ -57,13 +58,12 @@ MIFS Database
Available face PAD systems Available face PAD systems
------------------------------ ------------------------------
These configuration files/resources contain parameters of available face PAD systems/algorithms. These configuration files/resources contain parameters of available face PAD
The configuration files contain at least the following arguments of the ``spoof.py`` script: systems/algorithms.
The configuration files contain at least the following arguments of the
``bob pad vanilla-pad`` command:
* ``sub_directory`` * ``pipeline`` containing zero, one, or more Transformers and one Classifier
* ``preprocessor``
* ``extractor``
* ``algorithm``
.. _bob.pad.face.resources.face_pad.lbp_svm_replayattack: .. _bob.pad.face.resources.face_pad.lbp_svm_replayattack:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment