.. _f-onnx2pyhelper:

module ``onnxrt.onnx2py_helper``
================================







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

module ``mlprodict.onnxrt.onnx2py_helper``

Functions which converts :epkg:`ONNX` object into
readable :epkg:`python` objects.


:githublink:`%|py|6`






Functions
+++++++++

+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                                                      | truncated documentation                                                                                               |
+===============================================================================+=======================================================================================================================+
| :func:`_elem_type_as_str <mlprodict.onnxrt.onnx2py_helper._elem_type_as_str>` |                                                                                                                       |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`_numpy_array <mlprodict.onnxrt.onnx2py_helper._numpy_array>`           | Single function to create an array.                                                                                   |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`_sparse_array <mlprodict.onnxrt.onnx2py_helper._sparse_array>`         | Single function to create an sparse array (:epkg:`coo_matrix`).                                                       |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`_to_array <mlprodict.onnxrt.onnx2py_helper._to_array>`                 |                                                                                                                       |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`_type_to_string <mlprodict.onnxrt.onnx2py_helper._type_to_string>`     | Converts a type into a readable string.                                                                               |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`_var_as_dict <mlprodict.onnxrt.onnx2py_helper._var_as_dict>`           | Converts a protobuf object into something readable. The current implementation relies on :epkg:`json`. That's not ... |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`from_bytes <mlprodict.onnxrt.onnx2py_helper.from_bytes>`               | Retrieves an array from bytes then protobuf.                                                                          |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`guess_proto_dtype <mlprodict.onnxrt.onnx2py_helper.guess_proto_dtype>` | Guesses the ONNX dtype given a numpy dtype.                                                                           |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`numpy_max <mlprodict.onnxrt.onnx2py_helper.numpy_max>`                 | Returns the maximum of an array. Deals with text as well.                                                             |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`numpy_min <mlprodict.onnxrt.onnx2py_helper.numpy_min>`                 | Returns the minimum of an array. Deals with text as well.                                                             |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`to_bytes <mlprodict.onnxrt.onnx2py_helper.to_bytes>`                   | Converts an array into protobuf and then into bytes.                                                                  |
+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+








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

.. automodule:: mlprodict.onnxrt.onnx2py_helper
    :members:
    :special-members: __init__
    :show-inheritance: