.. _f-modelinfo:

module ``tools.model_info``
===========================







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

module ``mlprodict.tools.model_info``

Functions to help get more information about the models.


:githublink:`%|py|5`






Functions
+++++++++

+------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| function                                                               | truncated documentation                                                          |
+========================================================================+==================================================================================+
| :func:`_analyse_tree <mlprodict.tools.model_info._analyse_tree>`       | Extract information from a tree.                                                 |
+------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :func:`_analyse_tree_h <mlprodict.tools.model_info._analyse_tree_h>`   | Extract information from a tree in a HistGradientBoosting.                       |
+------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :func:`_get_info_lgb <mlprodict.tools.model_info._get_info_lgb>`       | Get informations from and :epkg:`lightgbm` trees.                                |
+------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :func:`_get_info_xgb <mlprodict.tools.model_info._get_info_xgb>`       | Get informations from and :epkg:`lightgbm` trees.                                |
+------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :func:`_reduce_infos <mlprodict.tools.model_info._reduce_infos>`       | Produces agregates features.                                                     |
+------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :func:`analyze_model <mlprodict.tools.model_info.analyze_model>`       | Returns informations, statistics about a model, its number of nodes, its size... |
+------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :func:`enumerate_models <mlprodict.tools.model_info.enumerate_models>` | Enumerates models with models.                                                   |
+------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| :func:`set_random_state <mlprodict.tools.model_info.set_random_state>` | Sets all possible parameter *random_state* to 0.                                 |
+------------------------------------------------------------------------+----------------------------------------------------------------------------------+








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

.. automodule:: mlprodict.tools.model_info
    :members:
    :special-members: __init__
    :show-inheritance: