README.rst 2.08 KB
Newer Older
1 2
.. vim: set fileencoding=utf-8 :
.. Pavel Korshunov <pavel.korshunov@idiap.ch>
3 4
.. Wed 19 Oct 22:36:22 2016 CET

5
.. image:: https://img.shields.io/badge/docs-available-orange.svg
Jaden's avatar
Jaden committed
6
   :target: https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/index.html
7 8 9 10
.. image:: https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/pipeline.svg
   :target: https://gitlab.idiap.ch/bob/bob.pad.base/commits/master
.. image:: https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/bob/bob.pad.base/commits/master
11 12
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/bob/bob.pad.base
13 14 15 16 17

========================================
Scripts to run anti-spoofing experiments
========================================

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
18 19 20 21
This package is part of the signal-processing and machine learning toolbox Bob_.
This package is the base of ``bob.pad`` family of packages, which allow to run
comparable and reproducible presentation attack detection (PAD) experiments on
publicly available databases.
22

Pavel KORSHUNOV's avatar
Pavel KORSHUNOV committed
23
This package contains basic functionality to run PAD experiments.
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
24
It provides a generic API for PAD including:
25 26 27 28

* A database and its evaluation protocol
* A data preprocessing algorithm
* A feature extraction algorithm
Pavel KORSHUNOV's avatar
Pavel KORSHUNOV committed
29
* A PAD algorithm
30

Pavel KORSHUNOV's avatar
Pavel KORSHUNOV committed
31
All these steps of the PAD system are given as configuration files.
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
32
All the algorithms are standardized on top of scikit-learn estimators.
33

Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
34 35 36
In this base package, only a core functionality is implemented. The specialized
algorithms should be provided by other packages, which are usually in the
``bob.pad`` namespace, like ``bob.pad.face``.
37 38 39 40

Installation
------------

Jaden's avatar
Jaden committed
41
Complete Bob's `installation`_ instructions. Then, to install this package,
42
run::
43

44
  $ conda install bob.pad.base
45 46 47 48 49 50 51 52 53 54


Contact
-------

For questions or reporting issues to this software package, contact our
development `mailing list`_.


.. Place your references here:
55
.. _bob: https://www.idiap.ch/software/bob
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
56
.. _installation: https://www.idiap.ch/software/bob/install
57
.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel