Update README.md

README.md

@@ -24,94 +24,77 @@ task_ids:
 
 ## Dataset Description
 
-- **Paper:**
-- **Repository:**
-- **Point of Contact:**
+HateCheck is a suite of functional test for hate speech detection models. 
+3
 
-### Dataset Summary
+t contains ,728 test cases in 29 functional tests
 
-[More Information Needed]
+- **Paper:** Röttger et al. (2021) - HateCheck: Functional Tests for Hate Speech Detection Model. https://aclanthology.org/2021.acl-long.4/ 
+- **Repository:** https://github.com/paul-rottger/hatecheck-data
+- **Point of Contact:** paul.rottger@oii.ox.ac.uk
 
-### Supported Tasks and Leaderboards
-
-[More Information Needed]
-
-### Languages
-
-[More Information Needed]
 
 ## Dataset Structure
 
-### Data Instances
-
-[More Information Needed]
-
-### Data Fields
-
-[More Information Needed]
-
-### Data Splits
-
-[More Information Needed]
-
-## Dataset Creation
-
-### Curation Rationale
-
-[More Information Needed]
-
-### Source Data
+"test.csv" contains all 3,728 validated test cases. Each test case (row) has the following attributes:
 
-#### Initial Data Collection and Normalization
+**functionality**
+The shorthand for the functionality tested by the test case.
 
-[More Information Needed]
+**case_id**
+The unique ID of the test case (assigned to each of the 3,901 cases we initially generated)
 
-#### Who are the source language producers?
+**test_case**
+The text of the test case.
 
-[More Information Needed]
+**label_gold**
+The gold standard label (hateful/non-hateful) of the test case. All test cases within a given functionality have the same gold standard label.
 
-### Annotations
+**target_ident**
+Where applicable, the protected group targeted or referenced by the test case. We cover seven protected groups in the test suite: women, trans people, gay people, black people, disabled people, Muslims and immigrants.
 
-#### Annotation process
+**direction**
+For hateful cases, the binary secondary label indicating whether they are *directed* at an individual as part of a protected group or aimed at the group in *general*.
 
-[More Information Needed]
+**focus_words**
+Where applicable, the key word or phrase in a given test case (e.g. "cut their throats").
 
-#### Who are the annotators?
+**focus_lemma**
+Where applicable, the corresponding lemma (e.g. "cut sb. throat").
 
-[More Information Needed]
+**ref_case_id**
+For hateful cases, where applicable, the ID of the simpler hateful case which was perturbed to generate them.
+For non-hateful cases, where applicable, the ID of the hateful case which is contrasted.
 
-### Personal and Sensitive Information
+**ref_templ_id**
+The equivalent, but for template IDs.
 
-[More Information Needed]
+**templ_id**
+The unique ID of the template from which the test case was generated (assigned to each of the 866 cases and templates from which we generated the 3,901 initial cases).
 
-## Considerations for Using the Data
-
-### Social Impact of Dataset
-
-[More Information Needed]
-
-### Discussion of Biases
-
-[More Information Needed]
-
-### Other Known Limitations
-
-[More Information Needed]
-
-## Additional Information
-
-### Dataset Curators
-
-[More Information Needed]
-
-### Licensing Information
-
-[More Information Needed]
 
 ### Citation Information
 
-[More Information Needed]
+When using HateCheck, please cite our ACL paper:
+
+@inproceedings{rottger-etal-2021-hatecheck,
+    title = "{H}ate{C}heck: Functional Tests for Hate Speech Detection Models",
+    author = {R{\"o}ttger, Paul  and
+      Vidgen, Bertie  and
+      Nguyen, Dong  and
+      Waseem, Zeerak  and
+      Margetts, Helen  and
+      Pierrehumbert, Janet},
+    booktitle = "Proceedings of the 59th Annual Meeting of the Association for Computational Linguistics and the 11th International Joint Conference on Natural Language Processing (Volume 1: Long Papers)",
+    month = aug,
+    year = "2021",
+    address = "Online",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2021.acl-long.4",
+    doi = "10.18653/v1/2021.acl-long.4",
+    pages = "41--58",
+    abstract = "Detecting online hate is a difficult task that even state-of-the-art models struggle with. Typically, hate speech detection models are evaluated by measuring their performance on held-out test data using metrics such as accuracy and F1 score. However, this approach makes it difficult to identify specific model weak points. It also risks overestimating generalisable model performance due to increasingly well-evidenced systematic gaps and biases in hate speech datasets. To enable more targeted diagnostic insights, we introduce HateCheck, a suite of functional tests for hate speech detection models. We specify 29 model functionalities motivated by a review of previous research and a series of interviews with civil society stakeholders. We craft test cases for each functionality and validate their quality through a structured annotation process. To illustrate HateCheck{'}s utility, we test near-state-of-the-art transformer models as well as two popular commercial models, revealing critical model weaknesses.",
+}
+
 
-### Contributions
 
-Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.