Update README.md

README.md

@@ -1,3 +1,133 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+---
+
+# TOMT-KIS Dataset
+
+## Description
+
+Searchers who cannot resolve a known-item information need using a search engine (e.g., as the searcher only remembers vague details about a movie from some years ago) might post a respective question on a question answering platform, hoping that the discussion with other people can help to identify the item.
+
+TOMT-KIS is a large-scale dataset of 1.28 million known-item questions (47 % have an identified answer) from the r/tipofmytongue subreddit we proposed in [A Large-Scale Dataset for Known-Item Question Performance Prediction](https://downloads.webis.de/publications/papers/froebe_2023c.pdf). As the "performance" of a known-item question, we use the time it took the community to solve the question (or the absence of a solution).
+
+
+## Dataset Creation
+
+In the following section, we describe the process of generating our TOMT-KIS dataset.
+
+### Source Data
+
+To create our TOMT-KIS dataset, we have crawled all questions and discussions from the [tip-of-my-tongue subreddit](https://www.reddit.com/r/tipofmytongue/?rdt=47529). Note that answers are not explicitly tagged in the subreddit discussions, but the guidelines state that the asker should reply with "Solved!" to a post with the correct answer. However, analyzing different questions from the subreddit lead to the observation that askers often do not reply to the correct answer with "Solved!", but with other posts (e.g., "This was it!"). In addition to such replies by the author of the question in the comment thread of the question, there is a further metadata field that indicates whether a question is solved.
+
+### Answer Identification
+
+For questions that the moderator metadata indicates as solved, we use four manually created lexical patterns as a rule-based answer identification method: if a post from the asker in reply to a post contains ‘solved’, ‘thank’, ‘yes’, or ‘amazing’, we view this post as the answer. On 50 random questions and 50 questions for which this heuristic identified an answer (none of them used to develop the rules), the achieved precision is 92 % at a recall of 78 %.
+
+
+### Dataset Analysis
+
+Many questions in the tip-of-the-tongue subreddit have assigned tags that roughly describe an assumed category of the known item. Besides \[tomt\] (all questions have this tag), a question has between 0 and 14 tags (average: 0.89), some of which directly express uncertainty (e.g., \[2010s?\] vs. \[2010s\]). For further analyses, we manually merged the original tags to form larger categories (e.g., combining \[song\], \[music\], etc. to a “Music” category).
+
+The ten most frequent tags are:
+1. \[song\]
+2. \[movie\]
+3. \[video\]
+4. \[music\]
+5. \[book\]
+6. \[2000s\]
+7. \[game\]
+8. \[2010s\]
+9. \[tv show\]
+10. \[music video\]
+
+As a proxy for the "performance" of a known-item question, we consider the time elapsed until the solution was posted.
+
+Overall, the titles of questions are much shorter (14 words on average across all categories) than the explanations in the content field (81 words on average), while the identified answers again are rather short (12 words on average). There are some notable differences between categories like the titles for movie questions being longer (15 words on average) or the answers in the book category being longer (16 words on average).
+
+
+## Use of TOMT-KIS
+
+
+
+## Dataset Structure
+
+Our TOMT-KIS dataset is available in JSONL format. For each question, we include all the attributes available in the crawled data and add the chosen answer when our heuristic could extract it. 
+
+### Data Instances
+
+```jsonl
+{
+  "id": "2gbnla",
+  "author": "alany611",
+  "url": "http://www.reddit.com/r/tipofmytongue/comments/2gbnla/tomt_1990s_educational_cartoon_for_kids_to_learn/",
+  "permalink": "/r/tipofmytongue/comments/2gbnla/tomt_1990s_educational_cartoon_for_kids_to_learn/",
+  "title": "[TOMT] 1990's Educational Cartoon for kids to learn French",
+  "content": "Hi all,\n\nWhen I was really young, 3-5, I remember watching a cartoon that I think was supposed to teach kids French. I would guess it was made from 1990-1995, but possibly earlier.\n\nIt was in color and the episodes I remember featured a guy with a long, narrow, and crooked nose and greenish skin teaching kids how to count? There was also a scene that had some character running up a clock tower to change the time.\n\nOverall, it was a pretty gloomy feel, iirc, and I'd love to see it again if possible.",
+  "created_utc": "1410647042",
+  "link_flair_text": "Solved",
+  "comments": [
+    {
+      "author": "scarpoochi",
+      "body": "Muzzy?\n\nhttps://www.youtube.com/watch?v=mD9i39GENWU",
+      "created_utc": "1410649099",
+      "score": 11,
+      "comments": [
+        {
+          "author": "alany611",
+          "body": "thank you!!!",
+          "created_utc": "1410666273",
+          "score": 1
+        }
+      ]
+    },
+    {
+      "author": "pepitica",
+      "body": "Muzzy! It's been driving me crazy for a while now!",
+      "created_utc": "1410649896",
+      "score": 6
+    }
+  ],
+  "answer_detected": True,
+  "solved_utc": "1410649099",
+  "chosen_answer": "Muzzy?\n\nhttps://www.youtube.com/watch?v=mD9i39GENWU",
+  "links_on_answer_path": [
+    "https://www.youtube.com/watch?v=mD9i39GENWU"
+  ]
+}
+
+```
+
+
+### Data Fields
+
+Overall, TOMT-KIS includes 127 attributes for each question, such as
+
+- `id` (int): unique Reddit-identifier of a question
+- `title` (string): the title of a question
+- `content` (string): the main text content of a question
+- `created_utc` (date): the posted question's timestamp
+- `link_flair_text` (string): indicates whether the question is solved; set by moderators
+- `comments` (string, json): the complete tree of the discussion on each question
+
+We run our precision-oriented answer identification heuristic on questions tagged as solved by a moderator and add four "new" attributes when the heuristic could identify an answer:
+
+- `answer_detected` (boolean): indicates whether our heuristic could extract an answer
+- `solved_utc`(date): the timestamp when the identified answer was posted
+- `chosen_answer`(string): the extracted answer
+- `links_on_answer_path`(list of strings): contains all Reddit-external pages that were found in posts between the question and the post with the answer. 
+
+
+## Citation Information
+
+```
+@InProceedings{froebe:2023c,
+  author =                   {Maik Fr{\"o}be and Eric Oliver Schmidt and Matthias Hagen},
+  booktitle =                {QPP++ 2023: Query Performance Prediction and Its Evaluation in New Tasks},
+  month =                    apr,
+  publisher =                {CEUR-WS.org},
+  series =                   {CEUR Workshop Proceedings},
+  site =                     {Dublin, Irland},
+  title =                    {{A Large-Scale Dataset for Known-Item Question Performance Prediction}},
+  year =                     2023
+}
+```