.. _f-sklearntesting:

module ``mlmodel.sklearn_testing``
==================================







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

module ``mlinsights.mlmodel.sklearn_testing``

Helpers to test a model which follows :epkg:`scikit-learn` API.


:githublink:`%|py|5`






Functions
+++++++++

+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| function                                                                                               | truncated documentation                                                                                    |
+========================================================================================================+============================================================================================================+
| :func:`_assert_dict_equal <mlinsights.mlmodel.sklearn_testing._assert_dict_equal>`                     |                                                                                                            |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`_assert_list_equal <mlinsights.mlmodel.sklearn_testing._assert_list_equal>`                     |                                                                                                            |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`_assert_tuple_equal <mlinsights.mlmodel.sklearn_testing._assert_tuple_equal>`                   |                                                                                                            |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`_get_test_instance <mlinsights.mlmodel.sklearn_testing._get_test_instance>`                     |                                                                                                            |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`assert_estimator_equal <mlinsights.mlmodel.sklearn_testing.assert_estimator_equal>`             | Checks that two models are equal.                                                                          |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`clone_with_fitted_parameters <mlinsights.mlmodel.sklearn_testing.clone_with_fitted_parameters>` | Clones an estimator with the fitted results.                                                               |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`test_sklearn_clone <mlinsights.mlmodel.sklearn_testing.test_sklearn_clone>`                     | Tests that a cloned model is similar to the original one.                                                  |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`test_sklearn_grid_search_cv <mlinsights.mlmodel.sklearn_testing.test_sklearn_grid_search_cv>`   | Creates a model, checks that a grid search works with it.                                                  |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`test_sklearn_pickle <mlinsights.mlmodel.sklearn_testing.test_sklearn_pickle>`                   | Creates a model, fit, predict and check the prediction are similar after the model was pickled, unpickled. |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :func:`train_test_split_with_none <mlinsights.mlmodel.sklearn_testing.train_test_split_with_none>`     | Splits into train and test data even if they are None.                                                     |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+








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

.. automodule:: mlinsights.mlmodel.sklearn_testing
    :members:
    :special-members: __init__
    :show-inheritance: