.. _f-pipeline:

module ``helpers.pipeline``
===========================





.. inheritance-diagram:: mlinsights.helpers.pipeline


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

module ``mlinsights.helpers.pipeline``

Dig into pipelines.


:githublink:`%|py|0`




Classes
+++++++

+----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                              | truncated documentation                                                                                                           |
+====================================================================================================+===================================================================================================================================+
| :class:`BaseEstimatorDebugInformation <mlinsights.helpers.pipeline.BaseEstimatorDebugInformation>` | Stores information when the outputs of a pipeline is computed. It as added by function @see fct alter_pipeline_for_debugging. ... |
+----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| function                                                                                        | truncated documentation                                                                                                     |
+=================================================================================================+=============================================================================================================================+
| :func:`alter_pipeline_for_debugging <mlinsights.helpers.pipeline.alter_pipeline_for_debugging>` | Overwrite methods *transform*, *predict*, *predict_proba* or *decision_function* to collect the last inputs and outputs ... |
+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_pipeline_models <mlinsights.helpers.pipeline.enumerate_pipeline_models>`       | Enumerates all the models within a pipeline.                                                                                |
+-------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+








Methods
+++++++

+------------------------------------------------------------------------------------------+--------------------------------------+
| method                                                                                   | truncated documentation              |
+==========================================================================================+======================================+
| :py:meth:`__init__ <mlinsights.helpers.pipeline.BaseEstimatorDebugInformation.__init__>` |                                      |
+------------------------------------------------------------------------------------------+--------------------------------------+
| :py:meth:`__repr__ <mlinsights.helpers.pipeline.BaseEstimatorDebugInformation.__repr__>` | usual                                |
+------------------------------------------------------------------------------------------+--------------------------------------+
| :meth:`display <mlinsights.helpers.pipeline.BaseEstimatorDebugInformation.display>`      | Displays the first                   |
+------------------------------------------------------------------------------------------+--------------------------------------+
| :meth:`to_str <mlinsights.helpers.pipeline.BaseEstimatorDebugInformation.to_str>`        | Tries to produce a readable message. |
+------------------------------------------------------------------------------------------+--------------------------------------+


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

.. automodule:: mlinsights.helpers.pipeline
    :members:
    :special-members: __init__
    :show-inheritance: