From 0c9964c478ab9ec1fa740703ca45ae893cef28c0 Mon Sep 17 00:00:00 2001
From: Amir MOHAMMADI <amir.mohammadi@idiap.ch>
Date: Fri, 3 Jun 2022 17:22:40 +0200
Subject: [PATCH] Fix docs
---
bob/pad/face/config/oulunpu.py | 3 --
bob/pad/face/config/replay_attack.py | 2 --
bob/pad/face/config/swan.py | 2 --
doc/baselines.rst | 46 +++++++++++++++-------------
doc/resources.rst | 13 +++++++-
5 files changed, 36 insertions(+), 30 deletions(-)
diff --git a/bob/pad/face/config/oulunpu.py b/bob/pad/face/config/oulunpu.py
index 69bedd1f..d26e3312 100644
--- a/bob/pad/face/config/oulunpu.py
+++ b/bob/pad/face/config/oulunpu.py
@@ -16,9 +16,6 @@ If you use this database, please cite the following publication::
journal = {IEEE International Conference on Automatic Face and Gesture Recognition},
year = {2017},
}
-
-
-.. include:: links.rst
"""
from bob.pad.face.database import OulunpuPadDatabase
diff --git a/bob/pad/face/config/replay_attack.py b/bob/pad/face/config/replay_attack.py
index 13212ed7..1c22f9a0 100644
--- a/bob/pad/face/config/replay_attack.py
+++ b/bob/pad/face/config/replay_attack.py
@@ -10,8 +10,6 @@ link. After downloading, you can tell the bob library where the files are
located using::
$ bob config set bob.db.replayattack.directory /path/to/replayattack/directory
-
-.. include:: links.rst
"""
from bob.pad.face.database import ReplayAttackPadDatabase
diff --git a/bob/pad/face/config/swan.py b/bob/pad/face/config/swan.py
index 5f1cad9f..0e1c3f17 100644
--- a/bob/pad/face/config/swan.py
+++ b/bob/pad/face/config/swan.py
@@ -24,8 +24,6 @@ evaluation. All the random splits are done 10 times to created 10 different
protocols. The PAD protocols contain only one type of attacks. For convenience,
PA_F and PA_V protocols are created for face and voice, respectively which
contain all the attacks.
-
-.. include:: links.rst
"""
from bob.pad.face.database import SwanPadDatabase
diff --git a/doc/baselines.rst b/doc/baselines.rst
index 5c0ae8be..b2246b0a 100644
--- a/doc/baselines.rst
+++ b/doc/baselines.rst
@@ -77,7 +77,7 @@ Baselines on REPLAY-ATTACK database
--------------------------------------
This section summarizes the results of baseline face PAD experiments on the
-REPLAY-ATTACK (`replayattack`_) database. The description of the
+REPLAY-ATTACK (`replay-attack`_) 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 detail you can check the corresponding
@@ -205,26 +205,28 @@ Finally, you can evaluate this baseline using::
which should give you::
- [Min. criterion: EER ] Threshold on Development set `<OUTPUT>/scores-dev.csv`: 4.051177e-01
- =================== ============== ==============
- .. Development Evaluation
- =================== ============== ==============
- APCER (mattescreen) 4.7% 8.3%
- APCER (print) 15.6% 18.8%
- APCER_AP 15.6% 18.8%
- BPCER 10.0% 10.9%
- ACER 12.8% 14.8%
- FTA 0.0% 0.0%
- FPR 10.2% (26/256) 13.5% (26/192)
- FNR 10.0% (16/160) 10.9% (12/110)
- HTER 10.1% 12.2%
- FAR 10.2% 13.5%
- FRR 10.0% 10.9%
- PRECISION 0.8 0.8
- RECALL 0.9 0.9
- F1_SCORE 0.9 0.8
- AUC 1.0 1.0
- AUC-LOG-SCALE 2.0 1.8
- =================== ============== ==============
+ [Min. criterion: EER ] Threshold on Development set `<OUTPUT>/scores-dev.csv`: 4.326179e-01
+ ====================== ============= ============
+ .. Development Evaluation
+ ====================== ============= ============
+ APCER (print/1) 0.6% 1.7%
+ APCER (print/2) 0.0% 4.2%
+ APCER (video_replay/1) 1.7% 0.0%
+ APCER (video_replay/2) 0.0% 0.8%
+ APCER_AP 1.7% 4.2%
+ BPCER 0.6% 0.0%
+ ACER 1.1% 2.1%
+ FTA 0.0% 0.0%
+ FPR 0.6% (4/720) 1.7% (8/480)
+ FNR 0.6% (1/180) 0.0% (0/120)
+ HTER 0.6% 0.8%
+ FAR 0.6% 1.7%
+ FRR 0.6% 0.0%
+ PRECISION 1.0 0.9
+ RECALL 1.0 1.0
+ F1_SCORE 1.0 1.0
+ AUC 1.0 1.0
+ AUC-LOG-SCALE 2.9 2.7
+ ====================== ============= ============
.. include:: links.rst
diff --git a/doc/resources.rst b/doc/resources.rst
index e8e7925e..a2d558e6 100644
--- a/doc/resources.rst
+++ b/doc/resources.rst
@@ -43,7 +43,16 @@ Replay-Mobile Database
.. automodule:: bob.pad.face.config.replay_mobile
:members:
----------------------------------
+
+
+.. _bob.pad.face.resources.databases.oulunpu:
+
+OULU-NPU Database
+================================================================================
+
+.. automodule:: bob.pad.face.config.oulunpu
+ :members:
+
.. _bob.pad.face.resources.face_pad:
@@ -57,3 +66,5 @@ The configuration files contain at least the following arguments of the
``bob pad run-pipeline`` command:
* ``pipeline`` containing zero, one, or more Transformers and one Classifier
+
+.. include:: links.rst
--
GitLab