Upload 6 files

app.py

@@ -0,0 +1,33 @@
+# Necessary imports
+import gradio as gr
+from src.app.predict import ZeroShotTextClassification
+
+
+# Examples to display in the interface
+examples = [
+    ["I love to play the guitar", "music, artist, food, travel"],
+    ["I am a software engineer at Google", "technology, engineering, art, science"],
+    ["I am a professional basketball player", "sports, athlete, chef, politics"],
+]
+
+# Title and description and article for the interface
+title = "Zero Shot Text Classification"
+description = "Classify text using zero-shot classification with ModernBERT-large zeroshot model! Provide a text input and a list of candidate labels separated by commas. Read more at the links below."
+article = "<p style='text-align: center'><a href='https://arxiv.org/abs/2412.13663' target='_blank'>Smarter, Better, Faster, Longer: A Modern Bidirectional Encoder for Fast, Memory Efficient, and Long Context Finetuning and Inference</a> | <a href='https://huggingface.co/MoritzLaurer/ModernBERT-large-zeroshot-v2.0' target='_blank'>Model Page</a></p>"
+
+
+# Launch the interface
+demo = gr.Interface(
+    fn=ZeroShotTextClassification,
+    inputs=[gr.Textbox(label="Input"), gr.Textbox(label="Candidate Labels")],
+    outputs=gr.Label(label="Classification"),
+    title=title,
+    description=description,
+    article=article,
+    examples=examples,
+    cache_examples=True,
+    cache_mode="lazy",
+    theme="Soft",
+    flagging_mode="never",
+)
+demo.launch(debug=False)

src/app/predict.py

@@ -0,0 +1,49 @@
+# Necessary imports
+import sys
+from typing import Dict
+from src.logger import logging
+from src.exception import CustomExceptionHandling
+from transformers import pipeline
+
+
+# Load the zero-shot classification model
+classifier = pipeline(
+    "zero-shot-classification", model="MoritzLaurer/ModernBERT-large-zeroshot-v2.0"
+)
+
+
+def ZeroShotTextClassification(
+    text_input: str, candidate_labels: str
+) -> Dict[str, float]:
+    """
+    Performs zero-shot classification on the given text input.
+
+    Args:
+        - text_input: The input text to classify.
+        - candidate_labels: A comma-separated string of candidate labels.
+
+    Returns:
+        Dictionary containing label-score pairs.
+    """
+    try:
+        # Split and clean the candidate labels
+        labels = [label.strip() for label in candidate_labels.split(",")]
+
+        # Log the classification attempt
+        logging.info(f"Attempting classification with {len(labels)} labels")
+
+        # Perform zero-shot classification
+        classifier = pipeline("zero-shot-classification")
+        prediction = classifier(text_input, labels)
+
+        # Return the classification results
+        logging.info("Classification completed successfully")
+        return {
+            prediction["labels"][i]: prediction["scores"][i]
+            for i in range(len(prediction["labels"]))
+        }
+
+    # Handle exceptions that may occur during the process
+    except Exception as e:
+        # Custom exception handling
+        raise CustomExceptionHandling(e, sys) from e

src/exception.py

@@ -0,0 +1,50 @@
+"""
+This module defines a custom exception handling class and a function to get error message with details of the error.
+"""
+
+# Standard Library
+import sys
+
+# Local imports
+from src.logger import logging
+
+
+# Function Definition to get error message with details of the error (file name and line number) when an error occurs in the program
+def get_error_message(error, error_detail: sys):
+    """
+    Get error message with details of the error.
+
+    Args:
+        - error (Exception): The error that occurred.
+        - error_detail (sys): The details of the error.
+
+    Returns:
+        str: A string containing the error message along with the file name and line number where the error occurred.
+    """
+    _, _, exc_tb = error_detail.exc_info()
+
+    # Get error details
+    file_name = exc_tb.tb_frame.f_code.co_filename
+    return "Error occured in python script name [{0}] line number [{1}] error message[{2}]".format(
+        file_name, exc_tb.tb_lineno, str(error)
+    )
+
+
+# Custom Exception Handling Class Definition
+class CustomExceptionHandling(Exception):
+    """
+    Custom Exception Handling:
+        This class defines a custom exception that can be raised when an error occurs in the program.
+        It takes an error message and an error detail as input and returns a formatted error message when the exception is raised.
+    """
+
+    # Constructor
+    def __init__(self, error_message, error_detail: sys):
+        """Initialize the exception"""
+        super().__init__(error_message)
+
+        self.error_message = get_error_message(error_message, error_detail=error_detail)
+
+    def __str__(self):
+        """String representation of the exception"""
+        return self.error_message

src/logger.py

@@ -0,0 +1,21 @@
+# Importing the required modules
+import os
+import logging
+from datetime import datetime
+
+# Creating a log file with the current date and time as the name of the file
+LOG_FILE = f"{datetime.now().strftime('%m_%d_%Y_%H_%M_%S')}.log"
+
+# Creating a logs folder if it does not exist
+logs_path = os.path.join(os.getcwd(), "logs", LOG_FILE)
+os.makedirs(logs_path, exist_ok=True)
+
+# Setting the log file path and the log level
+LOG_FILE_PATH = os.path.join(logs_path, LOG_FILE)
+
+# Configuring the logger
+logging.basicConfig(
+    filename=LOG_FILE_PATH,
+    format="[ %(asctime)s ] %(lineno)d %(name)s - %(levelname)s - %(message)s",
+    level=logging.INFO,
+)