.. _f-nbhelper:

module ``nb_helper``
====================





.. inheritance-diagram:: mlprodict.nb_helper


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

module ``mlprodict.nb_helper``

Helpers for notebooks.


:githublink:`%|py|5`




Classes
+++++++

+----------------------------------------------------------+-----------------------------------------------+
| class                                                    | truncated documentation                       |
+==========================================================+===============================================+
| :class:`OnnxNotebook <mlprodict.nb_helper.OnnxNotebook>` | Defines magic commands to help with notebooks |
+----------------------------------------------------------+-----------------------------------------------+




Functions
+++++++++

+-------------------------------------------------------------------------+----------------------------------------------------------+
| function                                                                | truncated documentation                                  |
+=========================================================================+==========================================================+
| :func:`onnxview <mlprodict.nb_helper.onnxview>`                         | Displays an :epkg:`ONNX` graph into a notebook.          |
+-------------------------------------------------------------------------+----------------------------------------------------------+
| :func:`register_onnx_magics <mlprodict.nb_helper.register_onnx_magics>` | Register magics function, can be called from a notebook. |
+-------------------------------------------------------------------------+----------------------------------------------------------+




Properties
++++++++++

+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| property                                                                               | truncated documentation                                                                                       |
+========================================================================================+===============================================================================================================+
| :meth:`Context <mlprodict.nb_helper.OnnxNotebook.Context>`                             | return the context or None                                                                                    |
+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <mlprodict.nb_helper.OnnxNotebook.cross_validation_lock>` | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ... |
+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+--------------------------------------------------------------+-------------------------------------------------------------+
| method                                                       | truncated documentation                                     |
+==============================================================+=============================================================+
| :meth:`onnxview <mlprodict.nb_helper.OnnxNotebook.onnxview>` | Defines ``%onnxview`` which displays an :epkg:`ONNX` graph. |
+--------------------------------------------------------------+-------------------------------------------------------------+


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

.. automodule:: mlprodict.nb_helper
    :members:
    :special-members: __init__
    :show-inheritance: