Update README.md

README.md

@@ -1,3 +1,37 @@
 ---
 license: cc-by-4.0
+task_categories:
+- text-generation
+language:
+- en
+size_categories:
+- n<1K
 ---
+
+# BIQA Text-to-SQL Dataset
+
+The data is from the [Stack Overflow Developer Survey 2023](https://survey.stackoverflow.co/2023/).
+
+Created with this [Notebook](https://colab.research.google.com/drive/12NUeRMsld0toXMSXKFMaQVAv58XwOAT1?usp=sharing); uses [this spreadsheet](https://docs.google.com/spreadsheets/d/1Xh_TgMbyitvtw08g0byEmBpkwDGZDdBYenthOzcK6qI/edit?usp=sharing) defining manual adjustments.
+
+- `data/eval_set_multi_answers_res.json`: Question and query pairs as list of `SQLSample`s with possibly more than one valid SQL for a question. Also results included.
+- `data/survey_results_normalized_v2.db`: The main sqlite db file.
+
+The json file contains a list of `SQLSample` objects as defined:
+
+```python
+@dataclass
+class SQLQuery:
+    query: str
+    results: Optional[list[tuple]] = None
+
+@dataclass
+class SQLSample:
+    question: str
+    labels: list[SQLQuery]
+    prediction: Optional[SQLQuery] = None
+    pred_eval: str = ""
+    comment: str = ""
+```
+
+Can be read in through the code from the [related repository](https://github.com/deepset-ai/biqa-llm).