Update README.md

README.md

@@ -1,3 +1,82 @@
 ---
 license: cc-by-nc-sa-4.0
+language:
+- en
+tags:
+- dataset
+- legalNLP
+- refugee law
+pretty_name: AsyLex
 ---
+# Dataset Card for AsyLex
+
+The dataset introduces 59,112 documents of refugee status determination in Canada from 1996 to 2022, providing researchers and practitioners with essential material for training and evaluating NLP models for legal research and case review.
+
+The dataset contains labeled data suited for two NLP tasks: (1) Entity extraction and (2) Legal Judgment Prediction.
+
+## Dataset Details
+
+The dataset includes gold-standard human-labeled annotations for 24 legally relevant entity types curated with the help of legal experts, and 1,682 gold-standard labeled documents for the outcome of the case.
+
+The dataset can be split in two sets: 
+- (1) a Case Covers set that consists of semi-structured data and displays meta-information (the first page of each case);
+- (2) a Main Text set that contains the body of each case, in full text.
+
+### Dataset Sources [optional]
+
+The documents have been collected from the online services of the Canadian
+Legal Information Institute (CanLII). 
+
+## Uses
+
+- **License:** cc-by-nc-sa-4.0 
+
+The dataset must be used for research purposes only. It must not be use for commercial purposes. 
+
+
+## Dataset Structure
+
+This dataset contains the following files: 
+
+| file | description |
+| ------------- | ------------- |
+| cases_anonymized_txt_raw.tar.gz | contains the raw text from all documents, by case, with the corresponding case identifier |
+| all_sentences_anonymized.tar.xz | contains the raw text from all retrieved documents, split by sentences, with the corresponding case identifier |
+| main_and_case_cover_all_entities_inferred.csv | contains the structured dataset, all extracted entities (one column per entity type), with the corresponding case identifier |
+| case_cover/case_cover_anonymised_extracted_entities.csv | contains the structured dataset derived from the case covers only (one column per entity type), with the corresponding case identifier|
+| case_cover/case_cover_entities_and_decision_outcome.csv| same as above, with the addition of the decision outcome of the case |
+| determination_label_extracted_sentences.csv | contains all sentences that have been extracted with the Entity Type "determination". All sentences included here should therefore directly state the outcome of the decision, with the correspinding case identifier |
+| outcome_train_test| folder containing a train and test set for the task of outcome classificiation. Each set includes the case identifier and the decision outcome (0,1,2). The test set only contains gold-standard manually labeled data. |
+| manual_annotations | contains jsonl files of the manually collected annotations for the case cover and the main text|
+
+In all files containing the decision outcome, 0 refers to a "reject", 1 to a "granted", and 2 to "uncertain".
+
+#### Personal and Sensitive Information
+
+All documents have been anonymized. 
+
+## Citation [optional]
+
+**Papers:**
+
+- **NLLP @EMNLP Publication:** tba
+
+- **ACL Publication:**
+  @inproceedings{barale-etal-2023-automated,
+    title = "Automated Refugee Case Analysis: A {NLP} Pipeline for Supporting Legal Practitioners",
+    author = "Barale, Claire  and
+      Rovatsos, Michael  and
+      Bhuta, Nehal",
+    booktitle = "Findings of the Association for Computational Linguistics: ACL 2023",
+    month = jul,
+    year = "2023",
+    address = "Toronto, Canada",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2023.findings-acl.187",
+    doi = "10.18653/v1/2023.findings-acl.187",
+    pages = "2992--3005",
+}
+
+## Dataset Card Contact
+
+Please contact the authors of the papers.