.. _f-categoriestointegers:

module ``mlmodel.categories_to_integers``
=========================================





.. inheritance-diagram:: mlinsights.mlmodel.categories_to_integers


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

module ``mlinsights.mlmodel.categories_to_integers``

Implements a transformation which can be put in a pipeline to transform categories in
integers.


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                          | truncated documentation                                                                                                                                |
+================================================================================================+========================================================================================================================================================+
| :class:`CategoriesToIntegers <mlinsights.mlmodel.categories_to_integers.CategoriesToIntegers>` | Does something similar to what `DictVectorizer <http://scikit-learn.org/stable/modules/generated/sklearn.feature_extraction.DictVectorizer.html>`_ ... |
+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

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






Methods
+++++++

+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| method                                                                                                  | truncated documentation                                                                                         |
+=========================================================================================================+=================================================================================================================+
| :py:meth:`__init__ <mlinsights.mlmodel.categories_to_integers.CategoriesToIntegers.__init__>`           |                                                                                                                 |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <mlinsights.mlmodel.categories_to_integers.CategoriesToIntegers.__str__>`             | usual                                                                                                           |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :py:meth:`_build_schema <mlinsights.mlmodel.categories_to_integers.CategoriesToIntegers._build_schema>` | Concatenates all the categories given the information stored in *_categories*.                                  |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.mlmodel.categories_to_integers.CategoriesToIntegers.fit>`                        | Makes the list of all categories in input *X*. *X* must be a dataframe.                                         |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`fit_transform <mlinsights.mlmodel.categories_to_integers.CategoriesToIntegers.fit_transform>`    | Fits and transforms categories in numerical features based on the list of categories found by method *fit*. ... |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :meth:`transform <mlinsights.mlmodel.categories_to_integers.CategoriesToIntegers.transform>`            | Transforms categories in numerical features based on the list of categories found by method *fit*. *X* must ... |
+---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+


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

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