Skip to content
Snippets Groups Projects
Commit b2a702bb authored by Manuel Günther's avatar Manuel Günther
Browse files

Updated the documentation links to be unique

parent cadc55d5
No related branches found
No related tags found
No related merge requests found
...@@ -73,7 +73,7 @@ These five options are: ...@@ -73,7 +73,7 @@ These five options are:
* ``--sub-directory``: A descriptive name for your experiment, which will serve as a sub-directory * ``--sub-directory``: A descriptive name for your experiment, which will serve as a sub-directory
The first four parameters, i.e., the ``database``, the ``preprocessor``, the ``extractor`` and the ``algorithm`` can be specified in several different ways. The first four parameters, i.e., the ``database``, the ``preprocessor``, the ``extractor`` and the ``algorithm`` can be specified in several different ways.
For the start, we will use only the registered :ref:`Resources <resources>`. For the start, we will use only the registered :ref:`Resources <bob.bio.base.resources>`.
These resources define the source code that will be used to compute the experiments, as well as all the meta-parameters of the algorithms (which we will call the *configuration*). These resources define the source code that will be used to compute the experiments, as well as all the meta-parameters of the algorithms (which we will call the *configuration*).
To get a list of registered resources, please call: To get a list of registered resources, please call:
......
...@@ -30,7 +30,7 @@ This will assure that all parameters of the experiments are stored into the ``Ex ...@@ -30,7 +30,7 @@ This will assure that all parameters of the experiments are stored into the ``Ex
If you plan to write your own tools, please assure that you are following the following structure. If you plan to write your own tools, please assure that you are following the following structure.
.. _preprocessors: .. _bob.bio.base.preprocessors:
Preprocessors Preprocessors
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
...@@ -59,7 +59,7 @@ When a different IO for the original data is required (for example to read video ...@@ -59,7 +59,7 @@ When a different IO for the original data is required (for example to read video
* ``read_original_data(filename)``: Reads the original data from file. * ``read_original_data(filename)``: Reads the original data from file.
.. _extractors: .. _bob.bio.base.extractors:
Extractors Extractors
~~~~~~~~~~ ~~~~~~~~~~
...@@ -97,7 +97,7 @@ Second, this behavior is registered in the ``__init__`` function by calling the ...@@ -97,7 +97,7 @@ Second, this behavior is registered in the ``__init__`` function by calling the
Given that the training algorithm needs to have the training data split by identity, the ``bob.bio.base.extractor.Extractor.__init__(self, requires_training=True, split_training_images_by_client = True, ...)`` is used instead. Given that the training algorithm needs to have the training data split by identity, the ``bob.bio.base.extractor.Extractor.__init__(self, requires_training=True, split_training_images_by_client = True, ...)`` is used instead.
.. _algorithms: .. _bob.bio.base.algorithms:
Algorithms Algorithms
~~~~~~~~~~ ~~~~~~~~~~
...@@ -254,7 +254,7 @@ In this case, derive you class from :py:class:`bob.bio.base.database.DatabaseZT` ...@@ -254,7 +254,7 @@ In this case, derive you class from :py:class:`bob.bio.base.database.DatabaseZT`
.. note: .. note:
For a proper biometric recognition protocol, the identities from the models and the T-Norm models, as well as the Z-probes should be different. For a proper biometric recognition protocol, the identities from the models and the T-Norm models, as well as the Z-probes should be different.
For some protocols, a single probe consists of several features, see :ref:`algorithms` about strategies how to incorporate several probe files into one score. For some protocols, a single probe consists of several features, see :ref:`bob.bio.base.algorithms` about strategies how to incorporate several probe files into one score.
If your database should provide this functionality, please overwrite: If your database should provide this functionality, please overwrite:
* ``uses_probe_file_sets(self)``: Return ``True`` if the current protocol of the database provides multiple files for one probe. * ``uses_probe_file_sets(self)``: Return ``True`` if the current protocol of the database provides multiple files for one probe.
...@@ -263,7 +263,7 @@ If your database should provide this functionality, please overwrite: ...@@ -263,7 +263,7 @@ If your database should provide this functionality, please overwrite:
.. _configuration-files: .. _bob.bio.base.configuration-files:
Configuration Files Configuration Files
------------------- -------------------
...@@ -294,7 +294,7 @@ Some default configuration files can be found in the ``bob/bio/*/config`` direct ...@@ -294,7 +294,7 @@ Some default configuration files can be found in the ``bob/bio/*/config`` direct
In fact, since all tools have a different keyword, you can define a complete experiment in a single configuration file. In fact, since all tools have a different keyword, you can define a complete experiment in a single configuration file.
.. _resources: .. _bob.bio.base.resources:
Resources Resources
--------- ---------
......
...@@ -67,7 +67,7 @@ The configuration file is a common python file, which can contain certain variab ...@@ -67,7 +67,7 @@ The configuration file is a common python file, which can contain certain variab
5. ``requirement =`` 5. ``requirement =``
6. ``imports =`` 6. ``imports =``
The variables from 1. to 3. usually contain instantiations for classes of :ref:`preprocessors`, :ref:`extractors` and :ref:`algorithms`, but also registered :ref:`resources` can be used. The variables from 1. to 3. usually contain instantiations for classes of :ref:`bob.bio.base.preprocessors`, :ref:`bob.bio.base.extractors` and :ref:`bob.bio.base.algorithms`, but also registered :ref:`bob.bio.base.resources` can be used.
For any of the parameters of the classes, a *placeholder* can be put. For any of the parameters of the classes, a *placeholder* can be put.
By default, these place holders start with a # character, followed by a digit or character. By default, these place holders start with a # character, followed by a digit or character.
The variables 1. to 3. can also be overridden by the command line options ``--preprocessor``, ``--extractor`` and ``--algorithm`` of the ``./bin/grid_search.py`` script. The variables 1. to 3. can also be overridden by the command line options ``--preprocessor``, ``--extractor`` and ``--algorithm`` of the ``./bin/grid_search.py`` script.
......
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