.. _f-validatesummary:

module ``onnxrt.validate.validate_summary``
===========================================





.. inheritance-diagram:: mlprodict.onnxrt.validate.validate_summary


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

module ``mlprodict.onnxrt.validate.validate_summary``

Summarizes results produces by function in *validate.py*.


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------------------------+-------------------------+
| class                                                                       | truncated documentation |
+=============================================================================+=========================+
| :class:`_MyEncoder <mlprodict.onnxrt.validate.validate_summary._MyEncoder>` |                         |
+-----------------------------------------------------------------------------+-------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| function                                                                                             | truncated documentation                                                                           |
+======================================================================================================+===================================================================================================+
| :func:`_clean_values_optim <mlprodict.onnxrt.validate.validate_summary._clean_values_optim>`         |                                                                                                   |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| :func:`_jsonify <mlprodict.onnxrt.validate.validate_summary._jsonify>`                               |                                                                                                   |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| :func:`_summary_report_indices <mlprodict.onnxrt.validate.validate_summary._summary_report_indices>` |                                                                                                   |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| :func:`merge_benchmark <mlprodict.onnxrt.validate.validate_summary.merge_benchmark>`                 | Merges several benchmarks run with command line :ref:`validate_runtime <l-cmd-validate_runtime>`. |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| :func:`summary_report <mlprodict.onnxrt.validate.validate_summary.summary_report>`                   | Finalizes the results computed by function :func:`enumerate_validated_operator_opsets`.           |
+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+








Methods
+++++++

+---------------------------------------------------------------------------------+-------------------------+
| method                                                                          | truncated documentation |
+=================================================================================+=========================+
| :meth:`default <mlprodict.onnxrt.validate.validate_summary._MyEncoder.default>` |                         |
+---------------------------------------------------------------------------------+-------------------------+


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

.. automodule:: mlprodict.onnxrt.validate.validate_summary
    :members:
    :special-members: __init__
    :show-inheritance: