.. _l-methods:

Methods
=======

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


Summary
+++++++

+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                                                             | class parent                                 | truncated documentation                                                                                                       |
+====================================================================================================================================================+==============================================+===============================================================================================================================+
| :py:meth:`__init__ <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.__init__>`                                                                    | BenchPerf                                    |                                                                                                                               |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.__init__>`                                                                | BenchPerfTest                                |                                                                                                                               |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymlbenchmark.benchmark.profiler_class.ProfilerCall.__init__>`                                                                 | ProfilerCall                                 |                                                                                                                               |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.__init__>`                                                    | OnnxRuntimeBenchPerfTest                     |                                                                                                                               |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__iter__ <pymlbenchmark.benchmark.profiler_class.ProfilerCall.__iter__>`                                                                 | ProfilerCall                                 | Iterates on stored profiled. Returns a couple ``(profile, configuration)``.                                                   |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <pymlbenchmark.benchmark.profiler_class.ProfilerCall.__len__>`                                                                   | ProfilerCall                                 | Returns the number of stored profiles.                                                                                        |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.__repr__>`                                                                    | BenchPerf                                    | usual                                                                                                                         |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_random_dataset <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest._get_random_dataset>`                              | OnnxRuntimeBenchPerfTest                     | Returns a random datasets.                                                                                                    |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_random_dataset <pymlbenchmark.external.onnxruntime_perf_binclass.OnnxRuntimeBenchPerfTestBinaryClassification._get_random_dataset>` | OnnxRuntimeBenchPerfTestBinaryClassification | Returns a random datasets.                                                                                                    |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_random_dataset <pymlbenchmark.external.onnxruntime_perf_regression.OnnxRuntimeBenchPerfTestRegression._get_random_dataset>`         | OnnxRuntimeBenchPerfTestRegression           | Returns a random datasets.                                                                                                    |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_init <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest._init>`                                                          | OnnxRuntimeBenchPerfTest                     | Finalizes the init.                                                                                                           |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`data <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.data>`                                                                           | BenchPerfTest                                | Generates one testing dataset.                                                                                                |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`data <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.data>`                                                               | OnnxRuntimeBenchPerfTest                     | Generates random features.                                                                                                    |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`dump_error <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.dump_error>`                                                               | BenchPerfTest                                | Dumps everything which is needed to investigate an error. Everything is pickled in the current folder or *dump_folder* ...    |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_run_benchs <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.enumerate_run_benchs>`                                               | BenchPerf                                    | Runs the benchmark.                                                                                                           |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_tests <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.enumerate_tests>`                                                         | BenchPerf                                    | Enumerates all possible options.                                                                                              |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`extract_model_info_onnx <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.extract_model_info_onnx>`                         | OnnxRuntimeBenchPerfTest                     | Populates member ``self.onnx_info`` with additional information on the :epkg:`ONNX` graph.                                    |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`extract_model_info_skl <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.extract_model_info_skl>`                           | OnnxRuntimeBenchPerfTest                     | Populates member ``self.skl_info`` with additional information on the model such as the number of node for ...                |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`fct_filter_test <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.fct_filter_test>`                                                         | BenchPerf                                    | Tells if the test by *conf* is valid or not.                                                                                  |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`fcts <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.fcts>`                                                                           | BenchPerfTest                                | Returns the function call to test, it produces a dictionary ``{name: fct}`` where *name* is the name of ...                   |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`fcts <pymlbenchmark.external.onnxruntime_perf_binclass.OnnxRuntimeBenchPerfTestBinaryClassification.fcts>`                                  | OnnxRuntimeBenchPerfTestBinaryClassification | Returns a few functions, tests methods *perdict*, *predict_proba* for both :epkg:`scikit-learn` and :epkg:`OnnxInference` ... |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`fcts <pymlbenchmark.external.onnxruntime_perf_regression.OnnxRuntimeBenchPerfTestRegression.fcts>`                                          | OnnxRuntimeBenchPerfTestRegression           | Returns a few functions, tests methods *perdict*, *predict_proba* for both :epkg:`scikit-learn` and :epkg:`OnnxInference` ... |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`match <pymlbenchmark.benchmark.profiler_class.ProfilerCall.match>`                                                                          | ProfilerCall                                 | Tells if the profiler should be run on this set of parameters.                                                                |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`model_info <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.model_info>`                                                   | OnnxRuntimeBenchPerfTest                     | Returns additional informations about a model.                                                                                |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`profile <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.profile>`                                                                         | BenchPerf                                    | Checks if a profiler applies on this set of parameters, then profiles function *fct*.                                         |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`profile <pymlbenchmark.benchmark.profiler_class.ProfilerCall.profile>`                                                                      | ProfilerCall                                 | Profiles function *fct*, calls it *repeat* times.                                                                             |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`to_txt <pymlbenchmark.benchmark.profiler_class.ProfilerCall.to_txt>`                                                                        | ProfilerCall                                 | Saves all profiles into one file.                                                                                             |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`validate <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.validate>`                                                                   | BenchPerfTest                                | Runs validations after the test was done to make sure it was valid.                                                           |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :meth:`validate <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.validate>`                                                       | OnnxRuntimeBenchPerfTest                     | Checks that methods *predict* and *predict_proba* returns the same results for both :epkg:`scikit-learn` and ...              |
+----------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+