refactor: clip interface

src/interface/clip.py

@@ -1,3 +1,5 @@
+"""CLIP interface module"""
+
 # libraries
 from typing import List, Dict
 import gradio as gr
@@ -10,19 +12,32 @@ from src.model.clip import CLIP_Model
 MODEL = CLIP_Model()
 
 def clean_text(text: str) -> List[str]:
-    """function to clean gradio input text, remove the trailing and leading spaces"""
+    """function to clean gradio input text
+
+    Args:
+        text (str): string of comma separated text
+
+    Returns:
+        List[str]: list of cleaned text
+    """
     return list(map(lambda x: x.strip(), text.split(",")))
 
 def clip_demo_fn(image: Image.Image, text: str) -> Dict[str, float]:
-    try:
-        logger.info("demo function invoked")
-        text = clean_text(text)
-        logger.debug("clean text: %s", text)
-        return MODEL(image, text)
-    except Exception as error_msg:
-        logger.error("Error caught: %s", error_msg)
-    finally:
-        logger.info("demo function completed")
+    """demo function for gradio interface
+
+    Args:
+        image (Image.Image): expects PIL image_
+        text (str): string of comma separated text
+
+    Returns:
+        Dict[str, float]: dictionary of text classes and its associated probability
+    """
+    logger.info("demo function invoked")
+    text = clean_text(text)
+    logger.debug("clean text: %s", text)
+    yield MODEL(image, text)
+    logger.info("demo function completed")
+    return
 
 demo_interface = gr.Interface(
     fn=clip_demo_fn,