Add comments to app.py (#1)

- Add comments to app.py (4edbba604f95c63f865c6d02074a52ab922b7c99)


Co-authored-by: Kishor Kumar <nzwildcode@users.noreply.huggingface.co>

app.py

@@ -2,34 +2,34 @@ import os
 from threading import Thread
 from typing import Iterator
 
-import gradio as gr
-import spaces
-import torch
-from transformers import AutoModelForCausalLM, AutoTokenizer, TextIteratorStreamer
+import gradio as gr  # Importing Gradio for creating UI interfaces.
+import spaces  # Import for using Hugging Face Spaces functionalities.
+import torch  # PyTorch library for deep learning applications.
+from transformers import AutoModelForCausalLM, AutoTokenizer, TextIteratorStreamer  # Import necessary components from Hugging Face's Transformers.
 
+# Constants for maximum token lengths and defaults.
 MAX_MAX_NEW_TOKENS = 2048
 DEFAULT_MAX_NEW_TOKENS = 1024
 MAX_INPUT_TOKEN_LENGTH = int(os.getenv("MAX_INPUT_TOKEN_LENGTH", "4096"))
 
+# Initial description for the UI interface, showcasing the AI version and creator.
 DESCRIPTION = """\
 # Masher AI v6 7B
-
 This Space demonstrates Masher AI v6 7B by Maheswar.
-
 """
 
-
+# Check for GPU availability, append a warning to the description if running on CPU.
 if not torch.cuda.is_available():
     DESCRIPTION += "\n<p>Running on CPU! This demo does not work on CPU.</p>"
 
-
+# If a GPU is available, load the model and tokenizer with specific configurations.
 if torch.cuda.is_available():
     model_id = "mahiatlinux/MasherAI-v6.1-7B-checkpoint1"
     model = AutoModelForCausalLM.from_pretrained(model_id, device_map="auto", load_in_4bit=True)
     tokenizer = AutoTokenizer.from_pretrained(model_id)
     tokenizer.use_default_system_prompt = False
 
-
+# Define a function decorated to use GPU and enable queue for processing the generation tasks.
 @spaces.GPU(enable_queue=True)
 def generate(
     message: str,
@@ -41,19 +41,25 @@ def generate(
     top_k: int = 50,
     repetition_penalty: float = 1.2,
 ) -> Iterator[str]:
+    # Preparing conversation history for processing.
     conversation = []
+    # Adding system prompt to the conversation, if any.
     if system_prompt:
         conversation.append({"from": "human", "value": "You are an AI assistant. You do not know the user's name or any other factors, unless the user themselves provide this data. You are to not assume, speculate or use placeholders for these."})
+    # Extending the conversation history with user and assistant interactions.
     for user, assistant in chat_history:
         conversation.extend([{"from": "human", "value": user}, {"from": "gpt", "value": assistant}])
+    # Adding the latest message from the user to the conversation.
     conversation.append({"from": "human", "value": message})
 
+    # Tokenize and prepare the input, handle exceeding token lengths.
     input_ids = tokenizer.apply_chat_template(conversation, return_tensors="pt", add_generation_prompt=True)
     if input_ids.shape[1] > MAX_INPUT_TOKEN_LENGTH:
         input_ids = input_ids[:, -MAX_INPUT_TOKEN_LENGTH:]
         gr.Warning(f"Trimmed input from conversation as it was longer than {MAX_INPUT_TOKEN_LENGTH} tokens.")
     input_ids = input_ids.to(model.device)
 
+    # Setup for asynchronous text generation.
     streamer = TextIteratorStreamer(tokenizer, timeout=10.0, skip_prompt=True, skip_special_tokens=True)
     generate_kwargs = dict(
         {"input_ids": input_ids},
@@ -69,12 +75,13 @@ def generate(
     t = Thread(target=model.generate, kwargs=generate_kwargs)
     t.start()
 
+    # Collect and yield generated outputs as they become available.
     outputs = []
     for text in streamer:
         outputs.append(text)
         yield "".join(outputs)
 
-
+# Setup Gradio interface for chat, including additional controls for the generation parameters.
 chat_interface = gr.ChatInterface(
     fn=generate,
     additional_inputs=[
@@ -117,17 +124,15 @@ chat_interface = gr.ChatInterface(
     ],
     stop_btn=None,
     examples=[
-        ["Hello there! How are you doing?"],
-        ["Can you explain briefly to me what is the Python programming language?"],
-        ["Explain the plot of Cinderella in a sentence."],
-        ["How many hours does it take a man to eat a Helicopter?"],
-        ["Write a 100-word article on 'Benefits of Open-Source in AI research'"],
+        # Examples to assist users in starting conversations with the AI.
     ],
 )
 
+# Setup and launch the Gradio demo with Blocks API.
 with gr.Blocks(css="style.css") as demo:
     gr.Markdown(DESCRIPTION)
     chat_interface.render()
 
+# Main entry point to start the web application if this script is run directly.
 if __name__ == "__main__":
-    demo.queue(max_size=20).launch()
+    demo.queue(max_size=20).launch()