.. _f-xopauto:

module ``npy.xop_auto``
=======================







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

module ``mlprodict.npy.xop_auto``

Automates the generation of operators for the
documentation for the Xop API.







Functions
+++++++++

+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                         | truncated documentation                                                                                                   |
+==================================================================================================================+===========================================================================================================================+
| :func:`_get_all_schemas_with_history <mlprodict.npy.xop_auto._get_all_schemas_with_history>`                     |                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`_get_doc_template <mlprodict.npy.xop_auto._get_doc_template>`                                             |                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`_insert_diff <mlprodict.npy.xop_auto._insert_diff>`                                                       | Splits a using `split`, insert HTML differences between pieces. The function relies on package :epkg:`pyquickhelper`. ... |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`_populate__get_all_schemas_with_history <mlprodict.npy.xop_auto._populate__get_all_schemas_with_history>` |                                                                                                                           |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`change_style <mlprodict.npy.xop_auto.change_style>`                                                       | Switches from *AaBb* into *aa_bb*.                                                                                        |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`get_domain_list <mlprodict.npy.xop_auto.get_domain_list>`                                                 | Returns the list of available domains.                                                                                    |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`get_onnx_example <mlprodict.npy.xop_auto.get_onnx_example>`                                               | Retrieves examples associated to one operator stored in onnx packages.                                                    |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`get_operator_schemas <mlprodict.npy.xop_auto.get_operator_schemas>`                                       | Returns all schemas mapped to an operator name.                                                                           |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`get_rst_doc <mlprodict.npy.xop_auto.get_rst_doc>`                                                         | Returns a documentation in RST format for all :class:`OnnxOperator`.                                                      |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`is_last_schema <mlprodict.npy.xop_auto.is_last_schema>`                                                   | Tells if this is the most recent schema for this operator.                                                                |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :func:`onnx_documentation_folder <mlprodict.npy.xop_auto.onnx_documentation_folder>`                             | Creates documentation in a folder for all known ONNX operators or a subset.                                               |
+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+








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

.. automodule:: mlprodict.npy.xop_auto
    :members:
    :special-members: __init__
    :show-inheritance: