.. _f-profilerclass:

module ``benchmark.profiler_class``
===================================





.. inheritance-diagram:: pymlbenchmark.benchmark.profiler_class


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

module ``pymlbenchmark.benchmark.profiler_class``

Implements a benchmark about performance.


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| class                                                                       | truncated documentation                                                                                                   |
+=============================================================================+===========================================================================================================================+
| :class:`ProfilerCall <pymlbenchmark.benchmark.profiler_class.ProfilerCall>` | Runs a profiler on a specific call. It can use either :epkg:`pyinstrument`, either :epkg:`cProfile`. The first module ... |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
| method                                                                             | truncated documentation                                                     |
+====================================================================================+=============================================================================+
| :py:meth:`__init__ <pymlbenchmark.benchmark.profiler_class.ProfilerCall.__init__>` |                                                                             |
+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
| :py:meth:`__iter__ <pymlbenchmark.benchmark.profiler_class.ProfilerCall.__iter__>` | Iterates on stored profiled. Returns a couple ``(profile, configuration)``. |
+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
| :py:meth:`__len__ <pymlbenchmark.benchmark.profiler_class.ProfilerCall.__len__>`   | Returns the number of stored profiles.                                      |
+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
| :meth:`match <pymlbenchmark.benchmark.profiler_class.ProfilerCall.match>`          | Tells if the profiler should be run on this set of parameters.              |
+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
| :meth:`profile <pymlbenchmark.benchmark.profiler_class.ProfilerCall.profile>`      | Profiles function *fct*, calls it *repeat* times.                           |
+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
| :meth:`to_txt <pymlbenchmark.benchmark.profiler_class.ProfilerCall.to_txt>`        | Saves all profiles into one file.                                           |
+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+


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

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