Upload 3 files

README.md

@@ -10,3 +10,7 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+Demo: https://huggingface.co/spaces/Kadi-IAM/SimpleWritingHelper
+
+A simple web app to enhance scientific writing using Large Language Models (LLMs). With features like grammar correction, clarity enhancement, and technical jargon simplification, which helps researchers and academics produce more precise, and readable papers, making scientific communication more efficient and accessible.

app.py

@@ -1,3 +1,10 @@
+"""
+A simple web app to enhance scientific writing using Large Language Models (LLMs).
+With features like grammar correction, clarity enhancement, and
+technical jargon simplification, which helps researchers and academics produce more precise,
+and readable papers, making scientific communication more efficient and accessible.
+"""
+
 import os
 import gradio as gr
 import groq
@@ -8,6 +15,8 @@ api_key = os.getenv("GROQ_API")
 
 
 def generate_response(prompt):
+    """Get response from LLMs."""
+
     if not prompt:
         return "No transcription available. Please try speaking again."
 
@@ -28,12 +37,16 @@ def generate_response(prompt):
 
 
 def writing_improver(text, writing_prompt):
+    """Use LLMs to improve input text."""
+
     combined_propmpt = f"{writing_prompt}\n\nInput:{text}\n\nOutput:"
     rephrased_text = generate_response(combined_propmpt)
     return rephrased_text
 
 
 def diff_texts(text1, text2):
+    """Compare two text inputs."""
+
     d = Differ()
     return [
         (token[2:], token[0] if token[0] != " " else None)
@@ -42,11 +55,14 @@ def diff_texts(text1, text2):
 
 
 def text_reviewer(text, review_prompt):
+    """Use LLMs as reviewer for input text."""
+
     combined_propmpt = f"{review_prompt}\n\nInput:{text}\n\nOutput:"
     rephrased_text = generate_response(combined_propmpt)
     return rephrased_text
 
 
+# Gradio UI
 with gr.Blocks() as demo:
     gr.Markdown(
         "A simple web app to enhance scientific writing 📝 using Large Language Models (LLMs). With features like grammar correction, clarity enhancement, and technical jargon simplification, which helps researchers and academics produce more precise, and readable papers, making scientific communication more efficient and accessible."
@@ -55,6 +71,7 @@ with gr.Blocks() as demo:
         "⚠️ This is designed for research purposes, for best privacy protection, please avoid sharing sensitive or confidential data."
     )
 
+    # Sub-app 1. writting improver
     with gr.Tab("Improve writing 📝"):
         with gr.Row():
             with gr.Column():
@@ -86,12 +103,14 @@ with gr.Blocks() as demo:
                         color_map={"-": "red", "+": "green"},
                     )
 
+        # Actions
         submit_btn.click(
             fn=writing_improver, inputs=[text_input, prompt_input], outputs=output
         )
 
         output.change(fn=diff_texts, inputs=[text_input, output], outputs=output_diff)
 
+        # Placeholders
         gr.Markdown()
         gr.Markdown()
         gr.Markdown()
@@ -115,6 +134,7 @@ with gr.Blocks() as demo:
             inputs=[text_input, prompt_input],
         )
 
+    # Sub-app 2. LLM reviewer
     with gr.Tab("Review Assistant 👀"):
         with gr.Row():
             with gr.Column():
@@ -142,12 +162,14 @@ with gr.Blocks() as demo:
                 )
                 review_output = gr.Markdown(label="Reviews")
 
+        # Actions
         review_submit_btn.click(
             fn=text_reviewer,
             inputs=[review_text_input, review_prompt_input],
             outputs=review_output,
         )
 
+        # Placeholders
         gr.Markdown()
         gr.Markdown()
         gr.Markdown()