.. _l-modules:

Modules
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                                           | truncated documentation                                                                                                                                                                   |
+==================================================================+===========================================================================================================================================================================================+
| :ref:`__init__ <f-init>`                                         | module ``pymlbenchmark``    Benchmarks about Machine Learning in Python.      :githublink:`%|py|6`                                                                                        |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                                        | module ``pymlbenchmark.benchmark``    Shortcut to *benchmark*.      :githublink:`%|py|5`                                                                                                  |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                                       | module ``pymlbenchmark.context``    Shortcut to *context*.      :githublink:`%|py|5`                                                                                                      |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                                      | module ``pymlbenchmark.datasets``    Shortcut to *datasets*.      :githublink:`%|py|5`                                                                                                    |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzz>`                                     | module ``pymlbenchmark.external``    Shortcut to *external*.      :githublink:`%|py|5`                                                                                                    |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzz>`                                    | module ``pymlbenchmark.plotting``    Shortcuts to *plotting*.      :githublink:`%|py|5`                                                                                                   |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`artificial <f-artificial>`                                 | module ``pymlbenchmark.datasets.artificial``    Artificial datasets.      :githublink:`%|py|5`                                                                                            |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bench_helper <f-benchhelper>`                              | module ``pymlbenchmark.benchmark.bench_helper``    Implements a benchmark about performance.      :githublink:`%|py|5`                                                                    |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`benchmark_perf <f-benchmarkperf>`                          | module ``pymlbenchmark.benchmark.benchmark_perf``    Implements a benchmark about performance.      :githublink:`%|py|5`                                                                  |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`machine <f-machine>`                                       | module ``pymlbenchmark.context.machine``    Helpers which returns more information about the system.      :githublink:`%|py|5`                                                            |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnxruntime_perf <f-onnxruntimeperf>`                      | module ``pymlbenchmark.external.onnxruntime_perf``    Implements a benchmark about performance for :epkg:`onnxruntime`      :githublink:`%|py|5`                                          |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnxruntime_perf_binclass <f-onnxruntimeperfbinclass>`     | module ``pymlbenchmark.external.onnxruntime_perf_binclass``    Implements a benchmark for a binary classification  about performance for :epkg:`OnnxInference`.      :githublink:`%|py|6` |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnxruntime_perf_list <f-onnxruntimeperflist>`             | module ``pymlbenchmark.external.onnxruntime_perf_list``    Returns predefined tests.      :githublink:`%|py|5`                                                                            |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnxruntime_perf_regression <f-onnxruntimeperfregression>` | module ``pymlbenchmark.external.onnxruntime_perf_regression``    Implements a benchmark for a single regression  about performance for :epkg:`onnxruntime`.      :githublink:`%|py|6`     |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`plot_bench_results <f-plotbenchresults>`                   | module ``pymlbenchmark.plotting.plot_bench_results``    Plotting for benchmarks.      :githublink:`%|py|5`                                                                                |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`plot_bench_xtime <f-plotbenchxtime>`                       | module ``pymlbenchmark.plotting.plot_bench_xtime``    Plotting for benchmarks.      :githublink:`%|py|5`                                                                                  |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`plot_helper <f-plothelper>`                                | module ``pymlbenchmark.plotting.plot_helper``    Plotting helpers      :githublink:`%|py|5`                                                                                               |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`profiler_class <f-profilerclass>`                          | module ``pymlbenchmark.benchmark.profiler_class``    Implements a benchmark about performance.      :githublink:`%|py|5`                                                                  |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`real_data <f-realdata>`                                    | module ``pymlbenchmark.datasets.real_data``    Artificial datasets.      :githublink:`%|py|5`                                                                                             |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sklearn_helper <f-sklearnhelper>`                          | module ``pymlbenchmark.benchmark.sklearn_helper``    Helpers about :epkg:`scikit-learn`.      :githublink:`%|py|5`                                                                        |
+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    pymlbenchmark/__init__
    pymlbenchmark/benchmark/__init__
    pymlbenchmark/benchmark/bench_helper
    pymlbenchmark/benchmark/benchmark_perf
    pymlbenchmark/benchmark/profiler_class
    pymlbenchmark/benchmark/sklearn_helper
    pymlbenchmark/context/__init__
    pymlbenchmark/context/machine
    pymlbenchmark/datasets/__init__
    pymlbenchmark/datasets/artificial
    pymlbenchmark/datasets/real_data
    pymlbenchmark/external/__init__
    pymlbenchmark/external/onnxruntime_perf
    pymlbenchmark/external/onnxruntime_perf_binclass
    pymlbenchmark/external/onnxruntime_perf_list
    pymlbenchmark/external/onnxruntime_perf_regression
    pymlbenchmark/plotting/__init__
    pymlbenchmark/plotting/plot_bench_results
    pymlbenchmark/plotting/plot_bench_xtime
    pymlbenchmark/plotting/plot_helper