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
.. image:: https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/pipeline.svg
8 9 10
   :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
========================================

18 19 20
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.
21

Pavel KORSHUNOV's avatar
Pavel KORSHUNOV committed
22
This package contains basic functionality to run PAD experiments.
23 24 25 26 27
It provides a generic ``./bin/spoof.py`` script that takes several parameters, including:

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

Pavel KORSHUNOV's avatar
Pavel KORSHUNOV committed
30
All these steps of the PAD system are given as configuration files.
31

32
In this base class implementation, only a core functionality is implemented. The specialized algorithms should
33
be provided by other packages, which are usually in the ``bob.pad`` namespace, like a ``bob.pad.voice`` package.
34 35 36 37

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

Jaden's avatar
Jaden committed
38
Complete Bob's `installation`_ instructions. Then, to install this package,
39
run::
40

41
  $ conda install bob.pad.base
42 43 44 45 46 47 48 49 50 51


Contact
-------

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


.. Place your references here:
52
.. _bob: https://www.idiap.ch/software/bob
53
.. _installation: https://gitlab.idiap.ch/bob/bob/wikis/Installation
54
.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel