.. _f-validatehelper:

module ``onnxrt.validate.validate_helper``
==========================================





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


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

module ``mlprodict.onnxrt.validate.validate_helper``

Validates runtime for many :epkg:`scikit-learn` operators.
The submodule relies on :epkg:`onnxconverter_common`,
:epkg:`sklearn-onnx`.


:githublink:`%|py|7`




Classes
+++++++

+----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| class                                                                                              | truncated documentation                                              |
+====================================================================================================+======================================================================+
| :class:`RuntimeBadResultsError <mlprodict.onnxrt.validate.validate_helper.RuntimeBadResultsError>` | Raised when the results are too different from :epkg:`scikit-learn`. |
+----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+




Functions
+++++++++

+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| function                                                                                        | truncated documentation                                                                                             |
+=================================================================================================+=====================================================================================================================+
| :func:`_dictionary2str <mlprodict.onnxrt.validate.validate_helper._dictionary2str>`             |                                                                                                                     |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`_dispsimple <mlprodict.onnxrt.validate.validate_helper._dispsimple>`                     |                                                                                                                     |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`_get_problem_data <mlprodict.onnxrt.validate.validate_helper._get_problem_data>`         |                                                                                                                     |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`_measure_time <mlprodict.onnxrt.validate.validate_helper._measure_time>`                 | Measures the execution time for a function.                                                                         |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`_merge_options <mlprodict.onnxrt.validate.validate_helper._merge_options>`               |                                                                                                                     |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`_multiply_time_kwargs <mlprodict.onnxrt.validate.validate_helper._multiply_time_kwargs>` | Multiplies values in *time_kwargs* following strategy *time_kwargs_fact* for a given model *inst*.                  |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`_shape_exc <mlprodict.onnxrt.validate.validate_helper._shape_exc>`                       |                                                                                                                     |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`default_time_kwargs <mlprodict.onnxrt.validate.validate_helper.default_time_kwargs>`     | Returns default values *number* and *repeat* to measure the execution of a function.                                |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`dump_into_folder <mlprodict.onnxrt.validate.validate_helper.dump_into_folder>`           | Dumps information when an error was detected using :epkg:`*py:pickle`.                                              |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`measure_time <mlprodict.onnxrt.validate.validate_helper.measure_time>`                   | Measures a statement and returns the results as a dictionary.                                                       |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`modules_list <mlprodict.onnxrt.validate.validate_helper.modules_list>`                   | Returns modules and versions currently used.                                                                        |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`sklearn_operators <mlprodict.onnxrt.validate.validate_helper.sklearn_operators>`         | Builds the list of operators from :epkg:`scikit-learn`. The function goes through the list of submodule and get ... |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+








Methods
+++++++

+-------------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                          | truncated documentation |
+=================================================================================================+=========================+
| :py:meth:`__init__ <mlprodict.onnxrt.validate.validate_helper.RuntimeBadResultsError.__init__>` |                         |
+-------------------------------------------------------------------------------------------------+-------------------------+


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

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