Update config.py

config.py

@@ -1,80 +1,182 @@
 # config.py
+#
+# ======================================================================
+# SETTINGS FOR THE SCHEMA STUDY APP
+# ======================================================================
+#
+# This file contains all the customizable settings for your app.
+# If you're not familiar with programming, don't worry! Just follow
+# the instructions next to each setting and edit the values between
+# the quotation marks or after the equals sign. 
+#
+# IMPORTANT: 
+# - DO NOT remove any quotation marks or equals signs
+# - DO NOT change any variable names (the words before the equals sign)
+# - DO NOT delete any lines or sections
+# - Keep your file in the same folder as app.py
+#
+# ======================================================================
+
+
+# ==============================================
+# 1. BASIC APP SETTINGS
+# ==============================================
+
+# The title shown at the top of your app
+app_title = "Schema Study - BILD 5"
+
+# The file containing your terms and their definitions
+# This must be a CSV file in the same folder as app.py
+# The CSV file should have two columns: first column for terms, second column for context
+default_terms_csv = "all_terms.csv"
 
-# THIS IS THE FILE YOU SHOULD EDIT TO CUSTOMIZE THE APP. DO NOT EDIT app.py UNLESS YOU KNOW WHAT YOU ARE DOING.
+# Warning message shown at the bottom of the chat window
+warning_message = "**ChatGPT can make errors and does not replace verified and reputable online and classroom resources. Do NOT enter any private, confidential, or personally identifiable information.**"
 
-############################################################################################################
 
-# Below is the configuration for the chatbot
+# ==============================================
+# 2. AI MODEL SETTINGS
+# ==============================================
 
-# The model_name refers to the name of the model you want to use. You can choose from the following models: 
+# The OpenAI model used by the app
+# Current recommended options: "gpt-4.1" or "gpt-4o"
 ai_model = "gpt-4.1"
 
-# Temperature refers to the randomness/creativity of the responses. A higher temperature will result in more random/creative responses. It varies between 0 and 1.
+# Controls randomness/creativity (0-1)
+# Lower values (0.1-0.3) = more focused, precise responses
+# Higher values (0.7-1.0) = more creative, varied responses
 temperature = 0.1
 
-# Max_tokens refers to the maximum number of tokens (words) the AI can generate. The higher the number, the longer the response. It varies between 1 and 2048.
+# Maximum length of AI responses (measured in tokens)
+# Higher values allow for longer responses (1000-2000 is usually sufficient)
 max_tokens = 1000
 
-# Frequency penalty parameter for the response. Higher penalty will result in more diverse responses. It varies between 0 and 1.
-frequency_penalty = 0.5
+# Controls repetition in responses (0-2)
+# Higher values reduce repetition of phrases
+frequency_penalty = 0.9
 
-# Presence penalty parameter for the response. Higher penalty will result in less repetitive responses. It varies between 0 and 1.
+# Controls topic diversity (0-2)
+# Higher values encourage the AI to explore new topics
 presence_penalty = 0.7
 
-# Below is all the text you can customize for the app. Don't remove the quotations around the text. Don't change the variable names.
-
-############################################################################################################
-
-# Below is the name for your default csv terms file. You can change this to any csv file you want to use as your default terms file. It must be in the same folder as the main app.py file.
-
-default_terms_csv = "all_terms.csv"
-
-############################################################################################################
-
-# Below is all the text you can customize for the app. Don't remove the quotations around the text. Don't change the variable names.
-
-# The title of the app
-app_title = "Schema Study - BILD 5 Version"
 
-# The subtitle of the app
-app_author = "by Keefe Reuther, Assistant Teaching Professor in the UC San Diego School of Biological Sciences"
+# ==============================================
+# 3. STUDENT INSTRUCTIONS
+# ==============================================
 
-# This is an intro paragraph you can add under the title. it is not currently being used in the app.
-intro_para = "An AI-enhanced study app for biology students."
-
-# The user's instructions for the app
+# Instructions displayed to students when they click the instructions expander
 instructions = '''
 The goal of this app is to help you learn and and assess your knowledge of core course concepts and examples. 
 1. Choose a course term/phrase from the drop down menu.
 2. *Pause and think for 30 seconds.* What is everything you associate with this term/phrase? What is a simple definition or example?
 3. Write as little or as much as you'd like about it. Try to include anything you might need to know for an exam. 
 4. Please follow-up with questions. If you don't know something, just ask. It is perfectly ok to write: "I have no idea what this term means." **Have a conversation!**
----
-**WANT TO LEVEL UP?**
-- Ask the chatbot: 'I want to test my ability to connect this term to others in the term list. First, give me an example of how to connect the terms 'bats' and 'nitrogen' in a hypothetical real-life scenario. Second, prompt me to similarly create a logical applied scenario between the displayed term and one other you MUST CHOOSE RANDOMLY from the course term list. Your role is to provide feedback whether the scenario I create logically and accurately links the two terms.'
-- Ask the chatbot" 'I want you to provide me with R code to create and print a ggplot object that has a common syntax error and challenge me to fix the bug.'
-- Ask the chatbot: 'Create a scenario where I have to solve a quantitative problem using this term. Make the problem challenging.'
-- Ask the chatbot: 'Please tell me two truths and a lie about this term. I need to choose the lie and explain my reasoning. Make the lies subtle and highlight common misconceptions.'
-- **Get creative! Play around and see what happens! Remember, deep learning occurs the more we scrimmage with the information**
 '''
 
