.. _f-searchenginepredictions:

module ``search_rank.search_engine_predictions``
================================================





.. inheritance-diagram:: mlinsights.search_rank.search_engine_predictions


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

module ``mlinsights.search_rank.search_engine_predictions``

Implements a way to get close examples based
on the output of a machine learned model.


:githublink:`%|py|6`




Classes
+++++++

+-------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                       | truncated documentation                                                                                                |
+=============================================================================================================+========================================================================================================================+
| :class:`SearchEnginePredictions <mlinsights.search_rank.search_engine_predictions.SearchEnginePredictions>` | Extends class :class:`SearchEngineVectors` by looking for neighbors to a vector *X* by looking neighbors to *f(X)* ... |
+-------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+----------------------------------------------------------------------------------------------------------+---------------------------------------------+
| method                                                                                                   | truncated documentation                     |
+==========================================================================================================+=============================================+
| :py:meth:`__init__ <mlinsights.search_rank.search_engine_predictions.SearchEnginePredictions.__init__>`  |                                             |
+----------------------------------------------------------------------------------------------------------+---------------------------------------------+
| :py:meth:`__repr__ <mlinsights.search_rank.search_engine_predictions.SearchEnginePredictions.__repr__>`  | usual                                       |
+----------------------------------------------------------------------------------------------------------+---------------------------------------------+
| :meth:`fit <mlinsights.search_rank.search_engine_predictions.SearchEnginePredictions.fit>`               | Every vector comes with a list of metadata. |
+----------------------------------------------------------------------------------------------------------+---------------------------------------------+
| :meth:`kneighbors <mlinsights.search_rank.search_engine_predictions.SearchEnginePredictions.kneighbors>` | Searches for neighbors close to *X*.        |
+----------------------------------------------------------------------------------------------------------+---------------------------------------------+


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

.. automodule:: mlinsights.search_rank.search_engine_predictions
    :members:
    :special-members: __init__
    :show-inheritance: