py_api.rst 4.33 KB
Newer Older
1 2 3 4 5

===========================
Python API for bob.bio.base
===========================

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

Pipelines
---------

Database
~~~~~~~~

.. autosummary::

  bob.bio.base.pipelines.vanilla_biometrics.abstract_classes.Database
  bob.bio.base.pipelines.vanilla_biometrics.abstract_classes.Database.background_model_samples
  bob.bio.base.pipelines.vanilla_biometrics.abstract_classes.Database.references
  bob.bio.base.pipelines.vanilla_biometrics.abstract_classes.Database.probes

Database implementations
........................

.. autosummary::

25
..  bob.bio.base.database.CSVDataset
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
..  bob.bio.base.database.CSVDatasetCrossValidation

Biometric Algorithm
~~~~~~~~~~~~~~~~~~~

.. autosummary::

  bob.bio.base.pipelines.vanilla_biometrics.abstract_classes.BioAlgorithm
  bob.bio.base.pipelines.vanilla_biometrics.abstract_classes.BioAlgorithm.score
  bob.bio.base.pipelines.vanilla_biometrics.abstract_classes.BioAlgorithm.enroll

Writing Scores
~~~~~~~~~~~~~~

.. autosummary::

  bob.bio.base.pipelines.vanilla_biometrics.abstract_classes.ScoreWriter
  bob.bio.base.pipelines.vanilla_biometrics.score_writers.FourColumnsScoreWriter
  bob.bio.base.pipelines.vanilla_biometrics.score_writers.CSVScoreWriter

Assembling the pipeline
~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::

  bob.bio.base.script.vanilla_biometrics.vanilla_biometrics


Building Pipelines from Legacy constructs
-----------------------------------------

Creating Database interfaces from legacy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::

  bob.bio.base.pipelines.vanilla_biometrics.legacy.DatabaseConnector

Creating Transformers from legacy constructs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::

  bob.bio.base.transformers.preprocessor.PreprocessorTransformer
  bob.bio.base.transformers.extractor.ExtractorTransformer
  bob.bio.base.transformers.algorithm.AlgorithmTransformer

Creating BioAlgorithms from legacy Algorithm
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::

  bob.bio.base.pipelines.vanilla_biometrics.legacy.BioAlgorithmLegacy



Legacy Constructs
83 84
-----------------

85 86
Base classes
~~~~~~~~~~~~
87 88 89

.. autosummary::

90 91 92
  bob.bio.base.preprocessor.Preprocessor
  bob.bio.base.extractor.Extractor
  bob.bio.base.algorithm.Algorithm
93

94 95 96 97
Implementations
~~~~~~~~~~~~~~~

.. autosummary::
98

99 100 101 102 103 104
  bob.bio.base.preprocessor.Filename
  bob.bio.base.extractor.Linearize
  bob.bio.base.algorithm.Distance
  bob.bio.base.algorithm.PCA
  bob.bio.base.algorithm.LDA
  bob.bio.base.algorithm.PLDA
105 106


107 108 109 110

Generic functions
-----------------

111 112 113 114
Functions dealing with resources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
115 116 117 118 119 120

  bob.bio.base.load_resource
  bob.bio.base.read_config_file
  bob.bio.base.resource_keys
  bob.bio.base.extensions
  bob.bio.base.valid_keywords
121 122 123 124 125 126 127


Miscellaneous functions
~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::

128 129 130 131
  bob.bio.base.get_config
  bob.bio.base.score_fusion_strategy
  bob.bio.base.selected_elements
  bob.bio.base.selected_indices
132

133 134


Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
135 136
Loading data
------------
137

Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
138
.. autosummary::
139 140 141 142 143 144 145 146 147 148 149

  bob.bio.base.score.load.open_file
  bob.bio.base.score.load.scores
  bob.bio.base.score.load.split
  bob.bio.base.score.load.cmc
  bob.bio.base.score.load.four_column
  bob.bio.base.score.load.split_four_column
  bob.bio.base.score.load.cmc_four_column
  bob.bio.base.score.load.five_column
  bob.bio.base.score.load.split_five_column
  bob.bio.base.score.load.cmc_five_column
Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
150

151 152
Plotting
--------
153 154 155 156 157 158 159 160 161 162 163 164 165 166

.. autosummary::

  bob.bio.base.script.figure.Cmc
  bob.bio.base.script.figure.Det
  bob.bio.base.script.figure.Dir
  bob.bio.base.script.figure.Hist
  bob.bio.base.script.figure.Roc



IO-related functions
~~~~~~~~~~~~~~~~~~~~

167 168
.. autosummary::

169 170 171 172 173 174 175
  bob.bio.base.load
  bob.bio.base.save
  bob.bio.base.load_compressed
  bob.bio.base.save_compressed
  bob.bio.base.open_compressed
  bob.bio.base.close_compressed
  bob.bio.base.check_file
176

Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
177

178 179 180
Details
-------

181
.. automodule:: bob.bio.base
182

183 184 185 186 187 188 189 190
.. automodule:: bob.bio.base.annotator
.. automodule:: bob.bio.base.pipelines
.. automodule:: bob.bio.base.pipelines.vanilla_biometrics
.. automodule:: bob.bio.base.database
.. automodule:: bob.bio.base.preprocessor
.. automodule:: bob.bio.base.extractor
.. automodule:: bob.bio.base.transformers
.. automodule:: bob.bio.base.algorithm
Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
191
.. automodule:: bob.bio.base.score.load
192 193
.. automodule:: bob.bio.base.script.figure
.. automodule:: bob.bio.base.script.commands
194
.. automodule:: bob.bio.base.script.gen
195

196 197 198 199




200
.. include:: links.rst