.. _f-sklearnexampleclassifier:

module ``mltricks.sklearn_example_classifier``
==============================================





.. inheritance-diagram:: papierstat.mltricks.sklearn_example_classifier


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

module ``papierstat.mltricks.sklearn_example_classifier``

Defines :class:`SkCustomKnn`


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| class                                                                             | truncated documentation                                                                                            |
+===================================================================================+====================================================================================================================+
| :class:`SkCustomKnn <papierstat.mltricks.sklearn_example_classifier.SkCustomKnn>` | Implements the `k-Nearest Neighbors <http://en.wikipedia.org/ wiki/K-nearest_neighbors_algorithm>`_ as an example. |
+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                   | truncated documentation                                                                                                                       |
+==========================================================================================================+===============================================================================================================================================+
| :py:meth:`__init__ <papierstat.mltricks.sklearn_example_classifier.SkCustomKnn.__init__>`                | constructor                                                                                                                                   |
+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`decision_function <papierstat.mltricks.sklearn_example_classifier.SkCustomKnn.decision_function>` | Computes the output of the model in case of a regressor, matrix with a score for each class and each sample ...                               |
+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`distance2weight <papierstat.mltricks.sklearn_example_classifier.SkCustomKnn.distance2weight>`     | Converts a distance to weight.                                                                                                                |
+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`fit <papierstat.mltricks.sklearn_example_classifier.SkCustomKnn.fit>`                             | Train a k-NN model. There is not much to do except storing the training examples.                                                             |
+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`knn_search <papierstat.mltricks.sklearn_example_classifier.SkCustomKnn.knn_search>`               | Finds the *k* nearest neighbors for x.                                                                                                        |
+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`predict <papierstat.mltricks.sklearn_example_classifier.SkCustomKnn.predict>`                     | Predicts, usually, it calls the :meth:`decision_function <papierstat.mltricks.sklearn_example_classifier. SkCustomKnn.decision_function>` ... |
+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+


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

.. automodule:: papierstat.mltricks.sklearn_example_classifier
    :members:
    :special-members: __init__
    :show-inheritance: