From d4ea7c0679de5f12f9d55f732d4b7e390beeb1ed Mon Sep 17 00:00:00 2001 From: Pavel Korshunov <pavel.korshunov@idiap.ch> Date: Wed, 19 Oct 2016 23:12:15 +0200 Subject: [PATCH] Fix licensing in files and readme --- README.rst | 45 ++++++++++++++++++++----- bob/pad/base/algorithm/Algorithm.py | 13 ------- bob/pad/base/script/spoof.py | 13 ------- bob/pad/base/test/dummy/algorithm.py | 14 +------- bob/pad/base/test/dummy/database.py | 14 +------- bob/pad/base/test/dummy/extractor.py | 13 ------- bob/pad/base/test/dummy/preprocessor.py | 14 +------- bob/pad/base/test/test_databases.py | 14 -------- bob/pad/base/test/test_spoof.py | 13 ------- bob/pad/base/tools/FileSelector.py | 14 +------- bob/pad/base/tools/algorithm.py | 14 +------- bob/pad/base/tools/command_line.py | 14 +------- bob/pad/base/tools/extractor.py | 14 +------- bob/pad/base/tools/preprocessor.py | 14 +------- bob/pad/base/tools/scoring.py | 14 +------- doc/implementation.rst | 2 +- doc/index.rst | 2 +- doc/installation.rst | 2 +- setup.py | 2 +- 19 files changed, 49 insertions(+), 196 deletions(-) diff --git a/README.rst b/README.rst index 255e3d3..454ca3c 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,27 @@ .. vim: set fileencoding=utf-8 : .. Pavel Korshunov <pavel.korshunov@idiap.ch> -.. Wed 30 Sep 23:36:23 2015 CET +.. Wed 19 Oct 22:36:22 2016 CET + +.. image:: http://img.shields.io/badge/docs-stable-yellow.png + :target: http://pythonhosted.org/bob.pad.base/index.html +.. image:: http://img.shields.io/badge/docs-latest-orange.png + :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob.pad.base/master/index.html +.. image:: https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/build.svg + :target: https://gitlab.idiap.ch/bob/bob.pad.base/commits/master +.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg + :target: https://gitlab.idiap.ch/bob/bob.pad.base +.. image:: http://img.shields.io/pypi/v/bob.pad.base.png + :target: https://pypi.python.org/pypi/bob.pad.base +.. image:: http://img.shields.io/pypi/dm/bob.pad.base.png + :target: https://pypi.python.org/pypi/bob.pad.base ======================================== Scripts to run anti-spoofing experiments ======================================== -This package is part of the ``bob.pad`` packages, which allow to run comparable and reproducible presentation attack detection (PAD) experiments on publicly available databases. +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 ``./bin/spoof.py`` script that takes several parameters, including: @@ -18,15 +33,27 @@ It provides a generic ``./bin/spoof.py`` script that takes several parameters, i All these steps of the PAD system are given as configuration files. -In this base class implementation, only a core functionality is implemented. The specialized algorithms should be provided by other packages, which are usually in the ``bob.pad`` namespace, such as: - -* `bob.pad.voice for speech-related PAD algorithms - +In this base class implementation, 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.voice`` Installation ------------ -To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_. -For Bob_ to be able to work properly, some dependent packages are required to be installed. -Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system. +Follow our `installation`_ instructions. Then, using the Python interpreter +provided by the distribution, bootstrap and buildout this package:: + + $ python bootstrap-buildout.py + $ ./bin/buildout + + +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://gitlab.idiap.ch/bob/bob/wikis/Installation +.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel \ No newline at end of file diff --git a/bob/pad/base/algorithm/Algorithm.py b/bob/pad/base/algorithm/Algorithm.py index e61570c..6996f5c 100644 --- a/bob/pad/base/algorithm/Algorithm.py +++ b/bob/pad/base/algorithm/Algorithm.py @@ -3,19 +3,6 @@ # Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy import os diff --git a/bob/pad/base/script/spoof.py b/bob/pad/base/script/spoof.py index 0080146..8e04ce8 100644 --- a/bob/pad/base/script/spoof.py +++ b/bob/pad/base/script/spoof.py @@ -3,19 +3,6 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. from __future__ import print_function diff --git a/bob/pad/base/test/dummy/algorithm.py b/bob/pad/base/test/dummy/algorithm.py index 80e4549..e1e8f80 100644 --- a/bob/pad/base/test/dummy/algorithm.py +++ b/bob/pad/base/test/dummy/algorithm.py @@ -3,19 +3,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import numpy import bob.io.base diff --git a/bob/pad/base/test/dummy/database.py b/bob/pad/base/test/dummy/database.py index a6e056e..aa7cbca 100644 --- a/bob/pad/base/test/dummy/database.py +++ b/bob/pad/base/test/dummy/database.py @@ -3,19 +3,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import os import sys diff --git a/bob/pad/base/test/dummy/extractor.py b/bob/pad/base/test/dummy/extractor.py index d7f6a07..8e65a74 100644 --- a/bob/pad/base/test/dummy/extractor.py +++ b/bob/pad/base/test/dummy/extractor.py @@ -3,19 +3,6 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. from bob.bio.base.extractor import Extractor diff --git a/bob/pad/base/test/dummy/preprocessor.py b/bob/pad/base/test/dummy/preprocessor.py index e17e72b..ea3fff2 100644 --- a/bob/pad/base/test/dummy/preprocessor.py +++ b/bob/pad/base/test/dummy/preprocessor.py @@ -3,19 +3,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + from bob.bio.base.preprocessor import Preprocessor import os.path diff --git a/bob/pad/base/test/test_databases.py b/bob/pad/base/test/test_databases.py index d3191c2..3653eb5 100644 --- a/bob/pad/base/test/test_databases.py +++ b/bob/pad/base/test/test_databases.py @@ -3,20 +3,6 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. - import os import unittest diff --git a/bob/pad/base/test/test_spoof.py b/bob/pad/base/test/test_spoof.py index ad7fd1e..779946b 100644 --- a/bob/pad/base/test/test_spoof.py +++ b/bob/pad/base/test/test_spoof.py @@ -4,19 +4,6 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. from __future__ import print_function diff --git a/bob/pad/base/tools/FileSelector.py b/bob/pad/base/tools/FileSelector.py index e91e218..aa0e834 100644 --- a/bob/pad/base/tools/FileSelector.py +++ b/bob/pad/base/tools/FileSelector.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import os diff --git a/bob/pad/base/tools/algorithm.py b/bob/pad/base/tools/algorithm.py index 0cf1c6e..34ed55c 100644 --- a/bob/pad/base/tools/algorithm.py +++ b/bob/pad/base/tools/algorithm.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import bob.io.base import os diff --git a/bob/pad/base/tools/command_line.py b/bob/pad/base/tools/command_line.py index 7028da9..041e31d 100644 --- a/bob/pad/base/tools/command_line.py +++ b/bob/pad/base/tools/command_line.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import argparse import os diff --git a/bob/pad/base/tools/extractor.py b/bob/pad/base/tools/extractor.py index c8acb67..018076d 100644 --- a/bob/pad/base/tools/extractor.py +++ b/bob/pad/base/tools/extractor.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import bob.io.base import os diff --git a/bob/pad/base/tools/preprocessor.py b/bob/pad/base/tools/preprocessor.py index 0db64a3..163ceef 100644 --- a/bob/pad/base/tools/preprocessor.py +++ b/bob/pad/base/tools/preprocessor.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import bob.io.base import os diff --git a/bob/pad/base/tools/scoring.py b/bob/pad/base/tools/scoring.py index f9c8933..12c713c 100644 --- a/bob/pad/base/tools/scoring.py +++ b/bob/pad/base/tools/scoring.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import bob.io.base import bob.measure diff --git a/doc/implementation.rst b/doc/implementation.rst index 155ea12..599ec46 100644 --- a/doc/implementation.rst +++ b/doc/implementation.rst @@ -93,7 +93,7 @@ Implemented Tools Example implementations of the base classes can be found in all of the ``bob.pad`` packages. Here is the current list of implementations: -* `bob.pad.voice` +* ``bob.pad.voice`` .. todo:: complete this list, once the other packages are documented as well. diff --git a/doc/index.rst b/doc/index.rst index cb38cc7..4a09718 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -34,7 +34,7 @@ The implementation of (most of) the tools is separated into other packages in th All these packages can be easily combined. Here is a growing list of derived packages: -* `bob.pad.voice <http://pypi.python.org/pypi/bob.pad.voice>`__` Tools to run presentation attack detection experiments for speech, including several Cepstral-based features and LBP-based feature extraction, GMM-based and logistic regression based algorithms, as well as plot and score fusion scripts. +* `bob.pad.voice <http://pypi.python.org/pypi/bob.pad.voice>`__ Tools to run presentation attack detection experiments for speech, including several Cepstral-based features and LBP-based feature extraction, GMM-based and logistic regression based algorithms, as well as plot and score fusion scripts. If you are interested, please continue reading: diff --git a/doc/installation.rst b/doc/installation.rst index 91816a0..28d4c15 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -63,7 +63,7 @@ Please use ``./bin/databases.py`` for a list of known databases, where you can s .. note:: - If you have installed only ``bob.pad.base``, there is no database listed -- as all databases are included in other extension packages, such as `bob.pad.voice`. + If you have installed only ``bob.pad.base``, there is no database listed -- as all databases are included in other extension packages, such as ``bob.pad.voice``. Test your Installation diff --git a/setup.py b/setup.py index 9747ba9..8c6626c 100644 --- a/setup.py +++ b/setup.py @@ -51,7 +51,7 @@ setup( version=open("version.txt").read().rstrip(), description='A framework for executing the chain of presentation attack detection (PAD) experiments', - url='https://www.github.com/bioidiap/bob.pad.base', + url='https://gitlab.idiap.ch/bob/bob.pad.base', license='GPLv3', author='Pavel Korshunov', author_email='pavel.korshunov@idiap.ch', -- GitLab