update

pages/1_single_evaluation.py

@@ -35,6 +35,23 @@ def check_password():
 # Title of the application
 st.title('Natural Language Explanation Demo')
 
+# Description of the application
+st.write("""
+### Welcome to the Natural Language Explanation Demo
+This application allows you to evaluate the quality of explanations generated for various questions using different language models. You can either use predefined examples or input your own questions and explanations.
+""")
+
+# Explanation of principles
+st.write("""
+### Explanation Principles
+When evaluating explanations, consider the following principles mapped to user empowerment and regulatory compliance outcomes:
+
+1. **Factually Correct**: The information should be accurate and relevant to empower users and meet external audit requirements.
+2. **Useful**: Explanations should be clear and meaningful, helping users make informed decisions.
+3. **Context Specific**: Explanations should be tailored to the context of use, enhancing their relevance and utility.
+4. **User Specific**: Explanations should address the needs and preferences of the user, enabling better decision-making.
+5. **Provide Pluralism**: Explanations should present diverse perspectives, allowing users to understand different viewpoints and make well-rounded decisions.
+""")
 # Check if password has been validated
 if not st.session_state.get('password_correct', False):
     check_password()

pages/2_batch_evaluation.py

@@ -49,6 +49,23 @@ def batch_evaluate(uploaded_file):
 # Title of the application
 st.title('Natural Language Explanation Demo')
 
+# Description of the application
+st.write("""
+### Welcome to the Natural Language Explanation Demo
+This application allows you to evaluate the quality of explanations generated for various questions using different language models. You can either use predefined examples or input your own questions and explanations.
+""")
+
+# Explanation of principles
+st.write("""
+### Explanation Principles
+When evaluating explanations, consider the following principles mapped to user empowerment and regulatory compliance outcomes:
+
+1. **Factually Correct**: The information should be accurate and relevant to empower users and meet external audit requirements.
+2. **Useful**: Explanations should be clear and meaningful, helping users make informed decisions.
+3. **Context Specific**: Explanations should be tailored to the context of use, enhancing their relevance and utility.
+4. **User Specific**: Explanations should address the needs and preferences of the user, enabling better decision-making.
+5. **Provide Pluralism**: Explanations should present diverse perspectives, allowing users to understand different viewpoints and make well-rounded decisions.
+""")
 # Check if password has been validated
 if not st.session_state.get('password_correct', False):
     check_password()
@@ -56,18 +73,27 @@ else:
     st.sidebar.success("Password Verified. Proceed with the demo.")
 
     st.write("""
-    ### Instructions for Uploading CSV
-    Please upload a CSV file with the following columns:
-    - `question`: The question you want evaluated.
-    - `explanation`: The explanation corresponding to the question.
-
-    **Example CSV Format:**
-    ```
-    question,explanation
-    "What causes rainbows to appear in the sky?","Rainbows appear when sunlight is refracted, dispersed, and reflected inside water droplets in the atmosphere, resulting in a spectrum of light appearing in the sky."
-    "Why is the sky blue?","The sky is blue because molecules in the air scatter blue light from the sun more than they scatter red light."
-    ```
-    """)
+        ### Instructions for Uploading CSV
+        Please upload a CSV file with the following columns:
+        - `question`: The question you want evaluated.
+        - `explanation`: The explanation corresponding to the question.
+
+        **Example CSV Format:**
+        """)
+
+    # Display an example DataFrame
+    example_data = {
+        "question": [
+            "What causes rainbows to appear in the sky?",
+            "Why is the sky blue?"
+        ],
+        "explanation": [
+            "Rainbows appear when sunlight is refracted, dispersed, and reflected inside water droplets in the atmosphere, resulting in a spectrum of light appearing in the sky.",
+            "The sky is blue because molecules in the air scatter blue light from the sun more than they scatter red light."
+        ]
+    }
+    example_df = pd.DataFrame(example_data)
+    st.dataframe(example_df)
 
     uploaded_file = st.file_uploader("Upload CSV file with 'question' and 'explanation' columns", type=['csv'])