.. _f-einsumimpl:

module ``testing.einsum.einsum_impl``
=====================================







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

module ``mlprodict.testing.einsum.einsum_impl``

Main functions decomposing einsum computation into
more simple functions.


:githublink:`%|py|6`






Functions
+++++++++

+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                           | truncated documentation                                                                                                                         |
+====================================================================================================================+=================================================================================================================================================+
| :func:`_apply_einsum_matmul <mlprodict.testing.einsum.einsum_impl._apply_einsum_matmul>`                           | Decomposes the generic matrix multiplication into numpy operations depending on the operator to use for matrix multiplication ...               |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_apply_squeeze_transpose <mlprodict.testing.einsum.einsum_impl._apply_squeeze_transpose>`                   | Puts output dimension in the expected order.                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_apply_transpose_reshape <mlprodict.testing.einsum.einsum_impl._apply_transpose_reshape>`                   | Put all dimensions in the same order.                                                                                                           |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_basic_verification <mlprodict.testing.einsum.einsum_impl._basic_verification>`                             |                                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_decompose_einsum_equation_simple <mlprodict.testing.einsum.einsum_impl._decompose_einsum_equation_simple>` | Applies strategy `simple`, `numpy` defined in by function :func:`decompose_einsum_equation`.                                                    |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`analyse_einsum_equation <mlprodict.testing.einsum.einsum_impl.analyse_einsum_equation>`                     | Analyses an einsum equation.                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`apply_einsum_sequence <mlprodict.testing.einsum.einsum_impl.apply_einsum_sequence>`                         | Applies a sequence of operations on a list of inputs. The sequence of operations is produced by function :func:`decompose_einsum_equation`. ... |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`decompose_einsum_equation <mlprodict.testing.einsum.einsum_impl.decompose_einsum_equation>`                 | Decomposes an equation used in :epkg:`numpy:einsum` knowing the input shapes. It returns a sequence of operations ...                           |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`is_transpose_identity <mlprodict.testing.einsum.einsum_impl.is_transpose_identity>`                         | Tells if the permutation *perm* does nothing (itentity).                                                                                        |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+








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

.. automodule:: mlprodict.testing.einsum.einsum_impl
    :members:
    :special-members: __init__
    :show-inheritance: