From 09309bd2277894f6bc15fbee0208cd1b3dd5f8f6 Mon Sep 17 00:00:00 2001
From: Amir MOHAMMADI <amir.mohammadi@idiap.ch>
Date: Fri, 12 Jan 2018 14:31:53 +0100
Subject: [PATCH] Fix sphinx warnings
---
bob/pad/base/database/PadBioFileDB.py | 47 +++++++++++++++++----------
1 file changed, 29 insertions(+), 18 deletions(-)
diff --git a/bob/pad/base/database/PadBioFileDB.py b/bob/pad/base/database/PadBioFileDB.py
index d065b3d..ead9b10 100644
--- a/bob/pad/base/database/PadBioFileDB.py
+++ b/bob/pad/base/database/PadBioFileDB.py
@@ -1,5 +1,5 @@
"""
-Implementation of high-level interfaces for FileList-based databases that can be
+Implementation of high-level interfaces for FileList-based databases that can be
used by both verification and PAD experiments.
"""
@@ -111,23 +111,34 @@ class HighBioDatabase(BioDatabase):
def objects(self, protocol=None, purposes=None, model_ids=None, groups=None, **kwargs):
"""
- Maps objects method of PAD databases into objects method of Verification database
-
- :param protocol: To distinguish two vulnerability scenarios, protocol name should have either
- '-licit' or '-spoof' appended to it. For instance, if DB has protocol 'general', the named passed to this method
- should be 'general-licit', if we want to run verification experiments on bona fide data only, but it should be
- 'general-spoof', if we want to run it for spoof scenario (the probes are attacks).
-
- :param purposes: This parameter is passed by the ``bob.bio.base`` verification experiment
-
- :param model_ids: This parameter is passed by the ``bob.bio.base`` verification experiment
-
- :param groups: We map the groups from ('world', 'dev', 'eval') used in verification experiments to
- ('train', 'dev', 'eval')
-
- :param kwargs: The rest of the parameters valid for a given database
-
- :return: Set of BioFiles that verification experiments expect.
+ Maps objects method of PAD databases into objects method of
+ Verification database
+
+ Parameters
+ ----------
+ protocol : str
+ To distinguish two vulnerability scenarios, protocol name should
+ have either '-licit' or '-spoof' appended to it. For instance, if
+ DB has protocol 'general', the named passed to this method should
+ be 'general-licit', if we want to run verification experiments on
+ bona fide data only, but it should be 'general-spoof', if we want
+ to run it for spoof scenario (the probes are attacks).
+ purposes : [str]
+ This parameter is passed by the ``bob.bio.base`` verification
+ experiment
+ model_ids : [object]
+ This parameter is passed by the ``bob.bio.base`` verification
+ experiment
+ groups : [str]
+ We map the groups from ('world', 'dev', 'eval') used in
+ verification experiments to ('train', 'dev', 'eval')
+ **kwargs
+ The rest of the parameters valid for a given database
+
+ Returns
+ -------
+ [object]
+ Set of BioFiles that verification experiments expect.
"""
# convert group names from the conventional names in verification experiments to the internal database names
--
GitLab