.. _f-pipelinecache:

module ``mlbatch.pipeline_cache``
=================================





.. inheritance-diagram:: mlinsights.mlbatch.pipeline_cache


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

module ``mlinsights.mlbatch.pipeline_cache``

Caches training.


:githublink:`%|py|5`




Classes
+++++++

+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| class                                                                    | truncated documentation                                                                                             |
+==========================================================================+=====================================================================================================================+
| :class:`PipelineCache <mlinsights.mlbatch.pipeline_cache.PipelineCache>` | Same as :epkg:`sklearn:pipeline:Pipeline` but it can skip training if it detects a step was already trained the ... |
+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------+---------------------------------------------------------+
| function                                                      | truncated documentation                                 |
+===============================================================+=========================================================+
| :func:`isskl023 <mlinsights.mlbatch.pipeline_cache.isskl023>` | Tells if :epkg:`scikit-learn` is more recent than 0.23. |
+---------------------------------------------------------------+---------------------------------------------------------+




Properties
++++++++++

+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| property                                                                                       | truncated documentation                                                                                          |
+================================================================================================+==================================================================================================================+
| :py:meth:`_estimator_type <mlinsights.mlbatch.pipeline_cache.PipelineCache._estimator_type>`   |                                                                                                                  |
+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_final_estimator <mlinsights.mlbatch.pipeline_cache.PipelineCache._final_estimator>` |                                                                                                                  |
+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlbatch.pipeline_cache.PipelineCache._repr_html_>`           | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... |
+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`classes_ <mlinsights.mlbatch.pipeline_cache.PipelineCache.classes_>`                    | The classes labels. Only exist if the last step is a classifier.                                                 |
+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`feature_names_in_ <mlinsights.mlbatch.pipeline_cache.PipelineCache.feature_names_in_>`  | Names of features seen during first step `fit` method.                                                           |
+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`n_features_in_ <mlinsights.mlbatch.pipeline_cache.PipelineCache.n_features_in_>`        | Number of features seen during first step `fit` method.                                                          |
+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`named_steps <mlinsights.mlbatch.pipeline_cache.PipelineCache.named_steps>`              | Access the steps by name. Read-only attribute to access any step by given name. Keys are steps names and ...     |
+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+----------------------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                                   | truncated documentation |
+==========================================================================================================+=========================+
| :py:meth:`__init__ <mlinsights.mlbatch.pipeline_cache.PipelineCache.__init__>`                           |                         |
+----------------------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_fit <mlinsights.mlbatch.pipeline_cache.PipelineCache._fit>`                                   |                         |
+----------------------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_get_fit_params_steps <mlinsights.mlbatch.pipeline_cache.PipelineCache._get_fit_params_steps>` |                         |
+----------------------------------------------------------------------------------------------------------+-------------------------+


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

.. automodule:: mlinsights.mlbatch.pipeline_cache
    :members:
    :special-members: __init__
    :show-inheritance: