update readme

.gitattributes

@@ -55,6 +55,5 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.webp filter=lfs diff=lfs merge=lfs -text
 *.json filter=lfs diff=lfs merge=lfs -text
 *.jsonl filter=lfs diff=lfs merge=lfs -text
-*.md filter=lfs diff=lfs merge=lfs -text
 *.log filter=lfs diff=lfs merge=lfs -text
 *.csv filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,24 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:98b45ea81164d1e1a1dd82255207053b15cd6c69d922a1c5cf3387ce604d4b74
-size 28
+---
+license: apache-2.0
+---
+
+
+# Goodtriever
+
+This repository contains datasets and model generations from the `Goodtriever: Adaptive Toxicity Mitigation with Retrieval-augmented Models` paper, published as a conference paper on EMNLP 2023.
+
+[[Paper]]()[[Code]]()[[Data]](https://huggingface.co/datasets/luizapzbn/goodtriever-data)
+
+- `data`: prompts and datasets used for datastore creation.
+    - `continual_mitigation`: clustered WILDS data and prompts
+    - `datastore_quality`: for the experiments on how automatic labeling impacts mitigation results
+    - `jigsaw`: main dataset, jigsaw unintended bias
+- `outputs`: model generations and results for all experiments from the paper.
+    - `alpha_temperature`
+    - `datastore_quality`
+    - `datastore_size`
+    - `k_neighbors`
+    - `model_families` (and main table results)
+
+
+# Citation