From 84bcd9a068116d0cff042cc6b4aca87c1ea69978 Mon Sep 17 00:00:00 2001
From: kyleclo <kyleclo@uw.edu>
Date: Sat, 14 Dec 2024 00:34:38 -0800
Subject: [PATCH] experiments

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eee22f7..c82e3bd 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
-# drawedumath
+# DrawEduMath
+
+DrawEduMath is a benchmark dataset of 2,030 annotated K-12 student math work images with dense captions and 11,661 QA pairs, all written by real-world teachers. 
+
+### Using VLMs to answer questions about student math work
+
+Run example scripts at:
+```
+|-- scripts/
+    |-- vlm_generations/
+        |-- openai.py
+        |-- anthropic.py
+        |-- google.py
+```
+
+Our prompts are stored in `data/qa_prompt/`
+
+### Using LMs to analyze image captions
+
+Run example scripts at:
+```
+|-- scripts/
+    |-- caption_analysis/
+        |-- caption_to_facets.py
+```
+
+Our prompts are stored in `data/caption_prompt/`
+
+