Update README.md

README.md

@@ -74,3 +74,42 @@ configs:
   - split: test_kz
     path: ner_re/test_kz-*
 ---
+# SciMDIX Dataset
+
+## Dataset Description
+SciMDIX is a bilingual dataset containing scientific abstracts in Russian and Kazakh across four domains: **IT, Linguistics, Medicine, and Psychology**. It is designed for advanced Information Extraction tasks and is divided into two main configurations:
+
+1. **ner_re**: Contains annotations for Named Entity Recognition (NER) and Relation Extraction (RE).
+2. **aspects**: Contains aspect-level markup (AIM, MATERIAL, METHOD, RESULT, TASK, TOOL, USAGE) for the same texts.
+
+## Data Structure
+
+Each configuration contains four splits: `train_ru`, `train_kz`, `test_ru`, and `test_kz`. 
+*Note: You can identify the domain of a specific text by looking at the prefix in the `filename` column (`it-`, `ling-`, `med-`, `psy-`).*
+
+### Configuration: `ner_re`
+- `filename`: Original text file name (includes domain prefix).
+- `abstract`: The raw text of the scientific abstract.
+- `annotation`: Text with inline BRAT-style markup `[Entity|ID|TYPE]`.
+- `entities`: Extracted entities in BRAT format.
+- `relations`: Extracted relations between entities.
+
+### Configuration: `aspects`
+- `filename`: Original text file name (includes domain prefix).
+- `abstract`: The raw text of the scientific abstract.
+- `aspect_annotation`: Text with inline aspect markup `[Span|ID|TYPE]`.
+- `aspects`: Extracted aspects in BRAT format.
+
+## How to use
+
+You can load the dataset using the `datasets` library. Specify the configuration (`ner_re` or `aspects`) and the split you want to use:
+
+```python
+from datasets import load_dataset
+
+# Load the Russian Train split for NER and Relation Extraction
+ds_ner_ru_train = load_dataset("tvbat/SciMDIX", "ner_re", split="train_ru")
+print(ds_ner_ru_train[0])
+
+# Load the Kazakh Test split for Aspects
+ds_asp_kz_test = load_dataset("tvbat/SciMDIX", "aspects", split="test_kz")