marefa commited on
Commit
80c9ed0
1 Parent(s): 6f1a7d1

Update README with Acknowledgment list

Browse files
Files changed (1) hide show
  1. README.md +42 -4
README.md CHANGED
@@ -4,7 +4,8 @@ datasets:
4
  - Marefa-NER
5
  ---
6
 
7
- # Marefa NER نموذج المعرفة لتصنيف أجزاء النص
 
8
 
9
  ## Model description
10
 
@@ -21,15 +22,20 @@ Person, Location, Organization, Nationality, Job, Product, Event, Time, Art-Work
21
 
22
  ## How to use كيف تستخدم النموذج
23
 
24
- Install transformers
25
 
26
- `$ pip3 install transformers==4.3.0`
27
 
28
  > If you are using `Google Colab`, please restart your runtime after installing the packages.
29
 
30
  -----------
31
 
32
  ```python
 
 
 
 
 
33
  from transformers import AutoTokenizer, AutoModelForTokenClassification
34
  from transformers import pipeline
35
 
@@ -43,6 +49,9 @@ nlp = pipeline("ner", model=model, tokenizer=tokenizer, grouped_entities=True)
43
 
44
  # ===== extract the entities from a sample text
45
  example = 'قاد عمر المختار القوات في ليبيا ضد الجيش الإيطالي'
 
 
 
46
  ner_results = nlp(example)
47
 
48
  # ===== print the ner_results
@@ -55,4 +64,33 @@ for ent in ner_results:
55
  # الجيش الإيطالي -> organization # score: 0.99
56
  ####
57
 
58
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  - Marefa-NER
5
  ---
6
 
7
+ # Tebyan تبيـان
8
+ ## Marefa Arabic Named Entity Recognition Model نموذج المعرفة لتصنيف أجزاء النص
9
 
10
  ## Model description
11
 
 
22
 
23
  ## How to use كيف تستخدم النموذج
24
 
25
+ Install transformers AND nltk
26
 
27
+ `$ pip3 install transformers==4.3.0 nltk==3.5`
28
 
29
  > If you are using `Google Colab`, please restart your runtime after installing the packages.
30
 
31
  -----------
32
 
33
  ```python
34
+ # we need to install NLTK punkt to be used for word tokenization
35
+ import nltk
36
+ nltk.download('punkt')
37
+ from nltk.tokenize import word_tokenize
38
+
39
  from transformers import AutoTokenizer, AutoModelForTokenClassification
40
  from transformers import pipeline
41
 
 
49
 
50
  # ===== extract the entities from a sample text
51
  example = 'قاد عمر المختار القوات في ليبيا ضد الجيش الإيطالي'
52
+ # clean the text
53
+ example = " ".join(word_tokenize(example))
54
+ # feed to the NER model to parse
55
  ner_results = nlp(example)
56
 
57
  # ===== print the ner_results
 
64
  # الجيش الإيطالي -> organization # score: 0.99
65
  ####
66
 
67
+ ```
68
+
69
+ ## Acknowledgment شكر و تقدير
70
+
71
+ قام بإعداد البيانات التي تم تدريب النموذج عليها, مجموعة من المتطوعين الذين قضوا ساعات يقومون بتنقيح البيانات و مراجعتها
72
+
73
+ - على سيد عبد الحفيظ - إشراف
74
+ - نرمين محمد عطيه
75
+ - احمد علي عبدربه
76
+ - عمر بن عبد العزيز سليمان
77
+ - محمد ابراهيم الجمال
78
+ - عبدالرحمن سلامه خلف
79
+ - إبراهيم كمال محمد سليمان
80
+ - حسن مصطفى حسن
81
+ - أحمد فتحي سيد
82
+ - عثمان مندو
83
+ - عارف الشريف
84
+ - أميرة محمد محمود
85
+ - حسن سعيد حسن
86
+ - عبد العزيز علي البغدادي
87
+ - واثق عبدالملك الشويطر
88
+ - عمرو رمضان عقل الحفناوي
89
+ - حسام الدين أحمد على
90
+ - أسامه أحمد محمد محمد
91
+ - حاتم محمد المفتي
92
+ - عبد الله دردير
93
+ - أدهم البغدادي
94
+ - أحمد صبري
95
+ - عبدالوهاب محمد محمد
96
+ - أحمد محمد عوض