.. _f-onnxshapeinference:

module ``onnxrt.onnx_shape_inference``
======================================





.. inheritance-diagram:: mlprodict.onnxrt.onnx_shape_inference


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

module ``mlprodict.onnxrt.onnx_shape_inference``

Runtime to infer shapes.





Classes
+++++++

+----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| class                                                                                  | truncated documentation                                                                    |
+========================================================================================+============================================================================================+
| :class:`OnnxShapeInference <mlprodict.onnxrt.onnx_shape_inference.OnnxShapeInference>` | Implements a micro runtime for ONNX graphs. It does not implements all the operator types. |
+----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+






Properties
++++++++++

+----------------------------------------------------------------------------------------------+-------------------------+
| property                                                                                     | truncated documentation |
+==============================================================================================+=========================+
| :meth:`input_names <mlprodict.onnxrt.onnx_shape_inference.OnnxShapeInference.input_names>`   | Returns input names.    |
+----------------------------------------------------------------------------------------------+-------------------------+
| :meth:`output_names <mlprodict.onnxrt.onnx_shape_inference.OnnxShapeInference.output_names>` | Returns output names.   |
+----------------------------------------------------------------------------------------------+-------------------------+




Static Methods
++++++++++++++

+---------------------------------------------------------------------------------------------+-------------------------+
| staticmethod                                                                                | truncated documentation |
+=============================================================================================+=========================+
| :py:meth:`_get_shape <mlprodict.onnxrt.onnx_shape_inference.OnnxShapeInference._get_shape>` |                         |
+---------------------------------------------------------------------------------------------+-------------------------+




Methods
+++++++

+---------------------------------------------------------------------------------------------+---------------------------------------------------+
| method                                                                                      | truncated documentation                           |
+=============================================================================================+===================================================+
| :py:meth:`__init__ <mlprodict.onnxrt.onnx_shape_inference.OnnxShapeInference.__init__>`     |                                                   |
+---------------------------------------------------------------------------------------------+---------------------------------------------------+
| :py:meth:`__repr__ <mlprodict.onnxrt.onnx_shape_inference.OnnxShapeInference.__repr__>`     | Usual                                             |
+---------------------------------------------------------------------------------------------+---------------------------------------------------+
| :py:meth:`_run_empty <mlprodict.onnxrt.onnx_shape_inference.OnnxShapeInference._run_empty>` | Computes shape and types of all results.          |
+---------------------------------------------------------------------------------------------+---------------------------------------------------+
| :meth:`run <mlprodict.onnxrt.onnx_shape_inference.OnnxShapeInference.run>`                  | Runs shape inference and type given known inputs. |
+---------------------------------------------------------------------------------------------+---------------------------------------------------+


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

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