Upload app.py

app.py

@@ -0,0 +1,179 @@
+import os
+import gradio as gr
+import groq
+from difflib import Differ
+
+# Set api key of Groq
+api_key = os.getenv("GROQ_API")
+
+
+def generate_response(prompt):
+    if not prompt:
+        return "No transcription available. Please try speaking again."
+
+    client = groq.Client(api_key=api_key)
+
+    try:
+        # Use Llama 3.1 70B powered by Groq for text generation
+        completion = client.chat.completions.create(
+            model="llama-3.1-70b-versatile",
+            messages=[
+                # {"role": "system", "content": "You are a helpful assistant."},
+                {"role": "user", "content": prompt}
+            ],
+        )
+        return completion.choices[0].message.content
+    except Exception as e:
+        return f"Error in response generation: {str(e)}"
+
+
+def writing_improver(text, writing_prompt):
+    combined_propmpt = f"{writing_prompt}\n\nInput:{text}\n\nOutput:"
+    rephrased_text = generate_response(combined_propmpt)
+    return rephrased_text
+
+
+def diff_texts(text1, text2):
+    d = Differ()
+    return [
+        (token[2:], token[0] if token[0] != " " else None)
+        for token in d.compare(text1, text2)
+    ]
+
+
+def text_reviewer(text, review_prompt):
+    combined_propmpt = f"{review_prompt}\n\nInput:{text}\n\nOutput:"
+    rephrased_text = generate_response(combined_propmpt)
+    return rephrased_text
+
+
+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."
+    )
+    gr.Markdown(
+        "⚠️ This is designed for research purposes, for best privacy protection, please avoid sharing sensitive or confidential data."
+    )
+
+    with gr.Tab("Improve writing 📝"):
+        with gr.Row():
+            with gr.Column():
+                text_input = gr.Textbox(
+                    label="Text to improve",
+                    lines=10,
+                    placeholder="Enter your text here and click the button below to rewrite it.",
+                )
+
+                with gr.Accordion("Show detailed writing instruction", open=False):
+                    gr.Markdown(
+                        "Note: modify **[topic]** in writing instruction accordingly."
+                    )
+                    prompt_input = gr.Textbox(
+                        label="Writing instruction",
+                        value="I am writing a paper on [topic] for a leading academic journal and would like help refining a specific section. Please rephrase the section to enhance clarity, coherence, and conciseness, ensuring smooth transitions between paragraphs and logical flow. Remove any unnecessary jargon and maintain a formal, professional tone suitable for an academic audience.",
+                        lines=5,
+                    )
+
+                submit_btn = gr.Button("Improve Writing", variant="primary")
+
+            with gr.Column():
+                output = gr.Textbox(label="Improved Text", show_copy_button=True)
+                with gr.Accordion("Show difference", open=False):
+                    output_diff = gr.HighlightedText(
+                        label="Diff",
+                        combine_adjacent=True,
+                        show_legend=True,
+                        color_map={"-": "red", "+": "green"},
+                    )
+
+        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)
+
+        gr.Markdown()
+        gr.Markdown()
+        gr.Markdown()
+
+        gr.Examples(
+            examples=[
+                [
+                    "Solid-state batteries are a new type of battery that people are working on a lot right now. They use a solid electrolyte instead of the liquid or gel-like ones in regular lithium-ion batteries, which makes them better in some ways. For example, they can be safer because there’s less chance of leaking or catching fire, and they could also have more energy density, which means they can store more energy. Some researchers say they can charge faster, too, which is really important for things like electric cars. But there are a lot of challenges that still need to be solved, like the solid electrolyte not working as well as liquid ones at room temperature, and sometimes there are problems with the materials they use breaking down or not connecting well with the battery’s electrodes. So, even though solid-state batteries could be a big deal in the future, we’re not quite there yet.",
+                    "I am writing a paper on topic solid-state batteries for a leading academic journal and would like help refining a specific section. Please rephrase the section to enhance clarity, coherence, and conciseness, ensuring smooth transitions between paragraphs and logical flow. Remove any unnecessary jargon and maintain a formal, professional tone suitable for an academic audience.",
+                ],
+                [
+                    """In this study, we synthesized the solid-state electrolyte using the conventional solid-state reaction method. First, the raw materials, lithium carbonate (Li2CO3), aluminum oxide (Al2O3), and sulfur powder (S), were weighed according to their stoichiometric ratios and then mixed thoroughly in a mortar for approximately 30 minutes. After mixing, the powder was transferred to a furnace and calcined at 800°C for 6 hours. Following calcination, the powder was cooled to room temperature and then ground again for another 20 minutes. Next, the calcined powder was pressed into pellets using a hydraulic press at a pressure of 2 tons for 5 minutes. The pellets were then sintered in a furnace at 850°C for 12 hours to improve their mechanical strength and ionic conductivity. After sintering, the pellets were left to cool down naturally to room temperature. The obtained solid-state electrolyte was then characterized by X-ray diffraction (XRD) to confirm phase purity and scanning electron microscopy (SEM) to observe the microstructure. To evaluate the ionic conductivity, we performed electrochemical impedance spectroscopy (EIS) in the frequency range of 1 Hz to 1 MHz at room temperature. The pelletized electrolyte was placed between two stainless steel blocking electrodes in a Swagelok cell. The impedance data were analyzed using the ZView software to calculate the bulk resistance of the electrolyte. Ionic conductivity was determined by the formula σ = L/(R × A), where L is the thickness of the pellet, R is the bulk resistance, and A is the area of the pellet.Finally, we compared the ionic conductivity of the synthesized electrolyte with previously reported values. Although the conductivity of our sample was lower than expected, we believe that optimizing  the sintering temperature or modifying the stoichiometric ratio could further improve the performance.""",
+                    """I am preparing a manuscript on topic solid-state batteries for submission to a leading academic journal and seek assistance in refining a particular section. Please revise the section to improve clarity, coherence, and conciseness, while ensuring smooth transitions between paragraphs and a logical progression of ideas. Eliminate unnecessary jargon and maintain a formal, scholarly tone appropriate for an academic audience. Prioritize enhancing readability without sacrificing depth or precision.""",
+                ],
+                [
+                    """Research data management is really important because it helps in keeping the data organized and accessible for future use. When data is managed well, it makes it easier for other researchers to understand and use the data, which is important for collaboration and further studies. Also, good data management practices help in making sure that the data is reliable and can be trusted. Many funding agencies and universities now require researchers to follow certain data management protocols, which shows how important it is. So, having a good system for managing research data is not just a good idea, but something that is necessary for doing good research.""",
+                    """I am authoring a research paper on research data management with the aim of submitting it to a prestigious academic journal. I require assistance in refining a particular section to ensure it meets the journal's high standards. Please revise the section to improve its overall clarity, coherence, and conciseness. Focus on creating seamless transitions between paragraphs, maintaining a logical flow of ideas, and eliminating any jargon that may hinder understanding. The tone should remain formal and professional, catering to an academic audience.""",
+                ],
+            ],
+            examples_per_page=1,
+            inputs=[text_input, prompt_input],
+        )
+
+    with gr.Tab("Review Assistant 👀"):
+        with gr.Row():
+            with gr.Column():
+                review_text_input = gr.Textbox(
+                    label="Text to review",
+                    lines=10,
+                    placeholder="Enter your text here and click the button below to review it.",
+                )
+
+                with gr.Accordion("Show detailed review instruction", open=False):
+                    gr.Markdown(
+                        "Note: modify **[topic]** and **[aspects]** in review instruction accordingly."
+                    )
+                    review_prompt_input = gr.Textbox(
+                        label="Review instruction",
+                        value="Assume the role of a seasoned scholar with over 20 years of academic expertise in [topic]. Based on the following section of the paper, which focuses primarily on the [aspects], provide a detailed and structured review. Your review should include the following elements:  Core Content Summary: Very briefly summarize the key points and findings of the experimental section. Identification of Limitations: Critically identify and list the limitations of the experimental work. Significance of Limitations: Explain the significance of each identified limitation, ranking them in order of importance. Maintain a concise, objective, and professional tone throughout your review. Possible Questions by Reviewer: Prepare a list of possible questions a reviewer might ask about your work. Consider aspects such as the clarity of your argument, the strength of your evidence, the originality of your ideas, and any potential weaknesses or gaps in your research. Anticipating these questions can help you refine your work and address any concerns before submission.",
+                        lines=8,
+                    )
+
+                review_submit_btn = gr.Button("Review", variant="primary")
+
+            with gr.Column():
+                gr.Markdown(
+                    "Some comments and suggestions from the LLM reviewer will show below."
+                )
+                review_output = gr.Markdown(label="Reviews")
+
+        review_submit_btn.click(
+            fn=text_reviewer,
+            inputs=[review_text_input, review_prompt_input],
+            outputs=review_output,
+        )
+
+        gr.Markdown()
+        gr.Markdown()
+        gr.Markdown()
+
+        gr.Examples(
+            examples=[
+                [
+                    "The synthesis of the solid-state electrolyte was carried out using a simple solid-state reaction method. First, the precursor materials, lithium carbonate (Li2CO3), aluminum oxide (Al2O3), and titanium dioxide (TiO2), were weighed in stoichiometric amounts using a digital balance. The weighed powders were then mixed together in a mortar and pestle for 10 minutes to ensure homogeneity. The mixture was then transferred to an alumina crucible and heated in a muffle furnace at 800°C for 12 hours. After heating, the sample was allowed to cool to room temperature inside the furnace. The resulting powder was then ground again in the mortar and pestle for 5 minutes to break up any agglomerates. The powder was then pressed into pellets using a hydraulic press at a pressure of 5 tons for 2 minutes. The pellets were sintered at 900°C for 6 hours in the muffle furnace. After sintering, the pellets were cooled to room temperature in the furnace. The phase purity of the synthesized electrolyte was confirmed using X-ray diffraction (XRD) with Cu Kα radiation. The microstructure of the sintered pellets was examined using scanning electron microscopy (SEM). The ionic conductivity of the electrolyte was measured using electrochemical impedance spectroscopy (EIS) in the frequency range of 1 Hz to 1 MHz at room temperature. The electrolyte was sandwiched between two stainless steel electrodes for the EIS measurements.",
+                    "Assume the role of a seasoned scholar with over 20 years of academic expertise in solid-state batteries. Based on the following section of the paper, which focuses primarily on the experimental aspects, provide a detailed and structured review. Your review should include the following elements: Core Content Summary: Very briefly summarize the key points and findings of the experimental section. Identification of Limitations: Critically identify and list the limitations of the experimental work. Significance of Limitations: Explain the significance of each identified limitation, ranking them in order of importance. Maintain a concise, objective, and professional tone throughout your review. Possible Questions by Reviewer: Prepare a list of possible questions a reviewer might ask about your work. Consider aspects such as the clarity of your argument, the strength of your evidence, the originality of your ideas, and any potential weaknesses or gaps in your research. Anticipating these questions can help you refine your work and address any concerns before submission.",
+                ],
+            ],
+            examples_per_page=1,
+            inputs=[review_text_input, review_prompt_input],
+        )
+
+    with gr.Tab("About"):
+        gr.Markdown(
+            """
+                This simple app is designed for academic purposes to explore the possibility of using Large Language Models (LLMs) to support the process of scientific writing. It is being developed by a team from Karlsruhe, Germany, who are interested in using machine learning techniques to support various scientific topics and simplify the process of research data management. You may find more information about us [here](https://kadi.iam.kit.edu/#).
+                
+                It is possible that this application will not give a perfect answer at first, and you may need to modify the instruction prompt accordingly. This is because using LLM to help with scientific writing is a collaborative process that requires the user to provide additional information or refine their instructions. The quality of the interaction usually improves the results. However, it is very important to note that the user is using the LLM as a kind of "assistant" and not as a substitute for their own judgment. It is not the role of the LLM to write the user's document for them.
+                
+                **Please be very careful about potential academic ethics issues and the leakage of private data that may result**.
+                """
+        )
+
+
+if __name__ == "__main__":
+    demo.launch(show_api=False)