Skip to content
Snippets Groups Projects
Commit 5409920b authored by Amir MOHAMMADI's avatar Amir MOHAMMADI
Browse files

Fix the sphinx warnings

parent 742401f6
No related branches found
No related tags found
1 merge request!23Add an option to return a flat list
Pipeline #
...@@ -131,21 +131,23 @@ class PadDatabase(BioDatabase): ...@@ -131,21 +131,23 @@ class PadDatabase(BioDatabase):
################################################################# #################################################################
def all_files(self, groups=('train', 'dev', 'eval'), flat=False): def all_files(self, groups=('train', 'dev', 'eval'), flat=False):
"""all_files(groups=('train', 'dev', 'eval')) -> files """Returns all files of the database, respecting the current protocol.
The files can be limited using the ``all_files_options`` in the
constructor.
Returns all files of the database, respecting the current protocol. Parameters
The files can be limited using the ``all_files_options`` in the constructor. ----------
groups : str or tuple or None
The groups to get the data for. it should be some of ``('train',
'dev', 'eval')`` or ``None``
**Parameters:** flat : bool
if True, it will merge the real and attack files into one list.
groups : some of ``('train', 'dev', 'eval')`` or ``None``
The groups to get the data for.
flat : if True, it will merge the real and attack files into one list.
**Returns:**
Returns
-------
files : [:py:class:`bob.pad.base.database.PadFile`] files : [:py:class:`bob.pad.base.database.PadFile`]
The sorted and unique list of all files of the database. The sorted and unique list of all files of the database.
""" """
realset = self.sort(self.objects(protocol=self.protocol, groups=groups, purposes='real', **self.all_files_options)) realset = self.sort(self.objects(protocol=self.protocol, groups=groups, purposes='real', **self.all_files_options))
attackset = self.sort(self.objects(protocol=self.protocol, groups=groups, purposes='attack', **self.all_files_options)) attackset = self.sort(self.objects(protocol=self.protocol, groups=groups, purposes='attack', **self.all_files_options))
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment