initial commit

.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

.idea/aws.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="accountSettings">
+    <option name="activeProfile" value="profile:default" />
+    <option name="activeRegion" value="us-west-1" />
+    <option name="recentlyUsedProfiles">
+      <list>
+        <option value="profile:default" />
+      </list>
+    </option>
+    <option name="recentlyUsedRegions">
+      <list>
+        <option value="us-west-1" />
+      </list>
+    </option>
+  </component>
+</project>

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,14 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="JSHint" enabled="true" level="ERROR" enabled_by_default="true" />
+    <inspection_tool class="PyPep8NamingInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
+      <option name="ignoredErrors">
+        <list>
+          <option value="N803" />
+        </list>
+      </option>
+    </inspection_tool>
+  </profile>
+</component>

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.11 (wrAIte) (2)" project-jdk-type="Python SDK" />
+</project>

.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/wrAIte.iml" filepath="$PROJECT_DIR$/.idea/wrAIte.iml" />
+    </modules>
+  </component>
+</project>

.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

.idea/wrAIte.iml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/venv" />
+    </content>
+    <orderEntry type="jdk" jdkName="Python 3.11 (wrAIte) (2)" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

README.md

@@ -1,8 +1,8 @@
 ---
 title: WrAIte
-emoji: 🏃
-colorFrom: gray
-colorTo: pink
+emoji: 📉
+colorFrom: pink
+colorTo: blue
 sdk: gradio
 sdk_version: 4.28.3
 app_file: app.py
@@ -10,3 +10,12 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+
+# Setup
+
+## Create and activate virtual environment
+1. Create venv in writingmate directory: `python3 -m venv venv`
+2. Activate virtual environment: `source venv/bin/activate`
+## Install requirements
+`pip3 install -r requirements.txt`

app.py

@@ -0,0 +1,311 @@
+import json
+import os
+import gradio as gr
+from matplotlib import pyplot as plt
+
+from pymongo_get_database import MongoDBManager
+from utils import process_markdown, save_answer, randomly_select_prompts, generate_unassisted_question, \
+    generate_assisted_question, randomize_questions
+
+from experiment_details import problem_topics, problems_per_topic, writing_skills_questions
+from questionnaire import generate_questionnaire
+from data import problems
+from datetime import datetime
+from data_storage import store_user_data
+import uuid
+
+mongo_manager = MongoDBManager()
+
+user_id = str(uuid.uuid4())
+mongo_manager.create_user_record(user_id)
+# radio button and button rendering: https://www.gradio.app/docs/radio
+questionnaire_results = {
+    'Demographic Details': {},
+    'User Capabilities': {},
+    'Relationship to System': {},
+    'System Output Preferences': {}
+}
+question_answers = {
+    'q1': {
+        'Response': None,
+        'Assistance': None,
+        'CompletionTime': None,
+        'StartTime': None,
+        'EndTime': None
+    },
+    'q2': {
+        'Response': None,
+        'Assistance': None,
+        'CompletionTime': None,
+        'StartTime': None,
+        'EndTime': None
+    },
+    'q3': {
+        'Response': None,
+        'Assistance': None,
+        'CompletionTime': None,
+        'StartTime': None,
+        'EndTime': None
+    },
+    'q4': {
+        'Response': None,
+        'Assistance': None,
+        'CompletionTime': None,
+        'StartTime': None,
+        'EndTime': None
+    },
+    'q5': {
+        'Response': None,
+        'Assistance': None,
+        'CompletionTime': None,
+        'StartTime': None,
+        'EndTime': None
+    },
+    'q6': {
+        'Response': None,
+        'Assistance': None,
+        'CompletionTime': None,
+        'StartTime': None,
+        'EndTime': None
+    },
+    'q7': {
+        'Response': None,
+        'Assistance': None,
+        'CompletionTime': None,
+        'StartTime': None,
+        'EndTime': None
+    },
+    'q8': {
+        'Response': None,
+        'Assistance': None,
+        'CompletionTime': None,
+        'StartTime': None,
+        'EndTime': None
+    },
+}
+
+with gr.Blocks(title="wrAIte") as demo:
+    with gr.Column("Survey Complete", render=True, visible=False) as completed_screen:
+        instr_complete = process_markdown(False, 'instr_completed.md')
+        survey_complete = gr.Markdown(value=instr_complete)
+
+    questionnaire = generate_questionnaire(questionnaire_results, completed_screen, user_id)
+    questionnaire.render()
+
+    with gr.Column("", render=True, visible=False) as assessment:
+        selected_questions = randomly_select_prompts()
+        question_prompts = randomize_questions(selected_questions)
+
+
+        def next_q8():
+            question_answers['q8']['EndTime'] = datetime.now().isoformat()
+            question_answers['q8']['CompletionTime'] = str(datetime.fromisoformat(question_answers['q8']['EndTime']) -
+                                                           datetime.fromisoformat(question_answers['q8']['StartTime']))
+            store_user_data(user_id, "questions", question_answers)
+            mongo_manager.update_question_answers(user_id, question_answers)
+            return {
+                question8: gr.update(visible=False),
+                questionnaire: gr.update(visible=True)
+            }
+
+
+        def next_q7():
+            question_answers['q7']['EndTime'] = datetime.now().isoformat()
+            question_answers['q7']['CompletionTime'] = str(datetime.fromisoformat(question_answers['q7']['EndTime']) -
+                                                           datetime.fromisoformat(question_answers['q7']['StartTime']))
+            question_answers['q8']['StartTime'] = datetime.now().isoformat()
+            return {
+                question7: gr.update(visible=False),
+                question8: gr.update(visible=True)
+            }
+
+
+        def next_q6():
+            question_answers['q6']['EndTime'] = datetime.now().isoformat()
+            question_answers['q6']['CompletionTime'] = str(datetime.fromisoformat(question_answers['q6']['EndTime']) -
+                                                           datetime.fromisoformat(question_answers['q6']['StartTime']))
+            question_answers['q7']['StartTime'] = datetime.now().isoformat()
+            return {
+                question6: gr.update(visible=False),
+                question7: gr.update(visible=True)
+            }
+
+
+        def next_q5():
+            question_answers['q5']['EndTime'] = datetime.now().isoformat()
+            question_answers['q5']['CompletionTime'] = str(datetime.fromisoformat(question_answers['q5']['EndTime']) -
+                                                           datetime.fromisoformat(question_answers['q5']['StartTime']))
+            question_answers['q6']['StartTime'] = datetime.now().isoformat()
+            return {
+                question5: gr.update(visible=False),
+                question6: gr.update(visible=True)
+            }
+
+
+        def next_q4():
+            question_answers['q4']['EndTime'] = datetime.now().isoformat()
+            question_answers['q4']['CompletionTime'] = str(datetime.fromisoformat(question_answers['q4']['EndTime']) -
+                                                           datetime.fromisoformat(question_answers['q4']['StartTime']))
+            question_answers['q5']['StartTime'] = datetime.now().isoformat()
+            return {
+                question4: gr.update(visible=False),
+                question5: gr.update(visible=True)
+            }
+
+
+        def next_q3():
+            question_answers['q3']['EndTime'] = datetime.now().isoformat()
+            question_answers['q3']['CompletionTime'] = str(datetime.fromisoformat(question_answers['q3']['EndTime']) -
+                                                           datetime.fromisoformat(question_answers['q3']['StartTime']))
+            question_answers['q4']['StartTime'] = datetime.now().isoformat()
+            return {
+                question3: gr.update(visible=False),
+                question4: gr.update(visible=True)
+            }
+
+
+        def next_q2():
+            question_answers['q2']['EndTime'] = datetime.now().isoformat()
+            question_answers['q2']['CompletionTime'] = str(datetime.fromisoformat(question_answers['q2']['EndTime']) -
+                                                           datetime.fromisoformat(question_answers['q2']['StartTime']))
+            question_answers['q3']['StartTime'] = datetime.now().isoformat()
+            return {
+                question2: gr.update(visible=False),
+                question3: gr.update(visible=True)
+            }
+
+
+        def next_q1():
+            question_answers['q1']['EndTime'] = datetime.now().isoformat()
+            question_answers['q1']['CompletionTime'] = str(datetime.fromisoformat(question_answers['q1']['EndTime']) -
+                                                           datetime.fromisoformat(question_answers['q1']['StartTime']))
+            question_answers['q2']['StartTime'] = datetime.now().isoformat()
+            return {
+                question1: gr.update(visible=False),
+                question2: gr.update(visible=True)
+            }
+
+
+        with gr.Column("Question 8", render=True, visible=False) as question8:
+            next_q8_btn = gr.Button("Next Question", render=False, visible=False, variant="primary")
+            q8 = generate_assisted_question(question_prompts[7], next_q8_btn, 8, question_answers)
+            q8.render()
+            next_q8_btn.render()
+            next_q8_btn.click(
+                fn=next_q8,
+                inputs=[],
+                outputs=[question8, questionnaire]
+            )
+        with gr.Column("Question 7", render=True, visible=False) as question7:
+            next_q7_btn = gr.Button("Next Question", render=False, visible=False, variant="primary")
+            q7 = generate_unassisted_question(question_prompts[6], next_q7_btn, 7, question_answers)
+            q7.render()
+            next_q7_btn.render()
+            next_q7_btn.click(
+                fn=next_q7,
+                inputs=[],
+                outputs=[question7, question8]
+            )
+        with gr.Column("Question 6", render=True, visible=False) as question6:
+            next_q6_btn = gr.Button("Next Question", render=False, visible=False, variant="primary")
+            q6 = generate_unassisted_question(question_prompts[5], next_q6_btn, 6, question_answers)
+            q6.render()
+            next_q6_btn.render()
+            next_q6_btn.click(
+                fn=next_q6,
+                inputs=[],
+                outputs=[question6, question7]
+            )
+        with gr.Column("Question 5", render=True, visible=False) as question5:
+            next_q5_btn = gr.Button("Next Question", render=False, visible=False, variant="primary")
+            q5 = generate_unassisted_question(question_prompts[4], next_q5_btn, 5, question_answers)
+            q5.render()
+            next_q5_btn.render()
+            next_q5_btn.click(
+                fn=next_q5,
+                inputs=[],
+                outputs=[question5, question6]
+            )
+        with gr.Column("Question 4", render=True, visible=False) as question4:
+            next_q4_btn = gr.Button("Next Question", render=False, visible=False, variant="primary")
+            q4 = generate_assisted_question(question_prompts[3], next_q4_btn, 4, question_answers)
+            q4.render()
+            next_q4_btn.render()
+            next_q4_btn.click(
+                fn=next_q4,
+                inputs=[],
+                outputs=[question4, question5]
+            )
+        with gr.Column("Question 3", render=True, visible=False) as question3:
+            next_q3_btn = gr.Button("Next Question", render=False, visible=False, variant="primary")
+            q3 = generate_unassisted_question(question_prompts[2], next_q3_btn, 3, question_answers)
+            q3.render()
+            next_q3_btn.render()
+            next_q3_btn.click(
+                fn=next_q3,
+                inputs=[],
+                outputs=[question3, question4]
+            )
+        with gr.Column("Question 2", render=True, visible=False) as question2:
+            next_q2_btn = gr.Button("Next Question", render=False, visible=False, variant="primary")
+            q2 = generate_assisted_question(question_prompts[1], next_q2_btn, 2, question_answers)
+            q2.render()
+            next_q2_btn.render()
+            next_q2_btn.click(
+                fn=next_q2,
+                inputs=[],
+                outputs=[question2, question3]
+            )
+        with gr.Column("Question 1", render=True, visible=True) as question1:
+            next_q1_btn = gr.Button("Next Question", render=False, visible=False, variant="primary")
+            q1 = generate_unassisted_question(question_prompts[0], next_q1_btn, 1, question_answers)
+            q1.render()
+            next_q1_btn.render()
+            next_q1_btn.click(
+                fn=next_q1,
+                inputs=[],
+                outputs=[question1, question2]
+            )
+
+    def start_assessment():
+        question_answers['q1']['StartTime'] = datetime.now().isoformat()
+        return {
+            welcome_pg: gr.update(visible=False),
+            assessment: gr.update(visible=True)
+        }
+
+    with gr.Column("Welcome to wrAIte", visible=True) as welcome_pg:
+        welcome_instr = process_markdown(False, 'instr_welcome.md')
+        welcome_text = gr.Markdown(value=welcome_instr, visible=True)
+        welcome_continue_btn = gr.Button("Continue", variant="primary", visible=True)
+
+        study_instr = process_markdown(False, 'instr_study.md')
+        study_text = gr.Markdown(value=study_instr, visible=False)
+        study_continue_btn = gr.Button("Begin Study", variant="primary", visible=False)
+
+
+        def show_study_instructions():
+            return {
+                welcome_text: gr.update(visible=False),
+                welcome_continue_btn: gr.update(visible=False),
+                study_text: gr.update(visible=True),
+                study_continue_btn: gr.update(visible=True),
+            }
+
+
+        welcome_continue_btn.click(
+            fn=show_study_instructions,
+            inputs=[],
+            outputs=[welcome_text, welcome_continue_btn, study_text, study_continue_btn]
+        )
+
+        study_continue_btn.click(
+            fn=start_assessment,
+            inputs=[],
+            outputs=[welcome_pg, assessment]
+        )
+
+
+# if __name__ == "__main__":
+# demo.launch()
+demo.launch(share=True)

constants.py

@@ -0,0 +1,23 @@
+MAX_CONVERSATION_LENGTH = 20
+MAX_TOKENS_PER_GENERATION = 512
+SAMPLING_TEMPERATURE = 0.
+
+plaintxt_instructions = [
+    ["Welcome to our study!",
+     "In this task, you will be interacting with AI systems to explore how well AI systems can assist in various writing tasks.",
+     "Your responses will inform AI, writing, and potentially human-computer interaction research.",
+     "By participating in this study, you consent to having your responses stored and used for publication.",
+     "Your email and other identifying information (beyond level of mathematical expertise) will not be stored.",
+     "Please only continue if you are comfortable with the above."],
+    [
+        "In this study, you will be <strong>posed with writing tasks</strong> (e.g., theorems) and asked to <strong>evaluate how good different AI systems are at <i>helping to assist</i> in that writing task.</strong>",
+        "You may evaluate a maximum of four problems (two sets of two writing tasks over the two models). You will be given a writing task per writing challenge (e.g. creative short story writing, informative email writing).",
+        "Note: You will be assisted based on your initial responses to our preliminary questions."]
+]
+
+model_options = [
+    "chatgpt",
+    "instructgpt",
+    "chatgpt4"
+]
+

data/instructions/instr_assisted.md

@@ -0,0 +1 @@
+## Please read the instructions below. Interact with the writing helper to explore how it may assist you in answering the following prompt. Write your response in the following text box.

data/instructions/instr_completed.md

@@ -0,0 +1 @@
+## Thank you! You have successfully completed this survey.

data/instructions/instr_editresponse.md

@@ -0,0 +1 @@
+### To edit your response, please click the button below. You will no longer be able to edit the previous question once you proceed.

data/instructions/instr_email.md

@@ -0,0 +1 @@
+## Instructions: Write an email for the following scenario in under 300 words.

data/instructions/instr_proceed.md

@@ -0,0 +1 @@
+## Please click on the button below to proceed to the next question.

data/instructions/instr_questionnaire.md

@@ -0,0 +1,2 @@
+# Post-Assesment Questionnaire
+## Please answer all of the questions below as objectively as you can.

data/instructions/instr_shortstory.md

@@ -0,0 +1 @@
+## Instructions: Write a short story (300 words or less) which only uses very simple words.

data/instructions/instr_study.md

@@ -0,0 +1,7 @@
+## In this study, you will be posed with eight (8) writing prompts and asked to write a response to each of them.
+## You will be given AI assistance for some prompts, and you will need to respond to others on your own.
+## There will be a total of 4 writing categories (creative short story writing, informative email writing, title generation, and summarization). For each category you will be answering one assisted prompt and one unassisted prompt.
+##
+## After you finish answering the writing prompts, you will complete a questionnaire regarding your background information, writing skills, and experience interacting with LLMs (Large Language Models).
+##
+## Click the button below when you are ready to begin the study.

data/instructions/instr_submitsuccess.md

@@ -0,0 +1 @@
+## The following response has been successfully submitted:

data/instructions/instr_summary.md

@@ -0,0 +1 @@
+## Instructions: Summarize the following article in 100 words or less.

data/instructions/instr_title.md

@@ -0,0 +1 @@
+## Instructions: Write a creative title for the following article using 10 words or less.

data/instructions/instr_unassisted.md

@@ -0,0 +1 @@
+## Please read the instructions and writing prompt below. Write your response in the following text box.

data/instructions/instr_welcome.md

@@ -0,0 +1,7 @@
+## Welcome to our study!
+
+## In this task, you will be interacting with AI systems to explore how well AI systems can assist in answering writing prompts.
+## Your responses will inform AI, writing, and potentially human-computer interaction research.
+## By participating in this study, you consent to having your responses stored and used for publication.
+## Your email and other identifying information (beyond level of writing expertise) will not be stored.
+## Please only continue if you are comfortable with the above.

data/problems/p_email1.md

@@ -0,0 +1 @@
+### You are organizing an outdoor team-building event aimed at improving team communication. Draft an email inviting colleagues, including details like date, time, and activities in your email.

data/problems/p_email10.md

@@ -0,0 +1 @@
+### You wish to receive guidance from a more experienced person in your company. Write an email to someone at your company that you admire, explaining your current position, your career goals, and politely asking if they would be willing to mentor you.

data/problems/p_email2.md

@@ -0,0 +1 @@
+### You recently ordered a coffee maker online, CoffeeCreate 3.0, which arrived defective. Compose an email to CoffeeCreate to complain about your purchase, asking for a replacement or refund and mentioning that it won't turn on despite troubleshooting.

data/problems/p_email3.md

@@ -0,0 +1 @@
+### You are planning a surprise birthday party for a friend and need a venue. Write an email to a local community center named City LCC inquiring about the availability of rooms for the event, including details on capacity and pricing.

data/problems/p_email4.md

@@ -0,0 +1 @@
+### Your party decoration order purchase from Decor Co. was supposed to arrive last week but hasn't come yet. Compose an email to Decor Co. asking about the status of your order and expressing the urgency of receiving it.

data/problems/p_email5.md

@@ -0,0 +1 @@
+### After receiving career advice during a one-on-one session, write a thank-you email to your mentor, expressing your appreciation and discussing key takeaways, such as recommended training courses and networking strategies.

data/problems/p_email6.md

@@ -0,0 +1 @@
+### You have been subscribed to a monthly gourmet snack delivery service, MonthlySnacks. While you enjoyed the deliveries, they don't fit your budget anymore. Write an email to the MonthlySnacks requesting the cancellation of your monthly subscription, including your financial reasons.

data/problems/p_email7.md

@@ -0,0 +1 @@
+### You recently read a blog post on the impact of seasonal ingredients on cooking. You noticed that it did not include some key spices that could enhance the flavors further. Write an email to the food blog author providing constructive feedback, suggesting the inclusion of these spices and asking about their personal favorite seasonal recipes.

data/problems/p_email8.md

@@ -0,0 +1 @@
+### You have noticed your colleague often schedules meetings and cancels at the last minute, which has been frustrating for you. Write an email to express your feelings clearly and respectfully.

data/problems/p_email9.md

@@ -0,0 +1 @@
+### You are interested in attending an upcoming seminar on leadership and personal development that is highly relevant to your current role. Write an email to the seminar organizers asking for more details about the topics to be covered, the speakers, and the registration process.

data/problems/p_shortstory1.md

@@ -0,0 +1 @@
+## The story should use the verb "hang", the noun "foot" and the adjective "cute". The story should contain at least one dialogue. 

data/problems/p_shortstory10.md

@@ -0,0 +1 @@
+ ## The story should use the verb "jog", the noun "purple" and the adjective "noisy". The story should contain at least one dialogue, have a bad ending, and have a moral value.

data/problems/p_shortstory2.md

@@ -0,0 +1 @@
+## In the story, try to at some point use the verb "hope", the noun "search" and the adjective "comfortable".

data/problems/p_shortstory3.md

@@ -0,0 +1 @@
+## In the story, try to at some point use the verb "pull", the noun "idea" and the adjective "sad". The story should also have a bad ending.

data/problems/p_shortstory4.md

@@ -0,0 +1 @@
+## The story should use the verb "say", the noun "herb" and the adjective "shy".