.. _f-gridbenchmark:

module ``benchhelper.grid_benchmark``
=====================================





.. inheritance-diagram:: pyquickhelper.benchhelper.grid_benchmark


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

module ``pyquickhelper.benchhelper.grid_benchmark``

Grid benchmark.


:githublink:`%|py|6`




Classes
+++++++

+---------------------------------------------------------------------------------+-----------------------------------------------+
| class                                                                           | truncated documentation                       |
+=================================================================================+===============================================+
| :class:`GridBenchMark <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark>` | Compares a couple of machine learning models. |
+---------------------------------------------------------------------------------+-----------------------------------------------+






Properties
++++++++++

+------------------------------------------------------------------------------------+------------------------------------+
| property                                                                           | truncated documentation            |
+====================================================================================+====================================+
| :meth:`Appendix <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Appendix>` | Returns the metrics.               |
+------------------------------------------------------------------------------------+------------------------------------+
| :meth:`Graphs <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Graphs>`     | Returns images of graphs.          |
+------------------------------------------------------------------------------------+------------------------------------+
| :meth:`Metadata <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Metadata>` | Returns the metrics.               |
+------------------------------------------------------------------------------------+------------------------------------+
| :meth:`Metrics <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Metrics>`   | Returns the metrics.               |
+------------------------------------------------------------------------------------+------------------------------------+
| :meth:`Name <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.Name>`         | Returns the name of the benchmark. |
+------------------------------------------------------------------------------------+------------------------------------+






Methods
+++++++

+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| method                                                                                                             | truncated documentation                                                  |
+====================================================================================================================+==========================================================================+
| :py:meth:`__init__ <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.__init__>`                              |                                                                          |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| :meth:`bench <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.bench>`                                       | Runs an experiment multiple times, parameter *di* is the dataset to use. |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| :meth:`bench_experiment <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.bench_experiment>`                 | function to overload                                                     |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| :meth:`init <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.init>`                                         | Skips it.                                                                |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| :meth:`init_main <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.init_main>`                               | initialisation                                                           |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| :meth:`predict_score_experiment <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.predict_score_experiment>` | function to overload                                                     |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| :meth:`preprocess_dataset <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.preprocess_dataset>`             | Splits the dataset into train and test.                                  |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| :meth:`run <pyquickhelper.benchhelper.grid_benchmark.GridBenchMark.run>`                                           | Runs the benchmark.                                                      |
+--------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+


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

.. automodule:: pyquickhelper.benchhelper.grid_benchmark
    :members:
    :special-members: __init__
    :show-inheritance: