app.py

#To access my personal API key from operation system environment variables. 
#Inside the HuggingFace Space, this will be substituted by HF's "Secret" variable option. 
#Feel free to use the tool as is (via my personal API key) for the time of my evaluation.
import os
import time

#Loading Streamlit for GUI
import streamlit as st

#Session variables - saved locally to not run the whole script everytime a user input is entered
if True:
    if "standard_set" not in st.session_state:
        st.session_state.standard_set = False
    if "topic_set" not in st.session_state:
        st.session_state.topic_set = False
    if "content_set" not in st.session_state:
        st.session_state.content_set = False
    if "answer_set" not in st.session_state:
        st.session_state.answer_set = False
    if "evaluated" not in st.session_state:
        st.session_state.evaluated = False
    if "chosen_standard" not in st.session_state:
        st.session_state.chosen_standard = "" 
    if "standard_definition" not in st.session_state:
        st.session_state.standard_definition = ""
    if "question_or_task" not in st.session_state:
        st.session_state.question_or_task = ""
    if "chosen_topic" not in st.session_state:
        st.session_state.chosen_topic = "" 
    if "wikitext" not in st.session_state:
        st.session_state.wikitext = ""
    if "context" not in st.session_state:
        st.session_state.context = ""
    if "frq" not in st.session_state:
        st.session_state.frq = "" 
    if "chosen_answer" not in st.session_state:
        st.session_state.chosen_answer = ""
answer_logged=False


#Importing variables, objects, templates from "common"
from common import llm, wikipedia #language models
from common import standard_definition_dict, question_or_task_dict, rubric_dict #dictionaries
from common import prompt_context, prompt_frq, prompt_evaluation #prompt templates
from common import context_chain, frq_chain, evaluation_chain #prompting chains
from common import trim_text, plagiate #custom functions


#Setting up streamlit UI, intro
st.set_page_config(page_title="FQR Generator", page_icon="🎓", 
                menu_items={"About":"Version 1.0 \n\n Not for commercial use.", 
                "Get help":"https://www.linkedin.com/in/alex-c-fischer"})
st.title("🎓Common Core FRQ Generator") 
with st.sidebar:
    st.title("Menu")
    st.link_button(label="Admin", url="https://huggingface.co/spaces/AlexCasF/QCTestRun")
    st.link_button(label="Contact", url="https://www.linkedin.com/in/alex-c-fischer/")
st.write("This little tool automatically generates free-response questions (FQRs) \
        to evaluate a 4th grade student's knowledge of a given Common Core Writing Standard \
        by reading and writing on a topic of their own choice. \
        After the FRQ is answered, an evaluation will be provided.") 
st.write("(The language processing is done by an AI model, \
        yet the facts are sourced from the topic's wikipedia page, to ensure hallucination-free and up-to-date content.)" )


#FRQ based on standard, student input and prompting engine
with st.form("standard_form"):
    st.session_state.chosen_standard = st.selectbox(
        "Choose 4th Grade Common Core Writing standard:",
        ("CCSS.ELA-LITERACY.W.4.1","CCSS.ELA-LITERACY.W.4.2","CCSS.ELA-LITERACY.W.4.3","CCSS.ELA-LITERACY.W.4.4",
         "CCSS.ELA-LITERACY.W.4.5","CCSS.ELA-LITERACY.W.4.6","CCSS.ELA-LITERACY.W.4.7","CCSS.ELA-LITERACY.W.4.8",
         "CCSS.ELA-LITERACY.W.4.9","CCSS.ELA-LITERACY.W.4.10")
        )
    st.session_state.standard_definition = standard_definition_dict[st.session_state.chosen_standard]
    st.session_state.question_or_task = question_or_task_dict[st.session_state.chosen_standard]
    subm_standard =st.form_submit_button("Set")
if subm_standard:
    st.session_state.standard_set=True
    st.write("We will test your ability to:")
    st.write(f"📜{st.session_state.standard_definition}.")
if st.session_state.standard_set:
    with st.form("topic_form"):
        st.session_state.chosen_topic = st.text_input("Type in a topic of your interest, then click 'Submit'.")
        subm_topic = st.form_submit_button("Submit")
if st.session_state.standard_set and subm_topic:
    st.empty()
    with st.spinner('🤖Browsing wikipedia...'):
        st.empty()
        if st.session_state.wikitext=="":
            wikitext = trim_text(wikipedia.run(st.session_state.chosen_topic))
    if wikitext=="No good Wikipedia Search Result was found":
        st.write(f"🤖Sorry - I can't find anything in wikipedia on '{st.session_state.chosen_topic}'. \
                    I would love to make something up, but I can't do that in here. Please try something else.")
        got_it = st.button("Got it")
        st.session_state.topic_set=False
        st.stop()
    else:
        st.session_state.wikitext = wikitext
        st.session_state.topic_set=True
    st.success("Article found")
    st.empty()
    with st.spinner('🤖So interesting! Now please give me a few seconds to create the context and FRQ.'): 
        st.empty()  
        if st.session_state.context=="": 
            st.session_state.context = context_chain.run(
                chosen_topic=st.session_state.chosen_topic, 
                wikitext=st.session_state.wikitext
                )
        if st.session_state.frq=="":     
            st.session_state.frq = frq_chain.run(
                context=st.session_state.context, 
                standard_definition=st.session_state.standard_definition, 
                question_or_task=st.session_state.question_or_task
                )
    st.success("Content and FRQ created")
    st.empty()
if st.session_state.topic_set:   
    with st.form("content_form"):      
        st.write("🤖Here we go - that was quick, wasn't it?")
        st.subheader("Context required to answer the FRQ:")
        st.write(st.session_state.context)
        st.subheader("Free Response Question:")
        st.write(st.session_state.frq)
        st.write("🤖Read all of the above? Great! Continue with the assignment at your own pace.")
        next = st.form_submit_button("Continue")
        if next:
            st.session_state.content_set=True
if st.session_state.content_set:
    with st.form("answer_form"):
        st.session_state.chosen_answer = st.text_area("Type in your answer, then click 'Submit'. Please do not simply copy/paste from above.")
        subm_answer = st.form_submit_button("Submit")
if st.session_state.content_set and subm_answer:
    with st.spinner('🤖Logging...'):
        pass
    if len(st.session_state.chosen_answer) and plagiate(context=st.session_state.context, answer=st.session_state.chosen_answer):   
        st.session_state.content_set=False          
        st.write("🤖Using Crtl+C/P defeats the purpose of this test, young friend.")
        time.sleep(0.1)
        st.write("🤖Those are the rules. Please overwrite above answer in your own words - \
                trust me, this is a great way to learn interesting new things.")
        got_it = st.button("Got it")  
        st.stop()    
    else:
        st.subheader("Answer submitted") 
        answer_logged=True
if  answer_logged:      
    st.session_state.answer_set=True    
if st.session_state.answer_set:
    with st.form("evaluation_form"):
        st.subheader("Evaluation")
        with st.spinner("🤖Let me see how you did today."):
            evaluation = evaluation_chain.run(
                context=st.session_state.context, 
                rubric=rubric_dict[st.session_state.chosen_standard], 
                frq=st.session_state.frq, 
                chosen_answer=st.session_state.chosen_answer)
        st.write(evaluation)
        def clear_form():
            st.session_state.answer_set=False
            next
        st.form_submit_button(label="Reformulate answer", on_click=clear_form) 
        st.empty()
    with st.expander("Show Evaluation & Feedback Rubric"):
        st.write("✔️ AI evaluated the student's ability to:")
        st.text(rubric_dict[st.session_state.chosen_standard])
    rerun = st.button("Rerun")
    if rerun:
        for key in st.session_state.keys():
            del st.session_state[key]
        st.rerun()
    st.divider()
    st.write("Admin area: clicking below will open a new app")
    st.link_button(label="QC Test run - let GPT-4 take this test", url="https://huggingface.co/spaces/AlexCasF/QCTestRun")