.. _f-benchmarkperf:

module ``benchmark.benchmark_perf``
===================================





.. inheritance-diagram:: pymlbenchmark.benchmark.benchmark_perf


Short summary
+++++++++++++

module ``pymlbenchmark.benchmark.benchmark_perf``

Implements a benchmark about performance.


:githublink:`%|py|5`




Classes
+++++++

+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| class                                                                         | truncated documentation                                                              |
+===============================================================================+======================================================================================+
| :class:`BenchPerf <pymlbenchmark.benchmark.benchmark_perf.BenchPerf>`         | Factorizes code to compare two implementations. See example :ref:`l-bench-slk-poly`. |
+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+
| :class:`BenchPerfTest <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest>` | Defines a bench perf test. See example :ref:`l-bench-slk-poly`.                      |
+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+










Methods
+++++++

+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| method                                                                                               | truncated documentation                                                                                                    |
+======================================================================================================+============================================================================================================================+
| :py:meth:`__init__ <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.__init__>`                      |                                                                                                                            |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.__init__>`                  |                                                                                                                            |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.__repr__>`                      | usual                                                                                                                      |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`data <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.data>`                             | Generates one testing dataset.                                                                                             |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`dump_error <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.dump_error>`                 | 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>` | Runs the benchmark.                                                                                                        |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_tests <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.enumerate_tests>`           | Enumerates all possible options.                                                                                           |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`fct_filter_test <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.fct_filter_test>`           | Tells if the test by *conf* is valid or not.                                                                               |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`fcts <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.fcts>`                             | Returns the function call to test, it produces a dictionary ``{name: fct}`` where *name* is the name of ...                |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`profile <pymlbenchmark.benchmark.benchmark_perf.BenchPerf.profile>`                           | Checks if a profiler applies on this set of parameters, then profiles function *fct*.                                      |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`validate <pymlbenchmark.benchmark.benchmark_perf.BenchPerfTest.validate>`                     | Runs validations after the test was done to make sure it was valid.                                                        |
+------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pymlbenchmark.benchmark.benchmark_perf
    :members:
    :special-members: __init__
    :show-inheritance: