Commit 8595763c authored by Pavel KORSHUNOV's avatar Pavel KORSHUNOV
Browse files

Fix sphinx warnings

parent 84c59c6f
Pipeline #5073 failed with stages
in 6 minutes and 15 seconds
from .Wrapper import Wrapper
# gets sphinx autodoc done right - don't remove it
def __appropriate__(*args):
"""Says object was actually declared here, and not in the import module.
Fixing sphinx warnings of not being able to find classes, when path is shortened.
Parameters:
*args: An iterable of objects to modify
Resolves `Sphinx referencing issues
<https://github.com/sphinx-doc/sphinx/issues/3048>`
"""
for obj in args: obj.__module__ = __name__
__appropriate__(
Wrapper,
)
__all__ = [_ for _ in dir() if not _.startswith('_')]
......@@ -4,4 +4,23 @@ from .youtube import YoutubeBioDatabase
# gets sphinx autodoc done right - don't remove it
def __appropriate__(*args):
"""Says object was actually declared here, and not in the import module.
Fixing sphinx warnings of not being able to find classes, when path is shortened.
Parameters:
*args: An iterable of objects to modify
Resolves `Sphinx referencing issues
<https://github.com/sphinx-doc/sphinx/issues/3048>`
"""
for obj in args: obj.__module__ = __name__
__appropriate__(
VideoBioFile,
MobioBioDatabase,
YoutubeBioDatabase,
)
__all__ = [_ for _ in dir() if not _.startswith('_')]
......@@ -118,7 +118,7 @@ class Wrapper (bob.bio.base.extractor.Extractor):
**Parameters:**
frames : :py:class:`bob.bio.video.FrameContainer`
The extracted features for the selected frames, as returned by the :py:meth:`__call__` function.
The extracted features for the selected frames, as returned by the `__call__` function.
filename : str
The file name to write the extracted feature into.
......
from .Wrapper import Wrapper
# gets sphinx autodoc done right - don't remove it
def __appropriate__(*args):
"""Says object was actually declared here, and not in the import module.
Fixing sphinx warnings of not being able to find classes, when path is shortened.
Parameters:
*args: An iterable of objects to modify
Resolves `Sphinx referencing issues
<https://github.com/sphinx-doc/sphinx/issues/3048>`
"""
for obj in args: obj.__module__ = __name__
__appropriate__(
Wrapper,
)
__all__ = [_ for _ in dir() if not _.startswith('_')]
......@@ -11,7 +11,7 @@ class Wrapper(bob.bio.base.preprocessor.Preprocessor):
"""Wrapper class to run image preprocessing algorithms on video data.
This class provides functionality to read original video data from several databases.
So far, the video content from :py:class:`bob.db.mobio` and the image list content from :py:class:`bob.db.youtube` are supported.
So far, the video content from :ref:`bob.db.mobio <bob.db.mobio>` and the image list content from :ref:`bob.db.youtube <bob.db.youtube>` are supported.
Furthermore, frames are extracted from these video data, and a ``preprocessor`` algorithm is applied on all selected frames.
The preprocessor can either be provided as a registered resource, i.e., one of :ref:`bob.bio.face.preprocessors`, or an instance of a preprocessing class.
......@@ -44,7 +44,8 @@ class Wrapper(bob.bio.base.preprocessor.Preprocessor):
read_original_data: callable or ``None``
Function that loads the raw data.
If not explicitly defined the raw data will be loaded by :py:meth:`bob.bio.video.database.VideoBioFile.load`. using the specified ``frame_selector``
If not explicitly defined the raw data will be loaded by :py:meth:`bob.bio.video.database.VideoBioFile.load`
using the specified ``frame_selector``
"""
......
from .Wrapper import Wrapper
# gets sphinx autodoc done right - don't remove it
def __appropriate__(*args):
"""Says object was actually declared here, and not in the import module.
Fixing sphinx warnings of not being able to find classes, when path is shortened.
Parameters:
*args: An iterable of objects to modify
Resolves `Sphinx referencing issues
<https://github.com/sphinx-doc/sphinx/issues/3048>`
"""
for obj in args: obj.__module__ = __name__
__appropriate__(
Wrapper,
)
__all__ = [_ for _ in dir() if not _.startswith('_')]
from .FrameContainer import FrameContainer, load_compressed, save_compressed
from .FrameSelector import FrameSelector
python
numpy
bob.bio.gmm
\ No newline at end of file
bob.bio.gmm
bob.db.mobio
bob.db.youtube
\ No newline at end of file
......@@ -8,7 +8,7 @@ Wrapper classes
The tools implemented in this package provide wrapper classes for preprocessing, feature extraction and face recognition algorithms that are implemented in other packages of ``bob.bio``.
The basic idea is that the wrapped algorithms are provided with several frames of the video.
For this purpose, the :py:class:`bob.bio.video.utils.FrameSelector` can be applied to select one or several frames from the source video.
For this purpose, the :py:class:`bob.bio.video.FrameSelector` can be applied to select one or several frames from the source video.
For each of the selected frames, the faces are aligned -- either using hand-labeled data, or after detecting the faces using :py:class:`bob.bio.face.preprocessor.FaceDetect`.
Afterward, features are extracted, models are enrolled using several frames per video, and the scoring procedure fuses the scores from one model and several probe frames of a probe video.
If one of the base algorithms requires training, the wrapper classes provide these information accordingly.
......@@ -53,7 +53,7 @@ Hence, when you want to run an experiment using the video wrapper classes, you m
Databases
~~~~~~~~~
All video databases defined here rely on the :py:class:`bob.bio.base.BioDatabase` interface, which in turn uses the `verification_databases <https://gitlab.idiap.ch/bob/bob/wikis/Packages>`_.
All video databases defined here rely on the :py:class:`bob.bio.base.database.BioDatabase` interface, which in turn uses the `verification_databases <https://gitlab.idiap.ch/bob/bob/wikis/Packages>`_.
After downloading and extracting the original data of the data sets, it is necessary that the scripts know, where the data was installed.
For this purpose, the ``./bin/verify.py`` script can read a special file, where those directories are stored, see :ref:`bob.bio.base.installation`.
......
......@@ -27,3 +27,5 @@ Details
.. automodule:: bob.bio.video.extractor
.. automodule:: bob.bio.video.algorithm
.. automodule:: bob.bio.video.database
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