Update app.py

app.py

@@ -15,7 +15,7 @@ import string
 import re
 from llama_cpp import Llama
 
-
+# Variables for model, Google Drive, and initial context
 repo_name = 'TheBloke/OpenHermes-2.5-Mistral-7B-GGUF'
 model_file = "openhermes-2.5-mistral-7b.Q4_K_M.gguf"
 SCOPES = ['https://www.googleapis.com/auth/drive']
@@ -26,18 +26,20 @@ initContext = """<|im_start|>You are playing the role of an aggressive patient c
 unique_id = ""
 timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
 
-
+# Function to load the LLaMA model
 def load_model():
     llm = Llama(model_path=model_file, model_type="mistral",n_gpu_layers=-1,n_ctx = 2048)
     return llm
 
+# Function to generate a unique identifier for each chat session
 def generate_unique_id():
     # Generate a random sequence of 3 letters and 3 digits
     letters = ''.join(random.choices(string.ascii_letters, k=3))
     digits = ''.join(random.choices(string.digits, k=3))
     unique_id = letters + digits
     return unique_id
-    
+
+# Download the model from Hugging Face Hub
 print('Fetching model:', repo_name, model_file)
 snapshot_download(repo_id=repo_name, local_dir=".", allow_patterns=model_file)
 print('Done fetching model:')
@@ -45,21 +47,22 @@ print('Done fetching model:')
 
 class ChatbotAPP:
     def __init__(self,model,service_account_file,scopes,folder_id,unique_id,initContext):
-        self.llm = model
-        self.service_account_file = service_account_file
-        self.scopes = scopes
-        self.folder_id = folder_id
-        self.unique_id = unique_id
-        self.chat_history = []
-        self.chat_log_history = []
-        self.isFirstRun = True
-        self.initContext = initContext
-        self.context = ""
-        self.agreed = False
-        self.service = self.get_drive_service()
-        self.app = self.create_app()
-        self.chat_log_name = ""
+        self.llm = model  # LLaMA model instance
+        self.service_account_file = service_account_file  # Path to Google service account credentials
+        self.scopes = scopes  # Google Drive API scopes
+        self.folder_id = folder_id  # Google Drive folder ID to store chat logs
+        self.unique_id = unique_id  # Unique identifier for the chat session
+        self.chat_history = []  # List to store chat history for the current session
+        self.chat_log_history = []  # List to store chat logs for uploading
+        self.isFirstRun = True  # Flag to check if it's the first run of the chat session
+        self.initContext = initContext  # Initial context for the chat session
+        self.context = ""  # Current context for the chat session
+        self.agreed = False  # Flag to check if the user agreed to terms and conditions
+        self.service = self.get_drive_service()  # Google Drive service instance
+        self.app = self.create_app()  # Gradio app instance
+        self.chat_log_name = ""  # Filename for the chat log
 
+    # Method to create Google Drive service instance
     def get_drive_service(self):
         credentials = service_account.Credentials.from_service_account_file(
             self.service_account_file, scopes=self.scopes)
@@ -67,6 +70,14 @@ class ChatbotAPP:
         print("Google Service Created")
         return self.service
 
+    def generate_unique_id(): #in an instance the user resets using the reset button
+    # Generate a random sequence of 3 letters and 3 digits
+        letters = ''.join(random.choices(string.ascii_letters, k=3))
+        digits = ''.join(random.choices(string.digits, k=3))
+        unique_id = letters + digits
+        return unique_id
+
+    # Method to search for a chat log file in Google Drive
     def search_file(self):
         #Search for a file by name in the specified Google Drive folder.
         query = f"name = '{self.chat_log_name}' and '{self.folder_id}' in parents and trashed = false"
@@ -78,7 +89,8 @@ class ChatbotAPP:
             print(f"Chat log {self.chat_log_name} exist")
         return files
     
-    def strip_text(self,text):
+    def strip_text(self,text):    # Method to strip unwanted text from chat messages
+
         # Pattern to match text inside parentheses or angle brackets and any text following angle brackets
         pattern = r"\(.*?\)|<.*?>.*"
         
@@ -87,7 +99,8 @@ class ChatbotAPP:
         
         return cleaned_text
     
-    def upload_to_google_drive(self):
+    def upload_to_google_drive(self):    # Method to upload the current chat log to Google Drive
+
         existing_files = self.search_file()
         print(existing_files)
         
@@ -105,7 +118,8 @@ class ChatbotAPP:
         with open(self.chat_log_name, "w") as log_file:
                 json.dump(data, log_file, indent=4)
     
-        if not existing_files:
+        if not existing_files:        # Upload or update the chat log file on Google Drive
+
             # If the file does not exist, upload it
             file_metadata = {
                 'name': self.chat_log_name,
@@ -122,7 +136,8 @@ class ChatbotAPP:
             updated_file = self.service.files().update(fileId=file_id, media_body=media).execute()
             print(f"Updated existing file with ID: {updated_file.get('id')}")
 
-    def generate(self,prompt, history):
+    def generate(self,prompt, history):    # Method to generate a response to the user's input
+
             
         #if not len(Name) == 0 and not len(Occupation) == 0 and not len(Ethnicity) == 0 and not len(Gender) == 0 and not len(Age) == 0 and not len(YearsOfExp):
         if self.agreed:
@@ -177,7 +192,7 @@ class ChatbotAPP:
             return self.chat_history
 
 
-    def start_chat_button_fn(self,agree_status):
+    def start_chat_button_fn(self,agree_status):    # Method to handle the start chat button action
         
         if agree_status: 
             self.agreed = agree_status
@@ -186,13 +201,15 @@ class ChatbotAPP:
         else:
             return "You must agree to the terms and conditions to proceed"
         
-    def reset_chat_interface(self):
+    def reset_chat_interface(self):    # Method to reset the chat interface
+
         self.chat_history = []
         self.chat_log_history = []
         self.isFirstRun = True
         return "Chat has been reset."
     
-    def reset_name_interface(self):
+    def reset_name_interface(self):    # Method to create the Gradio app interface
+
         Name = ""
         Occupation = ""
         YearsOfExp = ""
@@ -204,14 +221,15 @@ class ChatbotAPP:
     
     def reset_all(self):
 
-        message1 = reset_chat_interface()
+        message1 = self.reset_chat_interface()
         #message2 = reset_name_interface()
-        message3 = load_model()
-        self.unique_id = generate_unique_id()
+        #message3 = load_model()
+        self.unique_id = self.generate_unique_id()
         return f"All Chat components have been rest.  Uniqe ID for this session is, {self.unique_id}. Please note this down.",self.unique_id
 
 
-    def create_app(self):
+    def create_app(self):    # Method to launch the Gradio app
+
         with gr.Blocks() as app:
             gr.Markdown("# ECU-IVADE: Conversational AI Model for Aggressive Patient Behavior (Beta Testing)")
             unique_id_display = gr.Textbox(value=self.unique_id, label="Session Unique ID", interactive=False,show_copy_button = True)
@@ -256,6 +274,7 @@ class ChatbotAPP:
                 reset_button.click(self.reset_all, inputs=[], outputs=[reset_output,unique_id_display])
         return app
 
+# Create an instance of the ChatbotAPP class and launch the app
 llm = load_model()
 unique_id = generate_unique_id()
 chatbot_app = ChatbotAPP(llm,SERVICE_ACCOUNT_FILE,SCOPES,folder_id,unique_id,initContext)