Update README.md

README.md

@@ -1,3 +1,68 @@
----
-license: cc-by-nc-4.0
----
+---
+license: cc-by-nc-4.0
+task_categories:
+- text-classification
+- token-classification
+language:
+- en
+tags:
+- causality
+pretty_name: SCITE
+paperswithcode_id: ../paper/causality-extraction-based-on-self-attentive
+config_names:
+- causality detection
+- causal candidate extraction
+- causality identification
+---
+
+> [!NOTE]  
+> This repository integrates the SCITE extended [SemEval 2010 Task 8](https://aclanthology.org/S10-1006/) dataset into hf datasets. It is in conformance with SCITE's CC BY-NC 4.0 license. Please find the original dataset
+> [here](https://github.com/Das-Boot/scite). Please see the [citations](#citations) at the end of this README.
+
+# Usage
+## Causality Detection
+```py
+from datasets import load_dataset
+dataset = load_dataset("webis/SCITE", "causality detection")
+```
+
+## Causal Candidate Extraction
+```py
+from datasets import load_dataset
+dataset = load_dataset("webis/SCITE", "causal candidate extraction")
+```
+
+## Causality Identification
+```py
+from datasets import load_dataset
+dataset = load_dataset("webis/SCITE", "causality identification")
+```
+
+# Citations
+
+The SCITE paper by [Li et al., 2021](https://www.sciencedirect.com/science/article/pii/S0925231220316027):
+```bib
+@article{li:2021,
+  title = {Causality Extraction Based on Self-Attentive {{BiLSTM-CRF}} with Transferred Embeddings},
+  author = {Li, Zhaoning and Li, Qi and Zou, Xiaotian and Ren, Jiangtao},
+  year = {2021},
+  journal = {Neurocomputing},
+  volume = {423},
+  pages = {207--219},
+  doi = {10.1016/J.NEUCOM.2020.08.078}
+}
+```
+
+SemEval 2010 Task 8 by [Hendrickx et al., 2010](https://aclanthology.org/S10-1006/) which SCITE builds upon:
+```bib
+@inproceedings{hendrickx:2010,
+  title = {{{SemEval-2010 Task}} 8: {{Multi-Way Classification}} of {{Semantic Relations}} between {{Pairs}} of {{Nominals}}},
+  shorttitle = {{{SemEval-2010 Task}} 8},
+  booktitle = {Proceedings of the 5th {{International Workshop}} on {{Semantic Evaluation}}, {{SemEval}}@{{ACL}} 2010, {{Uppsala University}}, {{Uppsala}}, {{Sweden}}, {{July}} 15-16, 2010},
+  author = {Hendrickx, Iris and Kim, Su Nam and Kozareva, Zornitsa and Nakov, Preslav and S{\'e}aghdha, Diarmuid {\'O} and Pad{\'o}, Sebastian and Pennacchiotti, Marco and Romano, Lorenza and Szpakowicz, Stan},
+  editor = {Erk, Katrin and Strapparava, Carlo},
+  year = {2010},
+  pages = {33--38},
+  publisher = {The Association for Computer Linguistics}
+}
+```