From b6217d82342a36b3ed4430b3e6af7bac45834076 Mon Sep 17 00:00:00 2001
From: Ahmed Almaghz <53489256+AhmedAlmaghz@users.noreply.github.com>
Date: Sun, 11 Aug 2024 04:43:02 +0300
Subject: [PATCH 1/2] Add docs/source/ar/model_doc/xmod.md

---
 docs/source/ar/model_doc/xmod.md | 123 +++++++++++++++++++++++++++++++
 1 file changed, 123 insertions(+)
 create mode 100644 docs/source/ar/model_doc/xmod.md

diff --git a/docs/source/ar/model_doc/xmod.md b/docs/source/ar/model_doc/xmod.md
new file mode 100644
index 00000000000000..60608f43e27377
--- /dev/null
+++ b/docs/source/ar/model_doc/xmod.md
@@ -0,0 +1,123 @@
+# X-MOD
+
+## نظرة عامة
+اقترح نموذج X-MOD في ورقة "رفع لعنة تعدد اللغات عن طريق التدريب المسبق للمحولات المعيارية" من قبل Jonas Pfeiffer وآخرون. يوسع X-MOD نماذج اللغة المقنعة متعددة اللغات مثل XLM-R لتشمل مكونات معيارية خاصة باللغة (مهايئات اللغة) أثناء التدريب المسبق. بالنسبة للتعديل الدقيق، يتم تجميد مهايئات اللغة في كل طبقة من المحول.
+
+ملخص الورقة هو كما يلي:
+
+> "من المعروف أن النماذج متعددة اللغات المُدربة مسبقًا تعاني من لعنة تعدد اللغات، والتي تسبب انخفاض الأداء لكل لغة كلما غطت المزيد من اللغات. نعالج هذه المشكلة من خلال تقديم وحدات خاصة باللغة، مما يسمح لنا بزيادة السعة الإجمالية للنموذج، مع الحفاظ على إجمالي عدد المعلمات القابلة للتدريب لكل لغة ثابتة. على عكس العمل السابق الذي يتعلم المكونات الخاصة باللغة بعد التدريب، نقوم بتدريب وحدات نماذجنا المعيارية متعددة اللغات من البداية. تُظهر تجاربنا على الاستدلال اللغوي الطبيعي، وتعريف الكيانات المسماة، والإجابة على الأسئلة أن نهجنا لا يخفف من التداخل السلبي بين اللغات فحسب، بل يمكّن أيضًا من النقل الإيجابي، مما يؤدي إلى تحسين الأداء أحادي اللغة وعبر اللغات. علاوة على ذلك، يمكّن نهجنا من إضافة لغات بعد التدريب دون انخفاض ملحوظ في الأداء، مما لم يعد يقتصر استخدام النموذج على مجموعة اللغات المدربة مسبقًا."
+
+تمت المساهمة بهذا النموذج من قبل jvamvas. يمكن العثور على الكود الأصلي والتوثيق الأصلي في الروابط المذكورة أعلاه.
+
+## نصائح الاستخدام
+
+- يشبه X-MOD نموذج XLM-R، ولكن أحد الاختلافات هو أنه يجب تحديد لغة الإدخال بحيث يمكن تنشيط مهايئ اللغة الصحيح.
+- تحتوي النماذج الرئيسية - base وlarge - على مهايئات لـ 81 لغة.
+
+## استخدام المهايئ
+
+### لغة الإدخال
+
+هناك طريقتان لتحديد لغة الإدخال:
+
+1. عن طريق تعيين لغة افتراضية قبل استخدام النموذج:
+
+```python
+from transformers import XmodModel
+
+model = XmodModel.from_pretrained("facebook/xmod-base")
+model.set_default_language("en_XX")
+```
+
+2. عن طريق تمرير مؤشر مهايئ اللغة لكل عينة بشكل صريح:
+
+```python
+import torch
+
+input_ids = torch.tensor(
+    [
+        [0, 581, 10269, 83, 99942, 136, 60742, 23, 70, 80583, 18276, 2],
+        [0, 1310, 49083, 443, 269, 71, 5486, 165, 60429, 660, 23, 2],
+    ]
+)
+lang_ids = torch.LongTensor(
+    [
+        0,  # en_XX
+        8,  # de_DE
+    ]
+)
+output = model(input_ids, lang_ids=lang_ids)
+```
+
+### التعديل الدقيق
+
+توصي الورقة بتجميد طبقة التضمين ومهايئات اللغة أثناء التعديل الدقيق. يتم توفير طريقة للقيام بذلك:
+
+```python
+model.freeze_embeddings_and_language_adapters()
+# Fine-tune the model ...
+```
+
+### النقل عبر اللغات
+
+بعد التعديل الدقيق، يمكن اختبار النقل الصفري عبر اللغات عن طريق تنشيط مهايئ لغة الهدف:
+
+```python
+model.set_default_language("de_DE")
+# Evaluate the model on German examples ...
+```
+
+## الموارد
+
+- [دليل مهمة تصنيف النص](../tasks/sequence_classification)
+- [دليل مهمة تصنيف الرموز](../tasks/token_classification)
+- [دليل مهمة الإجابة على الأسئلة](../tasks/question_answering)
+- [دليل مهمة نمذجة اللغة السببية](../tasks/language_modeling)
+- [دليل مهمة نمذجة اللغة المقنعة](../tasks/masked_language_modeling)
+- [دليل المهمة متعددة الخيارات](../tasks/multiple_choice)
+
+## XmodConfig
+
+[[autodoc]] XmodConfig
+
+## XmodModel
+
+[[autodoc]] XmodModel
+
+- forward
+
+## XmodForCausalLM
+
+[[autodoc]] XmodForCausalLM
+
+- forward
+
+## XmodForMaskedLM
+
+[[autodoc]] XmodForMaskedLM
+
+- forward
+
+## XmodForSequenceClassification
+
+[[autodoc]] XmodForSequenceClassification
+
+- forward
+
+## XmodForMultipleChoice
+
+[[autodoc]] XmodForMultipleChoice
+
+- forward
+
+## XmodForTokenClassification
+
+[[autodoc]] XmodForTokenClassification
+
+- forward
+
+## XmodForQuestionAnswering
+
+[[autodoc]] XmodForQuestionAnswering
+
+- forward
\ No newline at end of file

From 1c6cb5cabb3036a1720a3290e98410c448477cc0 Mon Sep 17 00:00:00 2001
From: Ahmed Almaghz <53489256+AhmedAlmaghz@users.noreply.github.com>
Date: Thu, 15 Aug 2024 00:10:58 +0300
Subject: [PATCH 2/2] Update xmod.md

---
 docs/source/ar/model_doc/xmod.md | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/docs/source/ar/model_doc/xmod.md b/docs/source/ar/model_doc/xmod.md
index 60608f43e27377..5c9a1e0672fa13 100644
--- a/docs/source/ar/model_doc/xmod.md
+++ b/docs/source/ar/model_doc/xmod.md
@@ -1,20 +1,24 @@
 # X-MOD
 
 ## نظرة عامة
-اقترح نموذج X-MOD في ورقة "رفع لعنة تعدد اللغات عن طريق التدريب المسبق للمحولات المعيارية" من قبل Jonas Pfeiffer وآخرون. يوسع X-MOD نماذج اللغة المقنعة متعددة اللغات مثل XLM-R لتشمل مكونات معيارية خاصة باللغة (مهايئات اللغة) أثناء التدريب المسبق. بالنسبة للتعديل الدقيق، يتم تجميد مهايئات اللغة في كل طبقة من المحول.
 
-ملخص الورقة هو كما يلي:
+اقترح نموذج X-MOD في [رفع لعنة تعدد اللغات عن طريق تدريب المحولات النمطية](http://dx.doi.org/10.18653/v1/2022.naacl-main.255) بواسطة Jonas Pfeiffer، Naman Goyal، Xi Lin، Xian Li، James Cross، Sebastian Riedel، و Mikel Artetxe.
+يوسع X-MOD نماذج اللغة المقنعة متعددة اللغات مثل [XLM-R](xlm-roberta) لتشمل مكونات نمطية خاصة باللغة (_مهايئات اللغة_) أثناء التدريب المسبق. بالنسبة للضبط الدقيق، يتم تجميد مهايئات اللغة في كل طبقة محول.
 
-> "من المعروف أن النماذج متعددة اللغات المُدربة مسبقًا تعاني من لعنة تعدد اللغات، والتي تسبب انخفاض الأداء لكل لغة كلما غطت المزيد من اللغات. نعالج هذه المشكلة من خلال تقديم وحدات خاصة باللغة، مما يسمح لنا بزيادة السعة الإجمالية للنموذج، مع الحفاظ على إجمالي عدد المعلمات القابلة للتدريب لكل لغة ثابتة. على عكس العمل السابق الذي يتعلم المكونات الخاصة باللغة بعد التدريب، نقوم بتدريب وحدات نماذجنا المعيارية متعددة اللغات من البداية. تُظهر تجاربنا على الاستدلال اللغوي الطبيعي، وتعريف الكيانات المسماة، والإجابة على الأسئلة أن نهجنا لا يخفف من التداخل السلبي بين اللغات فحسب، بل يمكّن أيضًا من النقل الإيجابي، مما يؤدي إلى تحسين الأداء أحادي اللغة وعبر اللغات. علاوة على ذلك، يمكّن نهجنا من إضافة لغات بعد التدريب دون انخفاض ملحوظ في الأداء، مما لم يعد يقتصر استخدام النموذج على مجموعة اللغات المدربة مسبقًا."
+الملخص من الورقة هو ما يلي:
 
-تمت المساهمة بهذا النموذج من قبل jvamvas. يمكن العثور على الكود الأصلي والتوثيق الأصلي في الروابط المذكورة أعلاه.
+*من المعروف أن النماذج متعددة اللغات المُدربة مسبقًا تعاني من لعنة تعدد اللغات، والتي تتسبب في انخفاض الأداء لكل لغة مع زيادة عدد اللغات التي تغطيها. نحن نعالج هذه المشكلة عن طريق تقديم وحدات نمطية خاصة باللغة، مما يسمح لنا بزيادة السعة الإجمالية للنموذج، مع الحفاظ على إجمالي عدد المعلمات القابلة للتدريب لكل لغة ثابتة. على عكس العمل السابق الذي يتعلم المكونات الخاصة باللغة بعد التدريب، نقوم بتدريب وحدات نمطية لنموذجنا Cross-lingual Modular (X-MOD) من البداية. تُظهر تجاربنا على الاستدلال اللغوي الطبيعي، وتعريف الكيانات المسماة، والإجابة على الأسئلة أن نهجنا لا يخفف من التداخل السلبي بين اللغات فحسب، بل يمكّن أيضًا من النقل الإيجابي، مما يؤدي إلى تحسين الأداء أحادي اللغة والمشترك بين اللغات. علاوة على ذلك، يمكّن نهجنا من إضافة لغات بعد التدريب دون انخفاض ملحوظ في الأداء، مما لم يعد يقيد استخدام النموذج لمجموعة اللغات المدربة مسبقًا.*
+
+تمت المساهمة بهذا النموذج بواسطة [jvamvas](https://huggingface.co/jvamvas).
+يمكن العثور على الكود الأصلي [هنا](https://github.com/facebookresearch/fairseq/tree/58cc6cca18f15e6d56e3f60c959fe4f878960a60/fairseq/models/xmod) والوثائق الأصلية موجودة [هنا](https://github.com/facebookresearch/fairseq/tree/58cc6cca18f15e6d56e3f60c959fe4f878960a60/examples/xmod).
 
 ## نصائح الاستخدام
 
-- يشبه X-MOD نموذج XLM-R، ولكن أحد الاختلافات هو أنه يجب تحديد لغة الإدخال بحيث يمكن تنشيط مهايئ اللغة الصحيح.
-- تحتوي النماذج الرئيسية - base وlarge - على مهايئات لـ 81 لغة.
+نصائح:
+- X-MOD مشابه لـ [XLM-R](xlm-roberta)، ولكن الاختلاف هو أن لغة الإدخال تحتاج إلى التحديد حتى يمكن تنشيط مهايئ اللغة الصحيح.
+- تحتوي النماذج الرئيسية - الأساسية والكبيرة - على مهايئات لـ 81 لغة
 
-## استخدام المهايئ
+## استخدام Adapter
 
 ### لغة الإدخال
 
@@ -120,4 +124,4 @@ model.set_default_language("de_DE")
 
 [[autodoc]] XmodForQuestionAnswering
 
-- forward
\ No newline at end of file
+- forward