Commit f0a1d9d9 authored by Pavel KORSHUNOV's avatar Pavel KORSHUNOV
Browse files

Fixing issues with sphinx docs

parent aecc45a6
Pipeline #5062 running with stages
in 17 minutes and 56 seconds
......@@ -4,4 +4,24 @@ from .ISV import ISV
from .IVector import IVector
# 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__(
GMM,
GMMRegular,
JFA,
ISV,
IVector,
)
__all__ = [_ for _ in dir() if not _.startswith('_')]
......@@ -14,7 +14,7 @@ These scripts integrate perfectly into the ``bob.bio`` packages.
Particularly, they have exactly the same set of options as documented in :ref:`bob.bio.base.experiments`.
In fact, the scripts above only run in parallelized mode, i.e., either the ``--grid`` or ``--parallel`` option is required.
During the submission of the jobs, several hundred jobs might be created (depending on the ``number_of_..._training_iterations`` that you specify in the :py:class:`bob.bio.gmm.algorithms.GMM` constructor).
During the submission of the jobs, several hundred jobs might be created (depending on the ``number_of_..._training_iterations`` that you specify in the :py:class:`bob.bio.gmm.algorithm.GMM` constructor).
However, after the training has finished, it is possible to use the normal ``./bin/verify.py`` script to run similar experiments, e.g., if you want to change the protocol of your experiment.
.. todo:: improve the documentation of the parallelized scripts.
Supports Markdown
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