diff --git a/doc/index.rst b/doc/index.rst index 1b6fe963f9e9708ea767584658d835f84a4164e8..0e94f946662d4a02fc5360a933251f514bbb2c17 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -9,6 +9,10 @@ Running Presentation Attack Detection Experiments =================================================== +.. todo:: + + check and revamp + The ``bob.pad`` packages provide open source tools to run comparable and reproducible presentation attack detection (PAD) experiments. To design such experiment, one has to choose: @@ -47,10 +51,10 @@ Users Guide :maxdepth: 2 installation - experiments - implementation - high_level_db_interface_guide - filedb_guide + pad_intro + vanilla_pad_intro + vanilla_pad_features + legacy Reference Manual diff --git a/doc/installation.rst b/doc/installation.rst index 2c9f50dfae0efe98eea854fd1725a58e119d3952..011650a9aebbba4f2ecf0e6897652f6e4532d5e4 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -5,6 +5,12 @@ .. _bob.pad.base.installation: + +.. todo:: + + update and link to general bob install instructions. + + =========================== Installation Instructions =========================== diff --git a/doc/legacy.rst b/doc/legacy.rst new file mode 100644 index 0000000000000000000000000000000000000000..9e4a004aeb759db21e6e29825ee4ea80bdd4ead8 --- /dev/null +++ b/doc/legacy.rst @@ -0,0 +1,18 @@ +.. vim: set fileencoding=utf-8 : +.. author: Yannick Dayer <yannick.dayer@idiap.ch> +.. date: 2020-11-27 15:30:51 +01 + +.. _bob.pad.base.legacy: + +================================ + Using legacy bob.pad utilities +================================ + +.. todo:: + + legacy adaptors: + + - db connector + - legacy wrappers + + Look at bob.bio.base legacy diff --git a/doc/pad_intro.rst b/doc/pad_intro.rst new file mode 100644 index 0000000000000000000000000000000000000000..789e05a9d2a40a703b511e84938facdbb566a20c --- /dev/null +++ b/doc/pad_intro.rst @@ -0,0 +1,20 @@ +.. vim: set fileencoding=utf-8 : +.. author: Yannick Dayer <yannick.dayer@idiap.ch> +.. date: 2020-11-27 15:14:11 +01 + +.. _bob.pad.base.pad_intro: + + +=============================== + Presentation attack detection +=============================== + +.. todo:: + + Introduce PAD: + + - What it is + - Why + - How + + Look at bob.bio.base diff --git a/doc/vanilla_pad_features.rst b/doc/vanilla_pad_features.rst new file mode 100644 index 0000000000000000000000000000000000000000..dd3e04d2d8cd131f61e2cd966a65ed116fe4c29f --- /dev/null +++ b/doc/vanilla_pad_features.rst @@ -0,0 +1,20 @@ +.. vim: set fileencoding=utf-8 : +.. author: Yannick Dayer <yannick.dayer@idiap.ch> +.. date: 2020-11-27 15:26:09 +01 + +.. _bob.pad.base.vanilla_pad_features: + +====================== + Vanilla PAD features +====================== + +.. todo:: + + Introduce vanilla-pad features: + + - db: filelist and interface class + - checkpoints + - dask + + Look at bob.bio.base vanilla-biometrics features + Import from filedb_guide and high_level_db_interface_guide diff --git a/doc/vanilla_pad_intro.rst b/doc/vanilla_pad_intro.rst new file mode 100644 index 0000000000000000000000000000000000000000..60b7fa958fc7efe5a737542708cf5ab05620a883 --- /dev/null +++ b/doc/vanilla_pad_intro.rst @@ -0,0 +1,19 @@ +.. vim: set fileencoding=utf-8 : +.. author: Yannick Dayer <yannick.dayer@idiap.ch> +.. date: 2020-11-27 15:26:02 +01 + +.. _bob.pad.base.vanilla_pad_intro: + +============= + Vanilla PAD +============= + +.. todo:: + + Introduce vanilla-pad: + + - What it is + - How it works + + Look at bob.bio.base vanilla-biometrics + Import from experiments.rst