.. _f-plottingbenchmark:

module ``plotting.plotting_benchmark``
======================================







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

module ``mlprodict.plotting.plotting_benchmark``

Useful plots.


:githublink:`%|py|5`






Functions
+++++++++

+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| function                                                                                      | truncated documentation                                                                                          |
+===============================================================================================+==================================================================================================================+
| :func:`annotate_heatmap <mlprodict.plotting.plotting_benchmark.annotate_heatmap>`             | Annotates a heatmap. See :func:`plot_benchmark_metrics` for an example.                                          |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :func:`heatmap <mlprodict.plotting.plotting_benchmark.heatmap>`                               | Creates a heatmap from a numpy array and two lists of labels. See :func:`plot_benchmark_metrics` for an example. |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :func:`plot_benchmark_metrics <mlprodict.plotting.plotting_benchmark.plot_benchmark_metrics>` | Plots a heatmap which represents a benchmark. See example below.                                                 |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+








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

.. automodule:: mlprodict.plotting.plotting_benchmark
    :members:
    :special-members: __init__
    :show-inheritance: