diff --git a/MANIFEST.in b/MANIFEST.in index 08b0470c9f6818bda1dc326fd7e537ceeb617ec3..1c983b7199d8ed96a2674852ef66fff5ce38bfb1 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,7 +1,5 @@ -include README.rst +include README.md COPYING recursive-include doc *.py *.rst -recursive-include bob *.txt *.hdf5 -recursive-include bob *.sql3 recursive-include tests/data scores-* *.sql3 *.wav recursive-include tests/example_filelist *.lst recursive-include tests/ *.csv diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..dd114eee82aa092b0d4059f27073af5db1845b0a --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +[](https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/sphinx/index.html) +[](https://gitlab.idiap.ch/bob/bob.pad.base/commits/master) +[](https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/coverage/) +[](https://gitlab.idiap.ch/bob/bob.pad.base) + +# Scripts to run anti-spoofing experiments + +This package is part of the signal-processing and machine learning toolbox +[Bob](https://www.idiap.ch/software/bob). +This package is the base of the `bob.pad` family of packages, which allow to +run comparable and reproducible presentation attack detection (PAD) experiments +on publicly available databases. + +This package contains basic functionality to run PAD experiments. +It provides a generic API for PAD including: + +* A database and its evaluation protocol +* A data preprocessing algorithm +* A feature extraction algorithm +* A PAD algorithm + +All these steps of the PAD system are given as configuration files. +All the algorithms are standardized on top of scikit-learn estimators. + +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`](https://gitlab.idiap.ch/bob/bob.pad.face). + +## Installation + +Complete Bob's +[installation instructions](https://www.idiap.ch/software/bob/install). Then, +to install this package, run: +``` sh +conda install bob.pad.base +``` + +## Contact + +For questions or reporting issues to this software package, contact our +development [mailing list](https://www.idiap.ch/software/bob/discuss). diff --git a/README.rst b/README.rst deleted file mode 100644 index fcd5ff686a96487a7272a64c74d67c26e7cb388f..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. vim: set fileencoding=utf-8 : -.. Pavel Korshunov <pavel.korshunov@idiap.ch> -.. Wed 19 Oct 22:36:22 2016 CET - -.. image:: https://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/sphinx/index.html -.. 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://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/coverage/ -.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg - :target: https://gitlab.idiap.ch/bob/bob.pad.base - -======================================== -Scripts to run anti-spoofing experiments -======================================== - -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. - -This package contains basic functionality to run PAD experiments. -It provides a generic API for PAD including: - -* A database and its evaluation protocol -* A data preprocessing algorithm -* A feature extraction algorithm -* A PAD algorithm - -All these steps of the PAD system are given as configuration files. -All the algorithms are standardized on top of scikit-learn estimators. - -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``. - -Installation ------------- - -Complete Bob's `installation`_ instructions. Then, to install this package, -run:: - - $ conda install bob.pad.base - - -Contact -------- - -For questions or reporting issues to this software package, contact our -development `mailing list`_. - - -.. Place your references here: -.. _bob: https://www.idiap.ch/software/bob -.. _installation: https://www.idiap.ch/software/bob/install -.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel diff --git a/pyproject.toml b/pyproject.toml index 567d7260aa059ede0a9314721db63532b422912f..4a6f9bd0be78127a785ee2238d42cfc0043b5d76 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -70,7 +70,7 @@ package-dir = {"" = "src"} [tool.setuptools.dynamic] - readme = {file = "README.rst"} + readme = {file = "README.md", content-type = "text/markdown"} [project.entry-points."bob.cli"] pad = "bob.pad.base.script.pad:pad"