.. _f-shapecontainer:

module ``onnxrt.ops_shape.shape_container``
===========================================





.. inheritance-diagram:: mlprodict.onnxrt.ops_shape.shape_container


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

module ``mlprodict.onnxrt.ops_shape.shape_container``

Class ShapeContainer


:githublink:`%|py|5`




Classes
+++++++

+-------------------------------------------------------------------------------------+----------------------------------------------------------------+
| class                                                                               | truncated documentation                                        |
+=====================================================================================+================================================================+
| :class:`ShapeContainer <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer>` | Stores all infered shapes as :class:`ShapeResult`. Attributes: |
+-------------------------------------------------------------------------------------+----------------------------------------------------------------+










Methods
+++++++

+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| method                                                                                                      | truncated documentation                                                                      |
+=============================================================================================================+==============================================================================================+
| :py:meth:`__contains__ <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.__contains__>`            | Operator in.                                                                                 |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :py:meth:`__getitem__ <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.__getitem__>`              | Retrieves one shape from its name.                                                           |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.__init__>`                    |                                                                                              |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.__len__>`                      | usual                                                                                        |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.__repr__>`                    | usual                                                                                        |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.__str__>`                      | Displays.                                                                                    |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :meth:`copy <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.copy>`                               | Makes a copy.                                                                                |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :meth:`get <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.get>`                                 | Returns the value of attribute `resolved_` (method `resolve()` must have been called first). |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :meth:`get_all_constraints <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.get_all_constraints>` | Gathers all constraints.                                                                     |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :meth:`get_new_name <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.get_new_name>`               | Returns a variable name when a dimension is not specified.                                   |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :meth:`resolve <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.resolve>`                         | Resolves all constraints. It adds the attribute `resolved_`.                                 |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :meth:`update <mlprodict.onnxrt.ops_shape.shape_container.ShapeContainer.update>`                           | Updates one shape. Returns True if the shape was different.                                  |
+-------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+


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

.. automodule:: mlprodict.onnxrt.ops_shape.shape_container
    :members:
    :special-members: __init__
    :show-inheritance: