Update README.md

README.md

@@ -1,33 +1,89 @@
----
-license: cc-by-4.0
-dataset_info:
-  features:
-  - name: filename
-    dtype: string
-  - name: ann_id
-    dtype: int64
-  - name: label
-    dtype: string
-  - name: start_span
-    dtype: int64
-  - name: end_span
-    dtype: int64
-  - name: text
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 3225477
-    num_examples: 33757
-  - name: test
-    num_bytes: 1072603
-    num_examples: 11239
-  download_size: 6341899
-  dataset_size: 4298080
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
----
+---
+license: cc-by-4.0
+dataset_info:
+  features:
+  - name: filename
+    dtype: string
+  - name: ann_id
+    dtype: int64
+  - name: label
+    dtype: string
+  - name: start_span
+    dtype: int64
+  - name: end_span
+    dtype: int64
+  - name: text
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 3225477
+    num_examples: 33757
+  - name: test
+    num_bytes: 1072603
+    num_examples: 11239
+  download_size: 6341899
+  dataset_size: 4298080
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
+  - split: test
+    path: data/test-*
+---
+
+
+### Dataset
+
+#### Description
+The merged dataset utilized in this project combines four distinct annotated datasets, all based on the Spanish Clinical Case Corpus ([SPACCC](https://zenodo.org/records/2560316)), a compilation of clinical case reports from Spanish medical publications. This merged dataset encompasses a total of 16,504 sentences across 1,000 clinical cases. The dataset focuses on identifying various medical entities within clinical narratives, including symptoms, medical procedures, diseases, proteins, and chemicals. 
+
+The dataset is furhter provided on [zenodo](https://zenodo.org/records/11174163), and construction is detailed in our [GitHub](https://github.com/ieeta-pt/Multi-Head-CRF/) repository.
+
+#### Origin
+The constituent datasets include:
+- **[SympTEMIST](https://zenodo.org/records/10635215)**: Designed for symptom, sign, and finding annotation, contributing 12,193 annotations.
+- **[MedProcNer](https://zenodo.org/records/8224056)**: Focused on medical procedure identification with 14,683 instances.
+- **[DisTEMIST](https://zenodo.org/records/7614764)**: Targeting disease identification, containing 10,663 annotations.
+- **[PharmaCoNER](https://zenodo.org/records/4270158)**: Primarily for identifying chemicals and proteins, with 7,624 entities.
+
+#### Annotations and Classes
+The annotations are normalized to SNOMED CT, ensuring consistency across datasets. Classes include symptoms, procedures, diseases, proteins, and chemicals. Intra-class overlapping entities are addressed, ensuring model training on the longest span.
+
+#### Statistics
+The dataset is split into training and test sets, with consistent splits across corpora. For detailed statistics, refer to Table 1 and Table 2 below.
+
+#### Use Case
+The dataset serves as a resource for training and evaluating models for medical entity recognition and normalization tasks in Spanish clinical text.
+
+#### References
+
+1. Miranda-Escalada, A., Gascó, L., Lima-López, S., Farré-Maduell, E., Estrada, D., Nentidis, A., Krithara, A., Katsimpras, G., Paliouras, G., & Krallinger, M. (2022). Overview of DisTEMIST at BioASQ: Automatic detection and normalization of diseases from clinical texts: results, methods, evaluation and multilingual resources. Working Notes of Conference and Labs of the Evaluation (CLEF) Forum. CEUR Workshop Proceedings
+2. Lima-López S, Farré-Maduell E, Gascó L, Nentidis A, Krithara A, Katsimpras G, Paliouras G, Krallinger M. Overview of MedProcNER task on medical procedure detection and entity linking at BioASQ 2023. Working Notes of CLEF. 2023.
+3. Lima-López, S., Farré-Maduell, E., Gasco-Sánchez, L., Rodríguez-Miret, J. and Krallinger, M. (2023). Overview of SympTEMIST at BioCreative VIII: corpus, guidelines and evaluation of systems for the detection and normalization of symptoms, signs and findings from text. In: Proceedings of the BioCreative VIII Challenge and Workshop: Curation and Evaluation in the era of Generative Models.
+4. A. G. Agirre, M. Marimon, A. Intxaurrondo, O. Rabal, M. Villegas, M. Krallinger, Pharmaconer: Pharmacological substances, compounds and proteins named entity recognition track, in: Proceedings of The 5th Workshop on BioNLP Open Shared Tasks, 2019, pp. 1–10.
+5. Gonzalez-Agirre A, Marimon M, Intxaurrondo A, Rabal O, Villegas M, Krallinger M. Pharmaconer: Pharmacological substances, compounds and proteins named entity recognition track. InProceedings of The 5th Workshop on BioNLP Open Shared Tasks 2019 Nov (pp. 1-10).
+
+ 
+---
+
+Table 1: Datasets statistics with the number of entity mentions.
+
+| Dataset      | Train  | Test  | Total   |
+|--------------|--------|-------|---------|
+| SympTEMIST   | 9,091  | 3,102 | 12,193  |
+| MedProcNER   | 11,065 | 3,618 | 14,683  |
+| DisTEMIST    | 8,065  | 2,598 | 10,663  |
+| PharmaCoNER  | 4,665  | 1,959 | 7,624   |
+| Total        | 32,886 | 11,277| 45,163  |
+
+Table 2: Total number of overlapping entities within the datasets.
+
+| Subset       | Train | Test | Total |
+|--------------|-------|------|-------|
+| SympTEMIST   | 57    | 39   | 96    |
+| MedProcNER   | 418   | 143  | 561   |
+| DisTEMIST    | 323   | 90   | 413   |
+| PharmaCoNER  | 0     | 0    | 0     |
+| Total        | 798   | 272  | 1070  |
+