:mod:`lookout.core.model_repository`
====================================

.. py:module:: lookout.core.model_repository







Module Contents
---------------






.. py:class:: ModelRepository

   Interface to retrieve and update the ML models. Injected into `AnalyzerManager`.


   

   

   .. method:: get(self, model_id:str, model_type:Type[AnalyzerModel], url:str)

      
      Return the model for the specified key (`model_id`) and the repository (`url`).         `model_type` is used to return the correct class instance.

      :param model_id: The key of the model (based on the bound analyzer name and version).
      :param model_type: Class of the model to return the instance of.
      :param url: Git repository remote.
      :return: an `AnalyzerModel` instance and the boolean which indicates whether                  a cache miss happened. Returns None instead of the model                  in case no models were found.

      



   

   .. method:: set(self, model_id:str, url:str, model:AnalyzerModel)

      
      Put the new model into the storage for the specified key (`model_id`) and         the repository (`url`).

      :param model_id: The key of the model (based on the bound analyzer name and version).
      :param url: Git repository remote.
      :param model: The instance of the model to store.
      :return: None

      



   

   .. method:: init(self)

      
      Initialize the persistent data structures of this storage.

      



   

   .. method:: shutdown(self)

      
      Free the resources allocated by the storage.