.. _f-utilsbackendpython:

module ``testing.test_utils.utils_backend_python``
==================================================





.. inheritance-diagram:: mlprodict.testing.test_utils.utils_backend_python


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

module ``mlprodict.testing.test_utils.utils_backend_python``

Inspired from sklearn-onnx, handles two backends.


:githublink:`%|py|5`




Classes
+++++++

+------------------------------------------------------------------------------------------------------------------+----------------------------------+
| class                                                                                                            | truncated documentation          |
+==================================================================================================================+==================================+
| :class:`MockVariableName <mlprodict.testing.test_utils.utils_backend_python.MockVariableName>`                   | A string.                        |
+------------------------------------------------------------------------------------------------------------------+----------------------------------+
| :class:`MockVariableNameShape <mlprodict.testing.test_utils.utils_backend_python.MockVariableNameShape>`         | A string and a shape.            |
+------------------------------------------------------------------------------------------------------------------+----------------------------------+
| :class:`MockVariableNameShapeType <mlprodict.testing.test_utils.utils_backend_python.MockVariableNameShapeType>` | A string and a shape and a type. |
+------------------------------------------------------------------------------------------------------------------+----------------------------------+
| :class:`OnnxInference2 <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2>`                       | onnxruntime API                  |
+------------------------------------------------------------------------------------------------------------------+----------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| function                                                                                    | truncated documentation                                                                                                    |
+=============================================================================================+============================================================================================================================+
| :func:`compare_runtime <mlprodict.testing.test_utils.utils_backend_python.compare_runtime>` | The function compares the expected output (computed with the model before being converted to ONNX) and the ONNX output ... |
+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| property                                                                                                                       | truncated documentation                                                                                         |
+================================================================================================================================+=================================================================================================================+
| :meth:`input_names <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.input_names>`                             | Returns the names of all inputs. It does not include the optional inputs.                                       |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`input_names_shapes <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.input_names_shapes>`               | Returns the names and shapes of all inputs. This method assumes all inputs are tensors. It does not include ... |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`input_names_shapes_types <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.input_names_shapes_types>`   | Returns the names, shapes, types of all inputs. This method assumes all inputs are tensors. It does not ...     |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`optional_inputs <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.optional_inputs>`                     | Returns the list of optional inputs (the model has an initalizer of the same name as one input).                |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`output_names <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.output_names>`                           | Returns the names of all outputs.                                                                               |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`output_names_shapes <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.output_names_shapes>`             | Returns the names and shapes of all outputs. This method assumes all inputs are tensors.                        |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`output_names_shapes_types <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.output_names_shapes_types>` | Returns the names, shapes, types of all outputs. This method assumes all inputs are tensors. It does not ...    |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`shape <mlprodict.testing.test_utils.utils_backend_python.MockVariableName.shape>`                                       | returns shape                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`shape <mlprodict.testing.test_utils.utils_backend_python.MockVariableNameShape.shape>`                                  | returns shape                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`shape <mlprodict.testing.test_utils.utils_backend_python.MockVariableNameShapeType.shape>`                              | returns shape                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`type <mlprodict.testing.test_utils.utils_backend_python.MockVariableName.type>`                                         | returns type                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`type <mlprodict.testing.test_utils.utils_backend_python.MockVariableNameShape.type>`                                    | returns type                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`type <mlprodict.testing.test_utils.utils_backend_python.MockVariableNameShapeType.type>`                                | returns type                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+------------------------------------------------------------------------------------------------------------+-----------------------------------+
| method                                                                                                     | truncated documentation           |
+============================================================================================================+===================================+
| :py:meth:`__init__ <mlprodict.testing.test_utils.utils_backend_python.MockVariableName.__init__>`          |                                   |
+------------------------------------------------------------------------------------------------------------+-----------------------------------+
| :py:meth:`__init__ <mlprodict.testing.test_utils.utils_backend_python.MockVariableNameShape.__init__>`     |                                   |
+------------------------------------------------------------------------------------------------------------+-----------------------------------+
| :py:meth:`__init__ <mlprodict.testing.test_utils.utils_backend_python.MockVariableNameShapeType.__init__>` |                                   |
+------------------------------------------------------------------------------------------------------------+-----------------------------------+
| :meth:`get_inputs <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.get_inputs>`           | onnxruntime API                   |
+------------------------------------------------------------------------------------------------------------+-----------------------------------+
| :meth:`get_outputs <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.get_outputs>`         | onnxruntime API                   |
+------------------------------------------------------------------------------------------------------------+-----------------------------------+
| :meth:`run <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.run>`                         | onnxruntime API                   |
+------------------------------------------------------------------------------------------------------------+-----------------------------------+
| :meth:`run_in_scan <mlprodict.testing.test_utils.utils_backend_python.OnnxInference2.run_in_scan>`         | Instance to run in operator scan. |
+------------------------------------------------------------------------------------------------------------+-----------------------------------+


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

.. automodule:: mlprodict.testing.test_utils.utils_backend_python
    :members:
    :special-members: __init__
    :show-inheritance: