diff --git a/doc/baselines.rst b/doc/baselines.rst
index 366a4ce5d84f74aed7771bfb075a5945a07bbc74..b2a60b9f4f9b9a6438bdbfe02b2044033cf83d35 100644
--- a/doc/baselines.rst
+++ b/doc/baselines.rst
@@ -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>`.
-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 -vv``).
@@ -48,13 +48,12 @@ is available on the section :ref:`bob.pad.face.resources`.
You **cannot** run experiments just by executing the command line
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
- correctly run experiments with those data. Biometric data is considered
- private data and, under EU regulations, cannot be distributed without a
- consent or license. You may consult our
- :ref:`bob.pad.face.resources.databases` resources section for checking
- currently supported databases and accessing download links for the raw data
- files.
+ the raw data files that correspond to *each* database used here to correctly
+ run experiments with those data. Biometric data is considered private and,
+ under EU regulations, cannot be distributed without a consent or license.
+ You may consult our :ref:`bob.pad.face.resources.databases` resources
+ section for checking currently supported databases and accessing download
+ links for the raw data files.
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.
@@ -86,7 +85,7 @@ REPLAY-ATTACK (`replayattack`_) database.
The description of the database-related settings, which are used to run face PAD
baselines on the Replay-Attack is given here
: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``.
@@ -105,7 +104,7 @@ protocol, execute the following:
.. 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
command. For example:
@@ -132,7 +131,7 @@ following command:
-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,\% |
@@ -179,7 +178,7 @@ following command:
--criterion eer \
-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,\% |
@@ -201,7 +200,7 @@ Baselines on 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
@@ -237,7 +236,7 @@ following command:
--criterion eer \
-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,\% |
@@ -285,7 +284,7 @@ following command:
--criterion eer \
-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,\% |
@@ -335,7 +334,7 @@ following command:
--criterion eer \
-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,\% |
@@ -369,7 +368,7 @@ following command:
--criterion eer \
-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,\% |
diff --git a/doc/index.rst b/doc/index.rst
index c9355ac8776b33d7d603cad9baa4877793ec9993..ba3762b8a171e013731da184bd44a6b84701d709 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -6,7 +6,7 @@
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
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
diff --git a/doc/installation.rst b/doc/installation.rst
index d1a91ddfa8922cfb275f6e7db2949fcb0a7cb121..6c58ee2b689d36b628499440c4b701849899ed8e 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -5,17 +5,17 @@
Setting up Databases
======================
-In order to run face PAD algorithms using this package, you'll need to make
-sure to download the raw files corresponding to the databases you'd like to
-process. The raw files are **not** distributed with Bob_ software as biometric
-data is, to most countries, considered sensible data that cannot be obtained
-without explicit licensing from a data controller. You must visit the websites
-below, sign the license agreements and then download the data before trying out
-to run the baselines.
+To run face PAD algorithms using this package, you'll need to make sure to
+download the raw files corresponding to the databases you'd like to process.
+The raw files are **not** distributed with Bob_ software as biometric data is,
+to most countries, considered sensible data that cannot be obtained without
+explicit licensing from a data controller. You must visit the websites below,
+sign the license agreements and then download the data before trying out to run
+the baselines.
.. 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
pre-installed on our shared file system. You don't need to re-download
databases.
diff --git a/doc/other_pad_algorithms.rst b/doc/other_pad_algorithms.rst
index a32ca6010133bdbf99b7c217549e14169ee1c595..a23f4339a2859f5eb9d20d0bef6144a357801d58 100644
--- a/doc/other_pad_algorithms.rst
+++ b/doc/other_pad_algorithms.rst
@@ -12,27 +12,28 @@ in ``bob.pad.face``.
.. warning::
- Algorithms introduced in this section might be in the process of publishing. Therefore, it is not
- allowed to publish results introduced in this section without 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.
+ Algorithms introduced in this section might be in the process of publishing.
+ Therefore, it is not allowed to publish results introduced in this section
+ 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.
Running face PAD Experiments
------------------------------
-To run the PAD experiments, the ``spoof.py`` script located in ``bin`` directory is used.
-To see the description of the script you can type in the console:
+To run the PAD experiments, use the ``bob pad`` command.
+To see the description of this command you can type in the console:
.. code-block:: sh
- $ spoof.py --help
+ $ bob pad --help
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
-``spoof.py --verbose --verbose``, or the short version ``spoof.py
--vv``).
+Usually, it is a good idea to have at least verbose level 2 (i.e., calling
+``bob pad --verbose --verbose``, or the short version ``bob pad -vv``).
.. note:: **Running in Parallel**
@@ -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
:ref:`running_in_parallel`.
- In short, to run in the Idiap SGE grid, you can simply add the ``--grid``
- command line option, with grid configuration parameters. To run experiments in parallel on
- the local machine, simply add a ``--parallel <N>`` option, where ``<N>``
- specifies the number of parallel jobs you want to execute.
+ In short, to run in the Idiap SGE grid, you can simply add the
+ ``--dask-client sge`` command line option. To run experiments in parallel on
+ the local machine, simply add the ``--dask-client local-parallel`` option.
Database setups and face PAD algorithms are encoded using
-``bob.bio.base.configuration-files``, all stored inside the package root, in
-the directory ``bob/pad/face/config``. Documentation for each resource
+``bob.bio.base.configuration-files``, all stored inside the package structure,
+in the directory ``bob/pad/face/config``. Documentation for each resource
is available on the section :ref:`bob.pad.face.resources`.
.. warning::
You **cannot** run experiments just by executing the command line
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
- correctly run experiments with those data. Biometric data is considered
- private date and, under EU regulations, cannot be distributed without a
- consent or license. You may consult our
- :ref:`bob.pad.face.resources.databases` resources section for checking
- currently supported databases and accessing download links for the raw data
- files.
+ the raw data files that correspond to *each* database used here to correctly
+ run experiments with those data. Biometric data is considered private and,
+ under EU regulations, cannot be distributed without a consent or license.
+ You may consult our :ref:`bob.pad.face.resources.databases` resources
+ section for checking currently supported databases and accessing download
+ links for the raw data files.
Once the raw data files have been downloaded, particular attention should be
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
:ref:`bob.pad.base.installation` on how to correctly setup the
``~/.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`):
- .. 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,
- 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.
+ Once this step is done, you can proceed with the execution of the experiment.
.. include:: links.rst
diff --git a/doc/resources.rst b/doc/resources.rst
index 766b3cf3768dbf1f93f04fa3eab7b998dddb7d4e..897926f75c785226df0758e0ca2c082e47c4c288 100644
--- a/doc/resources.rst
+++ b/doc/resources.rst
@@ -18,7 +18,8 @@ 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``
* ``protocol``
@@ -57,13 +58,12 @@ MIFS Database
Available face PAD systems
------------------------------
-These configuration files/resources contain parameters of available face PAD systems/algorithms.
-The configuration files contain at least the following arguments of the ``spoof.py`` script:
+These configuration files/resources contain parameters of available face PAD
+systems/algorithms.
+The configuration files contain at least the following arguments of the
+``bob pad vanilla-pad`` command:
- * ``sub_directory``
- * ``preprocessor``
- * ``extractor``
- * ``algorithm``
+ * ``pipeline`` containing zero, one, or more Transformers and one Classifier
.. _bob.pad.face.resources.face_pad.lbp_svm_replayattack: