lior-at-optune commited on
Commit
a18f765
·
verified ·
1 Parent(s): 2e65fd1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +62 -28
README.md CHANGED
@@ -1,30 +1,64 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: text
5
- dtype: string
6
- - name: entities
7
- list:
8
- - name: content
9
- dtype: string
10
- - name: label
11
- dtype: string
12
- - name: start_index
13
- dtype: int64
14
- splits:
15
- - name: train
16
- num_bytes: 289037
17
- num_examples: 1081
18
- - name: test
19
- num_bytes: 127933
20
- num_examples: 499
21
- download_size: 190836
22
- dataset_size: 416970
23
- configs:
24
- - config_name: default
25
- data_files:
26
- - split: train
27
- path: data/train-*
28
- - split: test
29
- path: data/test-*
30
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: mit
3
+ task_categories:
4
+ - token-classification
5
+ language:
6
+ - ar
7
+ tags:
8
+ - Sinalab
9
+ - Wojood
10
+ - ArabicNER
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  ---
12
+
13
+ a snapshot from https://huggingface.co/datasets/AhmedNabil1/wojood-arabic-ner
14
+
15
+ # Wojood Arabic NER (Sample, Processed)
16
+
17
+ This dataset is a **processed version of the sample** from the [Wojood Arabic NER dataset](https://github.com/SinaLab/ArabicNER), developed by [SinaLab](https://sina.birzeit.edu/).
18
+ The original dataset is licensed under the **MIT License**, and this processed sample is shared under the same terms.
19
+
20
+ ⚠️ **Note:** This is **not the full Wojood corpus**. The full dataset must be requested directly from the original authors (Prof. Mustafa Jarrar and team).
21
+
22
+ ---
23
+
24
+ ## Dataset
25
+
26
+ - **Language:** Arabic
27
+ - **Task:** Named Entity Recognition (NER)
28
+ - **Entities:** PERS (Person), ORG, GPE (Geopolitical entities, countries, cities), LOC (Locations), DATE, TIME, CARDINAL, ORDINAL, PERCENT, MONEY, QUANTITY, EVENT, FAC (Facilities), NORP (Nationalities, religious/political groups), OCC (Occupations), LANGUAGE, WEBSITE, UNIT (Units of measurement), LAW (Legal documents), PRODUCT, CURR (Currencies)
29
+ - **Source:** [SinaLab/ArabicNER GitHub repo](https://github.com/SinaLab/ArabicNER)
30
+ - **Size:** This repository only contains the **sample subset** provided in the GitHub repository.
31
+
32
+ ---
33
+
34
+ ## Preprocessing
35
+
36
+ The data has been processed and converted into JSON format, structured specifically for fine-tuning NER tasks with proper formatting and tokenization.
37
+
38
+ ---
39
+
40
+ ## Usage
41
+
42
+ You can load this dataset directly with `datasets`:
43
+
44
+ ```python
45
+ from datasets import load_dataset
46
+
47
+ dataset = load_dataset("AhmedNabil1/wojood-arabic-ner")
48
+ print(dataset["train"][0])
49
+ ```
50
+
51
+ ---
52
+
53
+ ## License
54
+
55
+ This dataset is released under the **MIT License**, in accordance with the original [Wojood Arabic NER](https://github.com/SinaLab/ArabicNER) repository.
56
+ Please retain this license and attribution when using or redistributing.
57
+
58
+ ---
59
+
60
+ ## Acknowledgements
61
+
62
+ - **Dataset Source:** [SinaLab/ArabicNER GitHub repo](https://github.com/SinaLab/ArabicNER)
63
+ - **Processing and Hugging Face release:** [Ahmed Nabil / AhmedNabil1]
64
+