Merge branch 'main' into hf_space

README.md

@@ -12,6 +12,8 @@ pinned: false
 
 # 🤖 Prompt Teacher 📝✨
 
+The **prompt teacher** is an interactive and educational prompt engineering interface for LLMs that teaches users how to craft ✍️, refine 🔧, and optimize 📈 prompts to achieve the most effective and targeted responses from LLMs.
+
 <img src="thumbnail.png" alt="Screenshot of the Prompt Teacher"/>
 
 ## Quickstart 🚀
@@ -23,6 +25,26 @@ pinned: false
 - **GitHub:** [pwenker/prompt_teacher](https://github.com/pwenker/prompt_teacher)
 - **Hugging Face Spaces:** [pwenker/prompt_teacher](https://huggingface.co/spaces/pwenker/prompt_teacher)
 
+## Metaprompts Overview
+
+The following metaprompts are currently part of the prompt teacher.
+
+
+| 🔍 **Name**                       | 📜 **Explanation**                                                                                                  | ✏️ **Example Prompt**                          | 💡 **Example Prompt Explanation**                                                                                          |
+|-----------------------------------|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
+| **Expand with details**           | Expands a prompt to include more detailed instructions and context.                                                | Tell me about dogs.                           | This prompt is very vague and lacks context, making it ideal for expansion to guide the LLM more effectively.              |
+| **Apply feedback**                | Improves a prompt based on specific feedback provided.                                                             | Describe the process of photosynthesis.       | Feedback might suggest making the prompt more accessible for younger audiences or more detailed for academic use.          |
+| **Simply condense prompt**        | Condenses a prompt to make it more succinct while retaining its essential request.                                 | Write a funny joke that makes people laugh about something very funny. It should be hilarious. | This prompt can be condensed by removing redundant information.                                                            |
+| **Simply improve prompt**         | Improves a prompt to enhance clarity and effectiveness.                                                            | Tell me how to cook rice.                     | This prompt can be improved by specifying the type of cuisine or cooking method.                                           |
+| **Create sequential task list**   | Structures a prompt to guide the LLM through a series of sequential tasks.                                         | Plan a birthday party.                        | This prompt can be structured to outline steps such as choosing a theme, preparing a guest list, and organizing activities.|
+| **Elicit creative response**      | Transforms a prompt to inspire creativity and elicit imaginative responses.                                         | Write a story about a lost kitten.            | The prompt can be revised to encourage more descriptive or emotional storytelling.                                         |
+| **Include hypothetical scenario** | Tailors a prompt to include a specific hypothetical scenario for detailed exploration.                             | The danger of Artificial General Intelligence | This prompt can be tailored to explore specific hypothetical scenarios to provide depth and context.                       |
+| **Focus on ethics**               | Reframes a prompt to focus on ethical considerations or moral dilemmas.                                            | Genetic engineering in humans.                | This prompt can be reframed to focus on the ethical considerations or moral dilemmas involved.                             |
+| **Add role prompting**            | Adds a role to the prompt to improve the response.                                                                 | Write a short song.                           | By adding an expert role, we can potentially improve the quality of the created song.                                      |
+| **Add delimiters for clarity**    | Adds clear delimiters to a prompt to separate and organize different sections or instructions, enhancing readability and structure. | Summarize this text {text} with bulletpoints. Be concise | This prompt can benefit from clear delimiters to separate instructions or sections, making it easier for the LLM to follow and respond systematically. |
+| **Incorporate chain of thought reasoning** | Incorporates chain of thought reasoning to guide the LLM through a logical sequence of thoughts for complex problem-solving. | How can we reduce traffic congestion in urban areas? | This prompt can benefit from chain of thought reasoning to break down the problem into manageable parts and explore various solutions systematically. |
+| **Comprehensive prompt refinement** | Integrates various techniques to refine, expand, and adapt prompts for LLMs, ensuring clarity, specificity, and engagement tailored to the intended purpose. | Write a brief history of Artificial Intelligence | This prompt can be improved by specifying aspects such as the depth of detail, areas of focus, and desired structure.       |
+
 ## Local Deployment 🏠
 
 ### Prerequisites 📋

metaprompts.yml

@@ -10,60 +10,6 @@ Metaprompts:
       {prompt}
 
       Add necessary details and context to guide the LLM towards a more comprehensive and targeted response.
-  - explanation: "Refines a prompt according to best practices in prompt engineering for LLMs."
-    example_prompt: "Write a brief history of the internet."
-    example_prompt_explanation: "This prompt can be improved by specifying aspects such as the depth of detail, areas of focus, and desired structure."
-    name: "Apply prompt engineering best practices"
-    template: |
-      You are an expert Prompt Writer for Large Language Models.
-
-      Your goal is to improve the prompt given below:
-
-      Prompt: {prompt}
-
-      Here are several tips on writing great prompts:
-
-      - Start the prompt by stating that it is an expert in the subject.
-      - Put instructions at the beginning of the prompt and use ### or ``` to separate the instruction and context
-      - Be specific, descriptive and as detailed as possible about the desired context, outcome, length, format, style, etc
-
-      Here's an example of a great prompt:
-
-      As an expert in theoretical physics, provide a comprehensive explanation of the theory of relativity.
-
-      ### Instructions:
-      - Begin with a brief introduction to the historical context and the significance of the theory.
-      - Clearly differentiate between the Special Theory of Relativity and the General Theory of Relativity.
-      - Explain the key concepts of each theory, including the principle of relativity, the constancy of the speed of light, time dilation, length contraction, and the equivalence principle.
-      - Use diagrams or thought experiments, such as the famous "twin paradox" and "Einstein's elevator", to illustrate complex ideas.
-      - Discuss the implications of relativity in modern physics and its application in technologies like GPS.
-      - Conclude with a summary of how relativity has influenced our understanding of the universe.
-      - Aim for a detailed yet accessible explanation suitable for readers with a basic understanding of physics, approximately 1500 words in length.
-
-      Example:
-
-      """
-      Comprehensive Explanation of the Theory of Relativity
-
-      Introduction:
-      The theory of relativity, developed primarily by Albert Einstein in the early 20th century, revolutionized our understanding of space, time, and gravity. It consists of two parts: the Special Theory of Relativity and the General Theory of Relativity. This theory has not only expanded the realm of physics but also has practical applications in various technologies today.
-
-      Special Theory of Relativity:
-      Introduced in 1905, the Special Theory of Relativity addresses the physics of objects in uniform motion relative to each other. It is grounded on two postulates: the laws of physics are the same in all inertial frames, and the speed of light in a vacuum is constant, regardless of the observer's motion. Key phenomena explained by this theory include time dilation and length contraction, which illustrate how measurements of time and space vary for observers in different inertial frames.
-
-      General Theory of Relativity:
-      Einstein's General Theory of Relativity, published in 1915, extends the principles of the Special Theory to include acceleration and gravitation. It posits that massive objects cause a distortion in space-time, which is felt as gravity. This theory is best illustrated by the equivalence principle, which suggests that the effects of gravity are indistinguishable from the effects of acceleration.
-
-      Applications and Implications:
-      Relativity is not just a theoretical framework; it has practical applications. For instance, the operation of the Global Positioning System (GPS) relies on adjustments made for the effects predicted by relativity to ensure accuracy. Furthermore, relativity has paved the way for modern cosmological theories and has been crucial in our understanding of black holes and the expansion of the universe.
-
-      Conclusion:
-      The theory of relativity has fundamentally altered our conception of the universe. Its development marked a major shift from classical physics and continues to influence many aspects of modern science and technology.
-      """
-
-      Now, improve the prompt.
-
-      IMPROVED PROMPT:
   - explanation: "Improves a prompt based on specific feedback provided."
     example_prompt: "Describe the process of photosynthesis."
     example_prompt_explanation: "Feedback might suggest making the prompt more accessible for younger audiences or more detailed for academic use."
@@ -76,16 +22,6 @@ Metaprompts:
       given this feedback:
 
       {feedback}
-  - explanation: "Adapts a prompt to suit different audiences by modifying language, tone, and technical level."
-    example_prompt: "Explain the theory of relativity."
-    example_prompt_explanation: "The prompt can be adapted for different educational levels or non-specialist audiences."
-    name: "Adapt for different audience"
-    template: |
-      Adapt the following prompt for the following audience: {audience}:
-
-      {prompt}
-
-      Modify the language, tone, and technical level to suit the needs and understanding of {audience}.
   - explanation: "Condenses a prompt to make it more succinct while retaining its essential request."
     example_prompt: "Write a funny joke that makes people laugh about something very funny. It should be hilarious."
     example_prompt_explanation: "This prompt can be condensed by removing redundant information"
@@ -152,3 +88,58 @@ Metaprompts:
       {prompt}
 
       Improved prompt:
+  - explanation: "Adds clear delimiters to a prompt to separate and organize different sections or instructions, enhancing readability and structure."
+    example_prompt: "Summarize this text {text} with bulletpoints. Be concise"
+    example_prompt_explanation: "This prompt can benefit from clear delimiters to separate instructions or sections, making it easier for the LLM to follow and respond systematically."
+    name: "Add delimiters for clarity"
+    template: |
+      Add delimiters (e.g. section titles, bullet points, or triple quotation marks) to this prompt to clearly separate and organize different sections or instructions and thereby enhance its structure and readability:
+
+      {prompt}
+  - explanation: "Incorporates chain of thought reasoning to guide the LLM through a logical sequence of thoughts for complex problem-solving."
+    example_prompt: "How can we reduce traffic congestion in urban areas?"
+    example_prompt_explanation: "This prompt can benefit from chain of thought reasoning to break down the problem into manageable parts and explore various solutions systematically."
+    name: "Incorporate chain of thought reasoning"
+    template: |
+      Incorporate chain of thought reasoning into the following prompt:
+
+      {prompt}
+
+      Break down the problem into a logical sequence of thoughts, exploring each aspect step by step to guide the LLM towards a comprehensive solution.
+  - explanation: This metaprompt integrates various techniques to refine, expand, and adapt prompts for LLMs, ensuring clarity, specificity, and engagement tailored to the intended purpose.
+    example_prompt: "Write a brief history of Artificial Intelligence"
+    example_prompt_explanation: "This prompt can be improved by specifying aspects such as the depth of detail, areas of focus, and desired structure."
+    name: Comprehensive prompt refinement
+    template: |
+      Your goal is to enhance the prompt given below by applying best practices in prompt engineering, including expansion for detail, adaptation for specific audiences, incorporation of feedback, and structuring for clarity and engagement.
+
+      ### Original Prompt:
+      {prompt}
+
+      ### Improvement Strategies:
+      1. **Specify the Expertise**: Clearly state if the prompt should be answered by an expert in a specific field.
+      2. **Add Detailed Instructions**: Include comprehensive instructions at the beginning of the prompt. Use markdown like `###` or triple backticks ``` to separate instruction and context.
+      3. **Expand for Detail**: Add necessary details and context to guide the LLM towards a more comprehensive and targeted response.
+      4. **Structure Sequentially**: If applicable, organize the prompt to guide the LLM through a series of sequential tasks or thought processes.
+      5. **Elicit Creativity**: If the prompt is creative, encourage imaginative and engaging responses.
+      6. **Include Hypothetical Scenarios**: For topics that benefit from depth, add specific scenarios that the LLM can explore.
+      7. **Focus on Ethics**: If relevant, reframe the prompt to emphasize ethical considerations or moral dilemmas.
+      8. **Add Role Prompting**: Introduce a role (e.g., an expert or a specific character) to potentially enhance the quality and relevance of the response.
+      9. **Add Delimiters for Clarity**: Use clear delimiters to organize different sections or instructions, enhancing readability and structure.
+      10. **Incorporate Chain of Thought Reasoning**: For complex problems, break down the issue into a logical sequence of thoughts to guide the LLM systematically.
+
+      ### Example of an Improved Prompt:
+      ```
+      As an expert in environmental science, provide a detailed analysis of the impact of climate change on global agriculture.
+
+      ### Instructions:
+      - Begin with an overview of the current scientific consensus on climate change.
+      - Discuss the specific ways in which changing climates are affecting agricultural practices worldwide.
+      - Include case studies or examples from different continents.
+      - Analyze potential future trends and suggest sustainable agricultural practices.
+      - Conclude with recommendations for policymakers.
+      - Target this explanation to an audience with a basic understanding of environmental science, aiming for about 2000 words.
+      ```
+
+      ### Improved Prompt:
+      ```

pyproject.toml

@@ -7,10 +7,10 @@ authors = [
 ]
 dependencies = [
     "gradio>=4.31.4",
-    "langchain>=0.2.0",
-    "langchain-openai>=0.1.7",
     "langchain-anthropic>=0.1.13",
     "pydantic-settings>=2.2.1",
+    "langchain>=0.2.1",
+    "langchain-openai>=0.1.7",
 ]
 readme = "README.md"
 requires-python = ">= 3.11"

requirements-dev.lock

@@ -43,8 +43,6 @@ contourpy==1.2.1
     # via matplotlib
 cycler==0.12.1
     # via matplotlib
-dataclasses-json==0.6.6
-    # via langchain
 defusedxml==0.7.1
     # via langchain-anthropic
 distro==1.9.0
@@ -118,7 +116,7 @@ jsonschema-specifications==2023.12.1
     # via jsonschema
 kiwisolver==1.4.5
     # via matplotlib
-langchain==0.2.0
+langchain==0.2.1
     # via prompt-teacher
 langchain-anthropic==0.1.13
     # via prompt-teacher
@@ -139,8 +137,6 @@ markdown-it-py==3.0.0
 markupsafe==2.1.5
     # via gradio
     # via jinja2
-marshmallow==3.21.2
-    # via dataclasses-json
 matplotlib==3.9.0
     # via gradio
 mdurl==0.1.2
@@ -148,8 +144,6 @@ mdurl==0.1.2
 multidict==6.0.5
     # via aiohttp
     # via yarl
-mypy-extensions==1.0.0
-    # via typing-inspect
 numpy==1.26.4
     # via altair
     # via contourpy
@@ -169,7 +163,6 @@ packaging==23.2
     # via gradio-client
     # via huggingface-hub
     # via langchain-core
-    # via marshmallow
     # via matplotlib
 pandas==2.2.2
     # via altair
@@ -273,9 +266,6 @@ typing-extensions==4.11.0
     # via pydantic-core
     # via sqlalchemy
     # via typer
-    # via typing-inspect
-typing-inspect==0.9.0
-    # via dataclasses-json
 tzdata==2024.1
     # via pandas
 ujson==5.10.0

requirements.lock

@@ -43,8 +43,6 @@ contourpy==1.2.1
     # via matplotlib
 cycler==0.12.1
     # via matplotlib
-dataclasses-json==0.6.6
-    # via langchain
 defusedxml==0.7.1
     # via langchain-anthropic
 distro==1.9.0
@@ -118,7 +116,7 @@ jsonschema-specifications==2023.12.1
     # via jsonschema
 kiwisolver==1.4.5
     # via matplotlib
-langchain==0.2.0
+langchain==0.2.1
     # via prompt-teacher
 langchain-anthropic==0.1.13
     # via prompt-teacher
@@ -139,8 +137,6 @@ markdown-it-py==3.0.0
 markupsafe==2.1.5
     # via gradio
     # via jinja2
-marshmallow==3.21.2
-    # via dataclasses-json
 matplotlib==3.9.0
     # via gradio
 mdurl==0.1.2
@@ -148,8 +144,6 @@ mdurl==0.1.2
 multidict==6.0.5
     # via aiohttp
     # via yarl
-mypy-extensions==1.0.0
-    # via typing-inspect
 numpy==1.26.4
     # via altair
     # via contourpy
@@ -169,7 +163,6 @@ packaging==23.2
     # via gradio-client
     # via huggingface-hub
     # via langchain-core
-    # via marshmallow
     # via matplotlib
 pandas==2.2.2
     # via altair
@@ -273,9 +266,6 @@ typing-extensions==4.11.0
     # via pydantic-core
     # via sqlalchemy
     # via typer
-    # via typing-inspect
-typing-inspect==0.9.0
-    # via dataclasses-json
 tzdata==2024.1
     # via pandas
 ujson==5.10.0

src/prompt_teacher/app.py

@@ -7,7 +7,7 @@ from prompt_teacher.metaprompts import metaprompts
 
 with gr.Blocks(title="Prompt Teacher", theme=gr.themes.Soft()) as gradio_app:
     gr.Markdown("### 🤖 Prompt Teacher 📝✨")
-    with gr.Accordion("ℹ️ Info: Code 📜 and Documentation 📚", open=False):
+    with gr.Accordion("ℹ️ Info: Code 📜 and Documentation 📚", open=True):
         gr.Markdown(
             "Can be found at: [Github: pwenker/prompt_teacher](https://github.com/pwenker/prompt_teacher) 📄✨"
         )
@@ -45,10 +45,11 @@ with gr.Blocks(title="Prompt Teacher", theme=gr.themes.Soft()) as gradio_app:
                 label="Large Language Model",
                 info="Select Large Language Model",
                 choices=[
+                    ("gpt-4o", "gpt-4o"),
                     ("gpt-4-turbo", "gpt-4-turbo"),
                     ("claude-3-opus", "claude-3-opus-20240229"),
                 ],
-                value="gpt-4-turbo",
+                value="gpt-4o",
             )
             api_key = gr.Textbox(
                 placeholder="Paste in your API key (sk-...)",
@@ -60,7 +61,7 @@ with gr.Blocks(title="Prompt Teacher", theme=gr.themes.Soft()) as gradio_app:
             metaprompt = gr.Radio(
                 label="Improvements",
                 info="Select how the prompt should be improved",
-                value="Apply prompt engineering best practices",
+                value="Comprehensive prompt refinement",
                 choices=[mp.name.replace("_", " ").capitalize() for mp in metaprompts],
             )
             feedback = gr.Textbox(
@@ -68,11 +69,6 @@ with gr.Blocks(title="Prompt Teacher", theme=gr.themes.Soft()) as gradio_app:
                 info="Write your own feedback to be used to improve the prompt",
                 visible=False,
             )
-            audience = gr.Textbox(
-                label="Audience",
-                info="Select the audience for the prompt",
-                visible=False,
-            )
 
     improved_prompt = gr.Textbox(label="Improved Prompt", visible=False)
     examples = gr.Examples(
@@ -83,8 +79,8 @@ with gr.Blocks(title="Prompt Teacher", theme=gr.themes.Soft()) as gradio_app:
 
     metaprompt.change(
         fn=update_widgets,
-        inputs=[metaprompt],
-        outputs=[improve_btn, feedback, audience],
+        inputs=[metaprompt, feedback],
+        outputs=[improve_btn, feedback],
     ).success(
         lambda: [gr.Button(visible=False), gr.Button(visible=False)],
         None,
@@ -102,7 +98,6 @@ with gr.Blocks(title="Prompt Teacher", theme=gr.themes.Soft()) as gradio_app:
             prompt,
             metaprompt,
             feedback,
-            audience,
             prompt_teacher,
         ],
         outputs=[improved_prompt, prompt_teacher],
@@ -132,4 +127,4 @@ with gr.Blocks(title="Prompt Teacher", theme=gr.themes.Soft()) as gradio_app:
     )
 
 if __name__ == "__main__":
-    gradio_app.launch(favicon_path="robot.svg")
+    gradio_app.queue(default_concurrency_limit=10).launch(favicon_path="robot.svg")

src/prompt_teacher/callbacks.py

@@ -9,6 +9,7 @@ from langchain_core.pydantic_v1 import ValidationError
 from langchain_openai import ChatOpenAI
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
+from prompt_teacher.messages import system_message
 from prompt_teacher.metaprompts import metaprompts_dict
 
 
@@ -26,7 +27,7 @@ def get_llm(
     api_key: str = settings.openai_api_key,
     structured_output=None,
 ):
-    if model_name in ["gpt-4-turbo"]:
+    if model_name in ["gpt-4-turbo", "gpt-4o"]:
         llm = ChatOpenAI(
             model=model_name,
             api_key=settings.openai_api_key if not api_key else api_key,
@@ -55,16 +56,14 @@ def explain_metaprompt(explanation_history, metaprompt):
         yield explanation_history
 
 
-def update_widgets(metaprompt):
+def update_widgets(metaprompt, feedback):
     button_variant = "primary" if metaprompt else "secondary"
     feedback_visibility = True if metaprompt == "Apply feedback" else False
-    audience_visibility = (
-        True if metaprompt == "Adapt for different audience" else False
-    )
     return [
         gr.Button(variant=button_variant),
-        gr.Textbox(visible=feedback_visibility),
-        gr.Textbox(visible=audience_visibility),
+        gr.Textbox(
+            visible=feedback_visibility, value=feedback if feedback_visibility else ""
+        ),
     ]
 
 
@@ -84,10 +83,14 @@ def explain_improvement(
     ---
     {improved_prompt}
     ---
-    Concisely explain the improvement
+    Concisely explain the improvement.
     """
-    prompt_template = ChatPromptTemplate.from_template(
-        prompt_template,
+
+    prompt_template = ChatPromptTemplate.from_messages(
+        [
+            ("system", system_message),
+            ("human", prompt_template),
+        ]
     )
     llm = get_llm(model_name, api_key)
     parser = StrOutputParser()
@@ -112,13 +115,15 @@ def improve_prompt(
     prompt: str,
     metaprompt: str,
     feedback: str | None,
-    audience: str | None,
     explanation_history,
 ) -> Generator[Tuple[str, str], Any, Any]:
     metaprompt_template = metaprompts_dict[metaprompt].template
 
-    prompt_template = ChatPromptTemplate.from_template(
-        metaprompt_template,
+    prompt_template = ChatPromptTemplate.from_messages(
+        [
+            ("system", system_message),
+            ("human", metaprompt_template),
+        ]
     )
     parser = StrOutputParser()
     llm = get_llm(model_name, api_key)
@@ -138,14 +143,7 @@ def improve_prompt(
 
     improved_prompt = ""
 
-    ## Modify the input so that audience is also included
-    input = (
-        {"prompt": prompt, "feedback": feedback}
-        if feedback
-        else {"prompt": prompt, "audience": audience}
-        if audience
-        else {"prompt": prompt}
-    )
+    input = {"prompt": prompt, "feedback": feedback} if feedback else {"prompt": prompt}
 
     for response in llm_chain.stream(input):
         explanation_history[-1][1] += response
@@ -154,7 +152,7 @@ def improve_prompt(
 
 
 def robustly_improve_prompt(*args, **kwargs):
-    history = args[6]
+    history = args[5]
     user_txt = "Oh no, there is an error!💥 What should I do?"
     try:
         yield from improve_prompt(*args, **kwargs)

src/prompt_teacher/messages.py

@@ -1,3 +1,4 @@
+system_message = """You are the "Prompt Teacher", an Advanced Prompt Engineering Interface for Large Language Models (LLMs). You are designed to assist users in crafting, refining, and optimizing prompts to achieve the most effective and targeted responses from LLMs. Whether they're looking to expand, refine, adapt, or structure their prompts, please provide clear guidelines and examples to them formulate your queries with precision. If you are asked to improve a prompt please only respond with the improved prompt and nothing else. If you are tasked with explaining an improved prompt, please be concise and use bullet points if helpful."""
 inital_usr_text = "I would like to **learn how to prompt**! If only someone could... 🤔📚"
 initial_bot_text = """**Hello** 👋, look no further: **I'm your prompt teacher!** 💁‍♂️🎓