improve usage of api

Author: ManuelFay

README.md

@@ -13,7 +13,7 @@ group pictures, screenshots, etc...
 
 In a Python 3.8+ virtual environment, install either from PIP or from source:
 
-####Installation from the PIP package:
+#### Installation from the PIP package:
 ```bash
 pip install image-searcher
 
@@ -41,22 +41,29 @@ the picture, enable the `include_faces` flag (note that it makes the indexing pr
 ```python
 from image_searcher import Search
 
-searcher = Search(image_dir_path="/home/manu/perso/ImageSearcher/data/", traverse=True, include_faces=False)
+searcher = Search(image_dir_path="/home/manu/perso/ImageSearcher/data/", 
+                  traverse=True, 
+                  include_faces=False)
 ```
 
 Once this process has been done once, through Python, the library is used as such:
 ```python
 from image_searcher import Search
 
-searcher = Search(image_dir_path="/home/manu/perso/ImageSearcher/data/", traverse=True, include_faces=False)
+searcher = Search(image_dir_path="/home/manu/perso/ImageSearcher/data/", 
+                  traverse=True, 
+                  include_faces=False)
 
-ranked_images = searcher.rank_images("A photo of a bird.", n=5)
-
-# Display best images
+# Option 1: Pythonic API
 from PIL import Image
 
+ranked_images = searcher.rank_images("A photo of a bird.", n=5)
 for image in ranked_images:
     Image.open(image.image_path).convert('RGB').show()
+
+# Option 2: Launch Flask api from code
+from image_searcher.api import run
+run(searcher=searcher)
 ```
 
 ### Using tags in the query
@@ -93,7 +100,15 @@ threaded:
 ```python
 from image_searcher.api import run
 
+# Option 1: Through a config file
 run(config_path="path_to_config_file.yml")
+
+# Option 2: Through an instanciated Search object
+from image_searcher import Search
+
+run(searcher=Search(image_dir_path="/home/manu/perso/ImageSearcher/data/", 
+                    traverse=True, 
+                    include_faces=False))
 ```
 
 A gunicorn process can also be launched locally with:

api/run_flask_gunicorn.py

@@ -7,5 +7,5 @@ def create_app(config_path: str) -> Flask:
     Entry point for gunicorn
     """
 
-    command = RunFlaskCommand(config_path)
+    command = RunFlaskCommand(config_path=config_path)
     return command.run(start=False)

image_searcher/api/run_flask_command.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Optional
 import yaml
 
 from flask import Flask
@@ -12,9 +13,19 @@
 class RunFlaskCommand:
     logging.basicConfig(level=logging.INFO)
 
-    def __init__(self, config_path: str):
-        self.searcher = None
-        self.config = FlaskConfig(**yaml.load(open(config_path, 'r'), Loader=yaml.FullLoader))
+    def __init__(self, config_path: Optional[str] = None, searcher: Optional[Search] = None):
+        if config_path is None and searcher is None:
+            raise AttributeError("Either the config path or the searcher need to be defined")
+
+        self.searcher = searcher
+        if config_path:
+            self.config = FlaskConfig(**yaml.load(open(config_path, 'r'), Loader=yaml.FullLoader))
+        else:
+            self.config = FlaskConfig(image_dir_path=self.searcher.loader.image_dir_path,
+                                      traverse=self.searcher.loader.traverse,
+                                      save_path=self.searcher.stored_embeddings.save_path,
+                                      reindex=False,
+                                      include_faces=len(self.searcher.stored_embeddings.face_embedding_paths) > 0)
 
     def get_best_images(self):
         """Routine that runs the QA inference pipeline.
@@ -55,6 +66,6 @@ def run(self, start=True):
         return app
 
 
-def run(config_path: str):
-    command = RunFlaskCommand(config_path=config_path)
+def run(**kwargs):
+    command = RunFlaskCommand(**kwargs)
     command.run()

image_searcher/interfaces/stored_embeddings.py

@@ -54,8 +54,7 @@ def set_all_face_embeddings(self):
         embedding_path = []
 
         for key, value in self.embeddings.items():
-            # TODO: This line should not be needed
-            if "face_embeddings" in value.keys():
+            if "face_embeddings" in value.keys():   # Normally, this line should not be needed
                 for x in value["face_embeddings"]:
                     face_embeddings.append(x)
                     embedding_path.append(key)