.. _f-sklearnhelper:

module ``onnx_tools.optim.sklearn_helper``
==========================================







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

module ``mlprodict.onnx_tools.optim.sklearn_helper``

Helpers to manipulate :epkg:`scikit-learn` models.


:githublink:`%|py|5`






Functions
+++++++++

+---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| function                                                                                                | truncated documentation                                                                                             |
+=========================================================================================================+=====================================================================================================================+
| :func:`enumerate_fitted_arrays <mlprodict.onnx_tools.optim.sklearn_helper.enumerate_fitted_arrays>`     | Enumerate all fitted arrays included in a :epkg:`scikit-learn` object.                                              |
+---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_pipeline_models <mlprodict.onnx_tools.optim.sklearn_helper.enumerate_pipeline_models>` | Enumerates all the models within a pipeline.                                                                        |
+---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`inspect_sklearn_model <mlprodict.onnx_tools.optim.sklearn_helper.inspect_sklearn_model>`         | Inspects a :epkg:`scikit-learn` model and produces some figures which tries to represent the complexity of it.      |
+---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`max_depth <mlprodict.onnx_tools.optim.sklearn_helper.max_depth>`                                 | Retrieves the max depth assuming the estimator is a decision tree.                                                  |
+---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`pairwise_array_distances <mlprodict.onnx_tools.optim.sklearn_helper.pairwise_array_distances>`   | Computes pairwise distances between two lists of arrays *l1* and *l2*. The distance is 1e9 if shapes are not equal. |
+---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :func:`set_n_jobs <mlprodict.onnx_tools.optim.sklearn_helper.set_n_jobs>`                               | Looks into model signature and add parameter *n_jobs* if available. The function does not overwrite the parameter.  |
+---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+








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

.. automodule:: mlprodict.onnx_tools.optim.sklearn_helper
    :members:
    :special-members: __init__
    :show-inheritance: