oddadmix commited on
Commit
5990afb
·
verified ·
1 Parent(s): e727c1c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -33
README.md CHANGED
@@ -11,50 +11,58 @@ datasets:
11
  - oddadmix/arabic-news-summarization
12
  ---
13
 
14
- # Model Card for lfm2-sft-summary
15
 
16
- This model is a fine-tuned version of [LiquidAI/LFM2-350M](https://huggingface.co/LiquidAI/LFM2-350M).
17
- It has been trained using [TRL](https://github.com/huggingface/trl).
18
 
19
- ## Quick start
20
 
21
- ```python
22
- from transformers import pipeline
23
 
24
- question = "If you had a time machine, but could only go to the past or the future once and never return, which would you choose and why?"
25
- generator = pipeline("text-generation", model="oddadmix/lfm2-sft-summary", device="cuda")
26
- output = generator([{"role": "user", "content": question}], max_new_tokens=128, return_full_text=False)[0]
27
- print(output["generated_text"])
28
- ```
 
 
 
29
 
30
- ## Training procedure
 
31
 
32
- [<img src="https://raw.githubusercontent.com/wandb/assets/main/wandb-github-badge-28.svg" alt="Visualize in Weights & Biases" width="150" height="24"/>](https://wandb.ai/ahmed-m-wasfy/huggingface/runs/b36pzqd7)
33
 
 
34
 
35
- This model was trained with SFT.
 
36
 
37
- ### Framework versions
 
 
 
38
 
39
- - TRL: 0.20.0
40
- - Transformers: 4.54.1
41
- - Pytorch: 2.2.0
42
- - Datasets: 4.0.0
43
- - Tokenizers: 0.21.4
44
 
45
- ## Citations
 
46
 
 
 
 
 
 
 
 
 
 
 
 
 
47
 
 
48
 
49
- Cite TRL as:
50
-
51
- ```bibtex
52
- @misc{vonwerra2022trl,
53
- title = {{TRL: Transformer Reinforcement Learning}},
54
- author = {Leandro von Werra and Younes Belkada and Lewis Tunstall and Edward Beeching and Tristan Thrush and Nathan Lambert and Shengyi Huang and Kashif Rasul and Quentin Gallou{\'e}dec},
55
- year = 2020,
56
- journal = {GitHub repository},
57
- publisher = {GitHub},
58
- howpublished = {\url{https://github.com/huggingface/trl}}
59
- }
60
- ```
 
11
  - oddadmix/arabic-news-summarization
12
  ---
13
 
14
+ # 📝 نموذج التلخيص العربي
15
 
16
+ هذا المشروع يقدّم نموذج **تلخيص نصوص باللغة العربية** مبني على النموذج الأساسي [LiquidAI/LFM2-350M](https://huggingface.co/LiquidAI/LFM2-350M)، وتمت إعادة تدريبه (Fine-tuning) على **مجموعة بيانات مكوّنة من 17,000 سجل** لتلخيص النصوص بدقة وكفاءة عالية.
 
17
 
18
+ ---
19
 
20
+ ## ⚡ المميزات
 
21
 
22
+ * أداء قوي جدًا في تلخيص النصوص العربية.
23
+ * يحافظ على المعنى العام للنص مع اختصار الحجم.
24
+ * يمكن استخدامه في تلخيص المقالات، الأخبار، الأبحاث، والمستندات الطويلة.
25
+ * ✅ مبني على نموذج قوي مفتوح المصدر مع إعادة ضبط دقيقة (Fine-tuning).
26
+
27
+ ---
28
+
29
+ ## 🛠️ البيانات
30
 
31
+ تم تدريب النموذج باستخدام **17,000 صف** من البيانات عالية الجودة التي تحتوي على نصوص عربية وأهداف التلخيص المقابلة لها.
32
+ هذا ساعد في تحسين دقة النموذج وجعله قادرًا على إنتاج **ملخصات متماسكة وسلسة**.
33
 
34
+ ---
35
 
36
+ ## 🚀 كيفية الاستخدام
37
 
38
+ ```python
39
+ from transformers import AutoModelForSeq2SeqLM, AutoTokenizer
40
 
41
+ # تحميل النموذج والمحول
42
+ model_name = "اسم-المستخدم/arabic-summarization-model"
43
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
44
+ model = AutoModelForSeq2SeqLM.from_pretrained(model_name)
45
 
46
+ # إدخال نص للتلخيص
47
+ text = """النص العربي المراد تلخيصه ..."""
 
 
 
48
 
49
+ inputs = tokenizer(text, return_tensors="pt", max_length=1024, truncation=True)
50
+ summary_ids = model.generate(inputs["input_ids"], max_length=150, min_length=40, length_penalty=2.0, num_beams=4)
51
 
52
+ # عرض الملخص
53
+ print(tokenizer.decode(summary_ids[0], skip_special_tokens=True))
54
+ ```
55
+
56
+ ---
57
+
58
+ ## 📊 الأداء
59
+
60
+ النموذج أظهر نتائج ممتازة في التجارب الداخلية على مقاييس **الدقة، التماسك، والمحافظة على المعنى**.
61
+ أداؤه يُعتبر **جيد جدًا مقارنة بالنماذج المشابهة** في مجال تلخيص النصوص العربية.
62
+
63
+ ---
64
 
65
+ ## 📌 ملاحظات
66
 
67
+ * النموذج ما زال قابلًا للتطوير عبر تدريبه على بيانات إضافية.
68
+ * يُفضّل استخدامه مع نصوص عربية فصيحة، مع أنه يعمل بشكل جيد أيضًا مع بعض اللهجات.