-app_creation_message = "This app, its corresponding manuscript, and all documentation was authored, edited, and tested by Keefe Reuther, [Liam O Mueller](https://biology.ucsd.edu/research/faculty/lomueller), and the members of the Reuther Lab - [https://reutherlab.biosci.ucsd.edu/](https://reutherlab.netlify.app/)"
 
+# ==============================================
+# 4. PROMPT TEMPLATE BUTTONS
+# ==============================================
+
+# These templates appear as buttons students can click to start different types of activities
+# Each template has a "name" (shown on the button) and a "template" (the text sent when clicked)
+# You can edit the existing templates or add new ones following the same format
+# The {term} will be replaced with the selected term from the dropdown
+# The {term_list} will be replaced with the list of all terms
+
+prompt_templates = [
+    {
+        "name": "Misconception Check",
+        "template": "What are some common misconceptions about {term}? Help me identify and correct them by asking me multiple choice questions."
+    },
+    {
+        "name": "Two Truths & a Lie",
+        "template": "Tell me two truths and one lie about {term}. I'll try to identify the lie and explain my reasoning."
+    },
+    {
+        "name": "Connect Terms",
+        "template": "I want to test my ability to connect {term} to others in the term list. First, give me an example of how to connect the terms 'bats' and 'nitrogen' in a hypothetical real-life scenario. Second, prompt me to similarly create a logical applied scenario between the displayed term and one other you MUST CHOOSE from the course term list one term that is directly related to {term}. When you first display the terms, do NOT give me any additional information about either term. Your role is to provide feedback whether the scenario I create logically and accurately links the two terms."
+    },
+    {
+        "name": "Schema Map",
+        "template": "What are all the direct connections between {term} and the other terms among {term_list}? Help me create a concept map for {term}."
+    },
+    {
+        "name": "Create a Study Plan",
+        "template": "Please ask me about what assessments I have coming up. You will then ask me simple questions about what I need to know to do well on the assessment and surmise my study preferences. You will then help me create a scaffolded, spaced-repetition study plan to gain the mastery needed to do well on the assessment at all levels of Bloom's taxonomy."
+    }
+]
+
+
+# ==============================================
+# 5. ATTRIBUTION AND LICENSE
+# ==============================================
+
+# Information about who created the app (appears in the sidebar)
+app_creation_message = "This app, its corresponding manuscript, and all documentation was authored, edited, and tested by Keefe Reuther, [Liam O Mueller](https://biology.ucsd.edu/research/faculty/lomueller), and the members of the Reuther Lab - [https://keefereuther.com](https://keefereuther.com)"
+
+# License and repository information (appears in the sidebar)
 app_repo_license_message = "It can be found at [https://huggingface.co/spaces/keefereuther/Schema_Study_BILD5](https://huggingface.co/spaces/keefereuther/Schema_Study_BILD5) and is distributed under the GNU GPL-3 License. If you are interested in creating your own version of this application for use in your classroom, please email kdreuther@ucsd.edu for more information."
 
-warning_message = "**ChatGPT can make errors and does not replace verified and reputable online and classroom resources. Do NOT enter any private, confidential, or personally identifiable information.**"
 
-###########################################################################################
-### PROMPT
+# ==============================================
+# 6. RESOURCES LIST
+# ==============================================
+
+# Resources shown in the sidebar that students can access
+# You can add/remove/edit resources
+# Each resource can have:
+#  - "title": The name of the resource shown in the sidebar
+#  - "url": Link to an external website (optional)
+#  - "file_path": Path to a downloadable file in your app folder (optional)
+#  - "description": Text explaining the resource
+
+resources = [
+    {
+        "title": "Course Syllabus",
+        "file_path": "BILD_5_Syllabus_Reuther_SP25.pdf",
+        "description": "Download the course syllabus. **Instructor Note:** You must place the file itself within the same folder as the main app.py file in your GitHub repository."
+    },
+    {
+        "title": "OpenAI Prompt engineering guide",
+        "url": "https://platform.openai.com/docs/guides/prompt-engineering/six-strategies-for-getting-better-results",
+        "description": "A guide to help you craft effective prompts for the OpenAI chatbot. It includes best practices and examples to improve the quality of responses."
+    },
+    {
+        "title": "UC Berkeley Library Guide to Detecting Fake News",
+        "url": "https://guides.lib.berkeley.edu/fake-news",
+        "description": "This UC Berkeley Library guide offers comprehensive strategies and resources for identifying fake news, understanding its impact, and evaluating the credibility of various news sources, including lists of known fake news sites and tips for detecting misinformation."
+    },
+    {
+        "title": "Is it cheating to use ChatGPT?",
+        "url": "https://academicintegrity.ucsd.edu/excel-integrity/gen-ai/ai-in-education.html",
+        "description": "The UC San Diego Academic Integrity Office provides guidance on the appropriate use of generative AI tools in educational settings, emphasizing the importance of adhering to instructor guidelines and the potential consequences of misuse, including integrity violations and academic penalties."
+    },
+    {
+        "title": "OpenStax - Biology",
+        "url": "https://openstax.org/details/books/biology",
+        "description": "Provides free, peer-reviewed, openly licensed textbooks for introductory college and AP-level biology courses."
+    },
+    {
+        "title": "Scitable by Nature Education",
+        "url": "https://www.nature.com/scitable",
+        "description": "A free science library and personal learning tool focusing on genetics, cell biology, and related topics. It offers articles, eBooks, and educational resources from experts and is part of Nature Education."
+    }
+]
 
-# DO NOT REMOVE/EDIT anything outside of the triple quotations. The text shown below must remain unedited within the code: 
-    # def term_prompt(selected_term, selected_context, term_list):
-        # return f"""
 
+# ==============================================
+# 7. AI SYSTEM PROMPT (ADVANCED)
+# ==============================================
+# 
+# THIS SECTION CONTROLS HOW THE AI ASSISTANT BEHAVES
+# Only edit this if you know what you're doing!
+# 
 # DO NOT REMOVE/EDIT anything inside the curly braces = '{selected_term}', '{selected_context}', '{term_list}'
+# These are placeholder variables that get filled in automatically by the app
 
 def term_prompt(selected_term, selected_context, term_list):
-    return f"""You are Pliny 😊, a friendly and knowledgeable AI biology tutor for university students. Your mission is to help students build a robust understanding of these course-relevant biology terms and concepts: '{term_list}' This includes clarifying definitions, providing examples, addressing misconceptions, exploring applications, and encouraging connections between terms. You NEVER directly answer a question without first trying to get the student to answer it themselves EXCEPT if it a term related to the course syllabus, If it is related to the syllabus or course logistics, give a complete and accurate immeditae answer.
+    return f"""You are Pliny 😊, a friendly and knowledgeable AI biology tutor for university students. Your mission is to help students build a robust understanding of these course-relevant biology terms and concepts: '{term_list}' This includes clarifying definitions, providing examples, addressing misconceptions, exploring applications, and encouraging connections between terms. You NEVER directly answer a question without first trying to get the student to answer it themselves EXCEPT if it a term related to the course syllabus, If it is related to the syllabus or course logistics, give a complete and accurate immediate answer.
 
 **Guidelines:**
 
@@ -130,43 +232,3 @@ Assume the student is using R and the tidyverse and has little to no command lin
 By following these instructions, you will provide clear and relevant guidance, helping students learn effectively while maintaining the course's academic integrity.
 """
 
-############################################################################################################
-
-### RESOURCES
-
-# Resources: In this section, you can add links for the student to access and potentially learn more about the topic or verify information.
-# You can add the title of the resource, the URL/file path, and a brief description. To delete or add more resources, follow the same format.
-resources = [
-    {
-        "title": "Course Syllabus",
-        "file_path": "BILD_5_Syllabus_Reuther_SP25.pdf",
-        "description": "Download the course syllabus. **Instructor Note:** You must place the file itself within the same folder as the main app.py file in your GitHub repository."
-    },
-    # In this next line you can add a URLs to the resources section. Just edit the current URL and description. If you need more lines, just copy and paste to add an additional resource. Be wary of deleting or moving any of the commas or braces since this is necessary formatting.
-    {
-        "title": "OpenAI Prompt engineering guide",
-        "url": "https://platform.openai.com/docs/guides/prompt-engineering/six-strategies-for-getting-better-results",
-        "description": "A guide to help you craft effective prompts for the OpenAI chatbot. It includes best practices and examples to improve the quality of responses."
-    },
-    {
-        "title": "UC Berkeley Library Guide to Detecting Fake News",
-        "url": "https://guides.lib.berkeley.edu/fake-news",
-        "description": "This UC Berkeley Library guide offers comprehensive strategies and resources for identifying fake news, understanding its impact, and evaluating the credibility of various news sources, including lists of known fake news sites and tips for detecting misinformation."
-    },
-        {
-        "title": "Is it cheating to use ChatGPT?",
-        "url": "https://guides.lib.berkeley.edu/fake-news",
-        "description": "The UC San Diego Academic Integrity Office provides guidance on the appropriate use of generative AI tools in educational settings, emphasizing the importance of adhering to instructor guidelines and the potential consequences of misuse, including integrity violations and academic penalties."
-    },
-    {
-        "title": "OpenStax - Biology",
-        "url": "https://openstax.org/details/books/biology",
-        "description": "Provides free, peer-reviewed, openly licensed textbooks for introductory college and AP-level biology courses."
-    },
-    {
-        "title": "Scitable by Nature Education",
-        "url": "https://www.nature.com/scitable",
-        "description": "A free science library and personal learning tool focusing on genetics, cell biology, and related topics. It offers articles, eBooks, and educational resources from experts and is part of Nature Education."
-    }
-]
-