Commit 5409920b authored by Amir MOHAMMADI's avatar Amir MOHAMMADI

Fix the sphinx warnings

parent 742401f6
Pipeline #14443 passed with stages
in 11 minutes and 54 seconds
......@@ -131,21 +131,23 @@ class PadDatabase(BioDatabase):
#################################################################
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.
The files can be limited using the ``all_files_options`` in the constructor.
Parameters
----------
groups : str or tuple or None
The groups to get the data for. it should be some of ``('train',
'dev', 'eval')`` or ``None``
**Parameters:**
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:**
flat : bool
if True, it will merge the real and attack files into one list.
Returns
-------
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))
attackset = self.sort(self.objects(protocol=self.protocol, groups=groups, purposes='attack', **self.all_files_options))
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment