Update README.md

README.md

@@ -1,56 +1,90 @@
----
-dataset_info:
-  features:
-  - name: pun
-    dtype: string
-  - name: prefix
-    dtype: string
-  - name: definition
-    dtype: string
-  - name: answer
-    sequence: string
-  - name: phonetic
-    dtype: int64
-  - name: realistic
-    dtype: int64
-  - name: typology
-    sequence: string
-  - name: __index_level_0__
-    dtype: int64
-  splits:
-  - name: main
-    num_bytes: 49417
-    num_examples: 350
-  - name: contaminated
-    num_bytes: 2642
-    num_examples: 20
-  - name: few_shot
-    num_bytes: 1382
-    num_examples: 10
-  download_size: 37114
-  dataset_size: 53441
-configs:
-- config_name: default
-  data_files:
-  - split: main
-    path: data/main-*
-  - split: contaminated
-    path: data/contaminated-*
-  - split: few_shot
-    path: data/few_shot-*
-license: mit
-task_categories:
-- question-answering
-language:
-- en
----
-
-# Phunny dataset for humor-based question answering
-
-Phunny comprises 350 instances, each representing a novel, non-contaminated English pun.
-
-
-### Data Fields
+---
+dataset_info:
+  features:
+  - name: pun
+    dtype: string
+  - name: prefix
+    dtype: string
+  - name: definition
+    dtype: string
+  - name: answer
+    sequence: string
+  - name: phonetic
+    dtype: int64
+  - name: realistic
+    dtype: int64
+  - name: typology
+    sequence: string
+  - name: __index_level_0__
+    dtype: int64
+  splits:
+  - name: main
+    num_bytes: 49417
+    num_examples: 350
+  - name: contaminated
+    num_bytes: 2642
+    num_examples: 20
+  - name: few_shot
+    num_bytes: 1382
+    num_examples: 10
+  download_size: 37114
+  dataset_size: 53441
+configs:
+- config_name: default
+  data_files:
+  - split: main
+    path: data/main-*
+  - split: contaminated
+    path: data/contaminated-*
+  - split: few_shot
+    path: data/few_shot-*
+license: mit
+task_categories:
+- question-answering
+language:
+- en
+---
+
+# Phunny: A Humor-Based QA Benchmark for Evaluating LLM Generalization
+
+Welcome to **Phunny**, a humor-based question answering (QA) benchmark designed to evaluate the reasoning and generalization abilities of large language models (LLMs) through structured puns.
+
+This repository accompanies our **ACL 2025 main track paper**:  
+["What do you call a dog that is incontrovertibly true? Dogma: Testing LLM Generalization through Humor"](https://aclanthology.org/2025.acl-long.1117.pdf)
+
+## Overview
+
+**Phunny** consists of 350 novel, manually curated structured puns, created through a two-stage process: creative human design followed by automated contamination checks to ensure novelty.
+
+All puns follow the same strcuture: 
+```
+What do you call a X that Y? XZ
+```
+
+- **X** is a prefix (subword of XZ)
+- **Y** is a natural language definition of the answer XZ
+- **XZ** is the pun answer (that starts with the prefix X), meant to be humorous
+
+For example:
+
+> What do you call a dog that is incontrovertibly true? **Dogma**  
+> → “Dog” (X) + “dogma” (XZ), where “dogma” means a set of incontrovertible truths.
+
+We define three tasks to evaluate different aspects of LLM capabilities:
+
+- **Pun Comprehension**  
+  Can an LLM distinguish between coherent and nonsensical puns?
+
+- **Pun Resolution**  
+  Can an LLM infer the correct punchline based on the setup?
+
+- **Pun Generation**  
+  Can an LLM produce novel Phunny-style puns? We test this in two modes:  
+  - *Free*: unconstrained generation  
+  - *Constrained*: generation based on a provided prefix X
+
+     
+## Data Fields
 
 - `pun`: the complete pun (question/answer)
 - `prefix`: the subject of the question/pun
@@ -60,14 +94,14 @@ Phunny comprises 350 instances, each representing a novel, non-contaminated Engl
 - `realistic`: whether the pun itself is real
 - `typology`: whether the prefix itself is a noun, adjective, or verb
 
-### Data Splits
+## Data Splits
 
 This dataset has 3 splits: _main_, _contaminated_, and _few_shot_.
 
 | Dataset Split | Number of Instances | Content                                                                        |
 | ------------- | --------------------| ------------------------------------------------------------------------------ |
 | Main          | 350                 | set of puns used in our experiments to evaluate LLMs                           |
-| Contaminated  | 20                  | list of Phunny-like puns already present on the web                            |
+| Contaminated  | 20                  | list of Phunny-like puns already present on the web (excluded from our evaluation)                            |
 | Few-shot      | 10                  | puns used as in-context exemples for the Resolution and Generation tasks       |
 
 # Cite article