.. _l-functions:

Functions
=========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                                                                                     | class parent | truncated documentation                                                                                               |
+==============================================================================================================+==============+=======================================================================================================================+
| :func:`_setup_hook <jupytalk._setup_hook>`                                                                   |              | if this function is added to the module, the help automation and unit tests call it first before anything goes on ... |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`check <jupytalk.check>`                                                                               |              | Checks the library is working. It raises an exception. If you want to disable the logs:                               |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`display_treant <jupytalk.talk_examples.treant_wrapper.display_treant>`                                |              | Display a chart using `treant-js <http://fperucic.github.io/treant-js/>`_.                                            |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`edges2asciitree <jupytalk.talk_examples.sklearn2019.edges2asciitree>`                                 |              | Converts a set of edges into a combination of :epkg:`OrderedDict` which can be understood by :epkg:`asciitree`. ...   |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`example_cartopy <jupytalk.talk_examples.pydata2016.example_cartopy>`                                  |              | Draws a map of France with :epkg:`cartopy`.                                                                           |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`example_confidence_interval <jupytalk.talk_examples.pydata2016.example_confidence_interval>`          |              | Draws pseudo confidence interval for a regression in a :epkg:`matplotlib` graph.                                      |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`example_networkx <jupytalk.talk_examples.pydata2016.example_networkx>`                                |              | Example using :epkg:`networkx`.                                                                                       |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`example_pydy <jupytalk.talk_examples.pydata2016.example_pydy>`                                        |              | Example from the documentation of :epkg:`pydy`.                                                                       |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`graph_persistence_onnx <jupytalk.talk_examples.sklearn2019.graph_persistence_onnx>`                   |              | See :ref:`onnxsklearnconsortiumrst`.                                                                                  |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`graph_persistence_pickle <jupytalk.talk_examples.sklearn2019.graph_persistence_pickle>`               |              | See :ref:`onnxsklearnconsortiumrst`.                                                                                  |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`graph_persistence_pickle_issues <jupytalk.talk_examples.sklearn2019.graph_persistence_pickle_issues>` |              | See :ref:`onnxsklearnconsortiumrst`.                                                                                  |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`graph_three_components <jupytalk.talk_examples.sklearn2019.graph_three_components>`                   |              | See :ref:`onnxsklearnconsortiumrst`.                                                                                  |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`make_dataframe <jupytalk.benchmark.mlprediction.make_dataframe>`                                      |              | Builds a dataframe from multiple arrays.                                                                              |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`onnx2dotnb <jupytalk.talk_examples.sklearn2019.onnx2dotnb>`                                           |              | Converts an ONNX graph into dot then into :epkg:`RenderJsDot`. See :ref:`onnxsklearnconsortiumrst`.                   |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`onnx2graph <jupytalk.talk_examples.sklearn2019.onnx2graph>`                                           |              | Converts an :epkg:`ONNX` model into a readable graph.                                                                 |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`onnx2str <jupytalk.talk_examples.sklearn2019.onnx2str>`                                               |              | Displays the beginning of an ONNX graph. See :ref:`onnxsklearnconsortiumrst`.                                         |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`onnxdocstring2html <jupytalk.talk_examples.sklearn2019.onnxdocstring2html>`                           |              | Converts the ONNX documentation into rst.                                                                             |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`profile_fct_graph <jupytalk.talk_examples.sklearn2019.profile_fct_graph>`                             |              | Returns a graph which profiles the execution of function *fct*. See :ref:`onnxsklearnconsortiumrst`.                  |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`rename_input_output <jupytalk.talk_examples.sklearn2019.rename_input_output>`                         |              | Renames all input and output of an ONNX file.                                                                         |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`show_images <jupytalk.pres_helper.image.show_images>`                                                 |              | Uses :epkg:`matplotlib` to show images.                                                                               |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`timeexec <jupytalk.benchmark.mlprediction.timeexec>`                                                  |              | Measures the time for a given expression.                                                                             |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`unit <jupytalk.benchmark.mlprediction.unit>`                                                          |              | Optimizes the rendering of time.                                                                                      |
+--------------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+