.. _f-anmfpredictor:

module ``mlmodel.anmf_predictor``
=================================





.. inheritance-diagram:: mlinsights.mlmodel.anmf_predictor


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

module ``mlinsights.mlmodel.anmf_predictor``

Featurizers for machine learned models.


:githublink:`%|py|5`




Classes
+++++++

+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| class                                                                                        | truncated documentation                                                                                               |
+==============================================================================================+=======================================================================================================================+
| :class:`ApproximateNMFPredictor <mlinsights.mlmodel.anmf_predictor.ApproximateNMFPredictor>` | Converts :epkg:`sklearn:decomposition:NMF` into a predictor so that the prediction does not involve training even ... |
+----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| property                                                                                       | truncated documentation                                                                                          |
+================================================================================================+==================================================================================================================+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.anmf_predictor.ApproximateNMFPredictor._repr_html_>` | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... |
+------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+




Static Methods
++++++++++++++

+----------------------------------------------------------------------------------------------------------+--------------------------------------------------+
| staticmethod                                                                                             | truncated documentation                          |
+==========================================================================================================+==================================================+
| :py:meth:`_get_param_names <mlinsights.mlmodel.anmf_predictor.ApproximateNMFPredictor._get_param_names>` | Returns the list of parameters of the estimator. |
+----------------------------------------------------------------------------------------------------------+--------------------------------------------------+




Methods
+++++++

+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| method                                                                                    | truncated documentation                                                                                       |
+===========================================================================================+===============================================================================================================+
| :py:meth:`__init__ <mlinsights.mlmodel.anmf_predictor.ApproximateNMFPredictor.__init__>`  | *kwargs* should contains parameters for :epkg:`sklearn:decomposition:NMF`. The parameter *force_positive* ... |
+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.mlmodel.anmf_predictor.ApproximateNMFPredictor.fit>`               | Trains a :epkg:`sklearn:decomposition:NMF` then a multi-output regressor.                                     |
+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_params <mlinsights.mlmodel.anmf_predictor.ApproximateNMFPredictor.get_params>` | Returns the parameters of the estimator as a dictionary.                                                      |
+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`predict <mlinsights.mlmodel.anmf_predictor.ApproximateNMFPredictor.predict>`       | Predicts based on the multi-output regressor. The output has the same dimension as *X*.                       |
+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+


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

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