codemurt commited on
Commit
ac068e3
1 Parent(s): c655efd

updated readme

Browse files
Files changed (1) hide show
  1. README.md +28 -2
README.md CHANGED
@@ -33,6 +33,32 @@ language:
33
  size_categories:
34
  - n<1K
35
  ---
36
- # Uyghur NER Dataset
37
 
38
- This dataset is in WikiAnn format.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
  size_categories:
34
  - n<1K
35
  ---
 
36
 
37
+ # Uyghur NER dataset
38
+
39
+ ## Description
40
+
41
+ This dataset is in [WikiAnn](https://huggingface.co/datasets/wikiann) format. The dataset is assembled from named entities parsed from Wikipedia, Wiktionary and Dbpedia. For some words, new case forms have been created using [Apertium-uig](https://github.com/apertium/apertium-uig). Some locations have been translated using the Google Translate API.
42
+
43
+ The dataset is divided into two parts: `train` and `extra`. `Train` has full sentences, `extra` has only named entities.
44
+
45
+ Tags: `O (0), B-PER (1), I-PER (2), B-ORG (3), I-ORG (4), B-LOC (5), I-LOC (6)`
46
+
47
+ ## Data example
48
+
49
+ ```
50
+ {
51
+ 'tokens': ['قاراماي', 'شەھىرى', '«مەملىكەت', 'بويىچە', 'مىللەتل…'],
52
+ 'ner_tags': [5, 0, 0, 0, 0],
53
+ 'langs': ['ug', 'ug', 'ug', 'ug', 'ug'],
54
+ 'spans': ['LOC: قاراماي']
55
+ }
56
+ ```
57
+
58
+ ## Usage with `datasets` library
59
+
60
+ ```py
61
+ from datasets import load_dataset
62
+
63
+ dataset = load_dataset("codemurt/uyghur_ner_dataset")
64
+ ```