.. _f-onnxruntimeperf:

module ``external.onnxruntime_perf``
====================================





.. inheritance-diagram:: pymlbenchmark.external.onnxruntime_perf


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

module ``pymlbenchmark.external.onnxruntime_perf``

Implements a benchmark about performance for :epkg:`onnxruntime`


:githublink:`%|py|5`




Classes
+++++++

+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                | truncated documentation                                                                                                |
+======================================================================================================+========================================================================================================================+
| :class:`OnnxRuntimeBenchPerfTest <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest>` | Specific test to compare computing time predictions with :epkg:`scikit-learn` and :epkg:`onnxruntime`. See example ... |
+------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| method                                                                                                                     | truncated documentation                                                                                          |
+============================================================================================================================+==================================================================================================================+
| :py:meth:`__init__ <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.__init__>`                            |                                                                                                                  |
+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_random_dataset <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest._get_random_dataset>`      | Returns a random datasets.                                                                                       |
+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_init <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest._init>`                                  | Finalizes the init.                                                                                              |
+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`data <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.data>`                                       | Generates random features.                                                                                       |
+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`extract_model_info_onnx <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.extract_model_info_onnx>` | Populates member ``self.onnx_info`` with additional information on the :epkg:`ONNX` graph.                       |
+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`extract_model_info_skl <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.extract_model_info_skl>`   | Populates member ``self.skl_info`` with additional information on the model such as the number of node for ...   |
+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`model_info <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.model_info>`                           | Returns additional informations about a model.                                                                   |
+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`validate <pymlbenchmark.external.onnxruntime_perf.OnnxRuntimeBenchPerfTest.validate>`                               | Checks that methods *predict* and *predict_proba* returns the same results for both :epkg:`scikit-learn` and ... |
+----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+


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

.. automodule:: pymlbenchmark.external.onnxruntime_perf
    :members:
    :special-members: __init__
    :show-inheritance: