.. _f-benchmark: module ``benchhelper.benchmark`` ================================ .. inheritance-diagram:: pyquickhelper.benchhelper.benchmark Short summary +++++++++++++ module ``pyquickhelper.benchhelper.benchmark`` Helpers to benchmark something :githublink:`%|py|5` Classes +++++++ +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ | class | truncated documentation | +====================================================================+===========================================================================================+ | :class:`BenchMark ` | Class to help benchmarking. You should overwrite method *init*, *bench*, *end*, *graphs*. | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------+ Properties ++++++++++ +---------------------------------------------------------------------------+------------------------------------+ | property | truncated documentation | +===========================================================================+====================================+ | :meth:`Appendix ` | Returns the metrics. | +---------------------------------------------------------------------------+------------------------------------+ | :meth:`Graphs ` | Returns images of graphs. | +---------------------------------------------------------------------------+------------------------------------+ | :meth:`Metadata ` | Returns the metrics. | +---------------------------------------------------------------------------+------------------------------------+ | :meth:`Metrics ` | Returns the metrics. | +---------------------------------------------------------------------------+------------------------------------+ | :meth:`Name ` | Returns the name of the benchmark. | +---------------------------------------------------------------------------+------------------------------------+ Methods +++++++ +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | method | truncated documentation | +===============================================================================+========================================================================+ | :py:meth:`__init__ ` | | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :py:meth:`_convert ` | Converts a value knowing its column, its type into something readable. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`bench ` | Runs the benchmark. Overwrite this method. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`end ` | Cleans. Overwrites this method. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`fLOG ` | Logs something. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`graphs ` | Builds graphs after the benchmark was run. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`init ` | Initialisation. Overwrite this method. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`meta_to_df ` | Converts meta data into a dataframe | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`report ` | Produces a report. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`run ` | Runs the benchmark. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`to_df ` | Converts the metrics into a dataframe. | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ | :meth:`uncache ` | overwrite this method to uncache some previous run | +-------------------------------------------------------------------------------+------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.benchhelper.benchmark :members: :special-members: __init__ :show-inheritance: