py_api.rst 4.07 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
   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

57 58 59 60 61 62 63 64 65 66 67 68
Figures
-------

.. autosummary::
   bob.measure.script.figure.MeasureBase
   bob.measure.script.figure.Metrics
   bob.measure.script.figure.PlotBase
   bob.measure.script.figure.Roc
   bob.measure.script.figure.Det
   bob.measure.script.figure.Epc
   bob.measure.script.figure.Hist

69 70 71 72 73 74 75 76 77
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
78

79 80 81 82 83 84 85

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

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

86 87 88
Calibration
-----------

89 90 91
.. autosummary::
   bob.measure.calibration.cllr
   bob.measure.calibration.min_cllr
92 93 94 95

Plotting
--------

96 97 98 99 100 101 102
.. 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
103
   bob.measure.plot.detection_identification_curve
104

Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
105 106 107 108 109 110
Loading
-------

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

111 112 113 114 115 116 117 118
Utilities
---------

.. autosummary::
   bob.measure.utils.remove_nan
   bob.measure.utils.get_fta
   bob.measure.utils.get_thres
   bob.measure.utils.get_colors
119

120 121 122 123
CLI options
-----------

.. autosummary::
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
   bob.measure.script.common_options.scores_argument
   bob.measure.script.common_options.eval_option
   bob.measure.script.common_options.sep_dev_eval_option
   bob.measure.script.common_options.cmc_option
   bob.measure.script.common_options.show_dev_option
   bob.measure.script.common_options.print_filenames_option
   bob.measure.script.common_options.const_layout_option
   bob.measure.script.common_options.axes_val_option
   bob.measure.script.common_options.thresholds_option
   bob.measure.script.common_options.lines_at_option
   bob.measure.script.common_options.x_rotation_option
   bob.measure.script.common_options.cost_option
   bob.measure.script.common_options.points_curve_option
   bob.measure.script.common_options.n_bins_option
   bob.measure.script.common_options.table_option
   bob.measure.script.common_options.output_plot_file_option
   bob.measure.script.common_options.output_plot_metric_option
   bob.measure.script.common_options.criterion_option
   bob.measure.script.common_options.far_option
   bob.measure.script.common_options.figsize_option
   bob.measure.script.common_options.legend_ncols_option
   bob.measure.script.common_options.legend_loc_option
   bob.measure.script.common_options.line_width_option
   bob.measure.script.common_options.marker_style_option
   bob.measure.script.common_options.titles_option
   bob.measure.script.common_options.title_option
   bob.measure.script.common_options.x_label_option
   bob.measure.script.common_options.y_label_option
   bob.measure.script.common_options.style_option
153

154 155 156 157 158 159
Details
-------

.. automodule:: bob.measure
.. automodule:: bob.measure.calibration
.. automodule:: bob.measure.plot
Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
160
.. automodule:: bob.measure.load
161 162 163
.. automodule:: bob.measure.utils
.. automodule:: bob.measure.script.figure
.. automodule:: bob.measure.script.commands
164 165
.. automodule:: bob.measure.script.gen
.. automodule:: bob.measure.script.common_options