.. _f-searchenginepredictionsimages:

module ``search_rank.search_engine_predictions_images``
=======================================================





.. inheritance-diagram:: mlinsights.search_rank.search_engine_predictions_images


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

module ``mlinsights.search_rank.search_engine_predictions_images``

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


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                                        | truncated documentation                                                                                                    |
+==============================================================================================================================+============================================================================================================================+
| :class:`SearchEnginePredictionImages <mlinsights.search_rank.search_engine_predictions_images.SearchEnginePredictionImages>` | Extends class :class:`SearchEnginePredictions`. Vectors are coming from images. The metadata must contains information ... |
+------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+-----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| method                                                                                                                      | truncated documentation                                                                                      |
+=============================================================================================================================+==============================================================================================================+
| :py:meth:`_prepare_fit <mlinsights.search_rank.search_engine_predictions_images.SearchEnginePredictionImages._prepare_fit>` | Stores data in the class itself.                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.search_rank.search_engine_predictions_images.SearchEnginePredictionImages.fit>`                      | Processes images through the model and fits a *k-nn*.                                                        |
+-----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`kneighbors <mlinsights.search_rank.search_engine_predictions_images.SearchEnginePredictionImages.kneighbors>`        | Searches for neighbors close to the first image returned by *iter_images*. It returns the neighbors only ... |
+-----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+


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

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