py_api.rst 1.9 KB
Newer Older
André Anjos's avatar
André Anjos committed
1
.. vim: set fileencoding=utf-8 :
2
.. Sat 16 Nov 20:52:58 2013
André Anjos's avatar
André Anjos committed
3 4 5 6 7

============
 Python API
============

8 9
This section includes information for using the Python API of
:py:mod:`bob.measure`.
André Anjos's avatar
André Anjos committed
10

11

12 13 14
Measurement
-----------

15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
Classification
++++++++++++++

.. autosummary::
   bob.measure.correctly_classified_negatives
   bob.measure.correctly_classified_positives

Single point measurements
+++++++++++++++++++++++++

.. autosummary::
   bob.measure.farfrr
   bob.measure.f_score
   bob.measure.precision_recall
   bob.measure.recognition_rate
30 31
   bob.measure.detection_identification_rate
   bob.measure.false_alarm_rate
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
   bob.measure.eer_rocch

Thresholds
++++++++++

.. autosummary::
   bob.measure.eer_threshold
   bob.measure.rocch2eer
   bob.measure.min_hter_threshold
   bob.measure.min_weighted_error_rate_threshold
   bob.measure.far_threshold
   bob.measure.frr_threshold

Curves
++++++

.. autosummary::
   bob.measure.roc
   bob.measure.rocch
   bob.measure.roc_for_far
   bob.measure.det
   bob.measure.epc
   bob.measure.precision_recall_curve
   bob.measure.cmc

Generic
+++++++

.. autosummary::
   bob.measure.ppndf
   bob.measure.relevance
   bob.measure.mse
   bob.measure.rmse
   bob.measure.get_config
André Anjos's avatar
André Anjos committed
66

67 68 69 70 71 72 73

Confidence interval
-------------------

.. autosummary::
   bob.measure.utils.confidence_for_indicator_variable

74 75 76
Calibration
-----------

77 78 79
.. autosummary::
   bob.measure.calibration.cllr
   bob.measure.calibration.min_cllr
80 81 82 83

Plotting
--------

84 85 86 87 88 89 90
.. autosummary::
   bob.measure.plot.roc
   bob.measure.plot.det
   bob.measure.plot.det_axis
   bob.measure.plot.epc
   bob.measure.plot.precision_recall_curve
   bob.measure.plot.cmc
91
   bob.measure.plot.detection_identification_curve
92

Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
93 94 95 96 97 98
Loading
-------

.. autosummary::
   bob.measure.load.split

99 100 101 102 103 104 105

Details
-------

.. automodule:: bob.measure
.. automodule:: bob.measure.calibration
.. automodule:: bob.measure.plot
Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
106
.. automodule:: bob.measure.load
107
.. automodule:: bob.measure.utils