Update README.md

README.md

@@ -1,31 +1,132 @@
----
-license: cc-by-nc-sa-4.0
-dataset_info:
-  features:
-  - name: id_doc
-    dtype: string
-  - name: words
-    sequence:
-      sequence: string
-  - name: mentions
-    list:
-    - name: id_mention
-      dtype: string
-    - name: mention_data
-      struct:
-      - name: idx_sent
-        dtype: uint32
-      - name: word_indices
-        sequence: uint32
-      - name: global_word_indices
-        sequence: uint32
-  - name: coref_clusters
-    sequence:
-      sequence: string
-  splits:
-  - name: train
-    num_bytes: 413196
-    num_examples: 149
-  download_size: 463706
-  dataset_size: 413196
----
+---
+license: cc-by-nc-sa-4.0
+dataset_info:
+  features:
+  - name: id_doc
+    dtype: string
+  - name: words
+    sequence:
+      sequence: string
+  - name: mentions
+    list:
+    - name: id_mention
+      dtype: string
+    - name: mention_data
+      struct:
+      - name: idx_sent
+        dtype: uint32
+      - name: word_indices
+        sequence: uint32
+      - name: global_word_indices
+        sequence: uint32
+  - name: coref_clusters
+    sequence:
+      sequence: string
+  splits:
+  - name: train
+    num_bytes: 413196
+    num_examples: 149
+  download_size: 463706
+  dataset_size: 413196
+language:
+- sl
+tags:
+- coreference-resolution
+pretty_name: coref149
+size_categories:
+- n<1K
+---
+
+# Dataset card for coref149
+
+### Usage
+```
+import datasets
+data = datasets.load_dataset("cjvt/coref149", trust_remote_code=True)
+```
+
+### Dataset Summary
+The dataset contains a subset of the ssj500k corpus, specifically paragraphs, annotated for coreference.
+For more details please check the paper (in Slovenian) or the Clarin repository from which this dataset is being loaded.
+
+### Supported Tasks and Leaderboards
+Coreference resolution.
+
+### Languages
+Slovenian.
+
+## Dataset Structure
+
+### Data Instances 
+
+```
+{
+    'id_doc': 'ssj4.15.tcf', 
+    'words': [
+        ['Znamenita', 'konjeniška', 'dirka', 'Aintree', '2005', 'v', 'bližini', 'Liverpoola', 'je', 'tudi', 'letos', 'postregla', 'z', 'nekaterimi', 'nepredvidljivimi', 'naključji', '.'], 
+        ['Kljub', 'tradiciji', 'so', 'bili', ...],
+        ...
+    ],
+    'mentions': [
+        {'id_mention': 'ssj4.15.tcf.rc_0', 'mention_data': {'idx_sent': 5, 'word_indices': [6, 7], 'global_word_indices': [80, 81]}}, 
+        {'id_mention': 'ssj4.15.tcf.rc_1', 'mention_data': {'idx_sent': 0, 'word_indices': [7], 'global_word_indices': [7]}},
+        ...
+    ],
+    'coref_clusters': [
+        ['ssj4.15.tcf.rc_0'], 
+        ['ssj4.15.tcf.rc_1'], 
+        ['ssj4.15.tcf.rc_2', 'ssj4.15.tcf.rc_3'], 
+        ...
+    ]
+}
+```
+
+### Data Fields
+
+- `id_doc`: a string ID of the document (corresponds to file name in this case);  
+- `words`: a list of lists of strings containing paragraph words;  
+- `mentions`: a list of dicts for each mention. Each mention contains an ID (`id_mention`) and 
+positions of words inside mention (determined by `idx_sent`, `word_indices`; 
+or equivalently `global_word_indices` if sentences are flattened into a single list)
+- `coref_clusters`: a list of lists of strings containing mention IDs contained inside each coreference cluster. 
+
+## Additional Information
+
+### Dataset Curators
+
+Slavko Žitnik.
+
+### Licensing Information
+
+CC BY-NC-SA 4.0
+
+### Citation Information
+
+```
+@article{coref149-paper, 
+    title={Odkrivanje koreferenčnosti v slovenskem jeziku na označenih besedilih iz coref149}, 
+    volume={6}, 
+    url={https://revije.ff.uni-lj.si/slovenscina2/article/view/7967/8253}, 
+    number={1}, 
+    journal={Slovenščina 2.0}, 
+    author={Žitnik, Slavko and Bajec, Marko}, 
+    year={2018}, 
+    pages={37–66}
+}
+```
+
+```
+@misc{coref149-clarin,
+    title = {Slovene coreference resolution corpus coref149},
+    author = {{\v Z}itnik, Slavko},
+    url = {http://hdl.handle.net/11356/1182},
+    note = {Slovenian language resource repository {CLARIN}.{SI}},
+    copyright = {Creative Commons - Attribution-{NonCommercial}-{ShareAlike} 4.0 International ({CC} {BY}-{NC}-{SA} 4.0)},
+    year = {2018}
+}
+```
+
+### Contributions
+
+Thanks to [@matejklemen](https://github.com/matejklemen) for adding this dataset.
+