قالب بطاقة النموذج المُعلَّم

هل تستعد للنشر؟ راجع قائمة التحقق من إصدار النموذج للخطوات الأساسية لإصدار نموذج موجز ومفيد وسهل الاستخدام.

قالب

ملف modelcard_template.md

الاتجاهات

يتطلب ملء بطاقة النموذج بالكامل مدخلات من عدة أدوار مختلفة. (قد يتولى شخص واحد أكثر من دور.) سنشير إلى هذه الأدوار على النحو التالي: المطوّر، الذي يكتب الكود ويشغّل التدريب؛ وخبير التقنيات الاجتماعية، الذي يملك مهارة تحليل التفاعل بين التكنولوجيا والمجتمع على المدى الطويل (ويتضمن ذلك المحامين، وأخلاقيي التقنية، وعلماء الاجتماع، أو المدافعين عن الحقوق)؛ ومنسّق المشروع، الذي يفهم النطاق والامتداد الكلي للنموذج، ويستطيع ملء كل جزء من البطاقة بشكل تقريبي، ويعمل كشخص مسؤول عن تحديثات بطاقة النموذج.

• يُعدّ المطوّر ضروريًا لإكمال إجراءات التدريب والمواصفات التقنية. كما أنه مفيد بشكل خاص لقسم “القيود” ضمن التحيز والمخاطر والقيود. وهو المسؤول عن تقديم النتائج للتقييم، ومن المثالي أن يعمل مع الأدوار الأخرى لتحديد بقية عناصر التقييم: بيانات الاختبار والعوامل والمقاييس.

• يُعدّ الجانب الاجتماعي التقني ضروريًا لإكمال أقسام “التحيز” و”المخاطر” ضمن التحيز والمخاطر والقيود، وهو مفيد بشكل خاص لقسم “الاستخدام خارج النطاق” ضمن الاستخدامات.

• يُعدّ منسّق المشروع ضروريًا لملء تفاصيل النموذج والاستخدامات. وقد يقومون أيضًا بملء بيانات التدريب. كما يمكن أن يتولّى منسقو المشروع مسؤولية الاستشهاد، والمسرد، وجهة الاتصال لبطاقة النموذج، ومؤلفو بطاقة النموذج، ومزيد من المعلومات.

تُقدَّم التعليمات أدناه، بخط مائل.

تظهر أسماء متغيرات القالب في monospace.

---

اسم النموذج

نظرة عامة على القسم: اذكر اسم النموذج وملخصًا من جملة إلى جملتين يوضح ما هو النموذج.

model_id

model_summary

جدول المحتويات

نظرة عامة على القسم: قدّم هذا مع روابط إلى كل قسم، لتمكين الأشخاص من الانتقال بسهولة بين الأقسام/استخدام الملف في مواقع أخرى مع الحفاظ على فهرس المحتويات/طباعة المحتوى/إلخ.

تفاصيل النموذج

نظرة عامة على القسم: يقدّم هذا القسم معلومات أساسية حول ماهية النموذج، وحالته الحالية، ومصدره. ينبغي أن يكون مفيدًا لأي شخص يرغب في الاستشهاد بالنموذج.

وصف النموذج

model_description

قدّم تفاصيل أساسية عن النموذج. ويشمل ذلك البنية المعمارية، والإصدار، وما إذا كان قد أُدخل في ورقة بحثية، وما إذا كان هناك تنفيذ أصلي متاح، والمبدعون. يجب ذكر أي حقوق ملكية فكرية هنا. كما يمكن ذكر معلومات عامة حول إجراءات التدريب، والمعاملات، والإخلاءات المهمة في هذا القسم.

• طوّرته: developers

اذكر (ويفضَّل أن تضيف روابط إلى) الأشخاص الذين بنوا النموذج.

• بتمويل من: funded_by

قائمة (والربط بها إن أمكن) بمصادر التمويل التي دعمت أو مكّنت هذا النموذج مالياً أو حاسوبياً أو بأي شكل آخر.

• مشارك من قِبل [اختياري]: shared_by

اذكر (ويفضَّل أن تضيف رابطًا إلى) الأشخاص أو الجهة التي تجعل النموذج متاحًا عبر الإنترنت.

• نوع النموذج: model_type

يمكنك تسمية “النوع” على النحو التالي:

1. طريقة الإشراف/التعلم

2. نوع تعلم الآلة

3. النمط

• اللغة/اللغات [معالجة اللغة الطبيعية]: language

استخدم هذا الحقل عندما يستخدم النظام اللغة الطبيعية (البشرية) أو يعالجها.

• الترخيص: license

اسم الترخيص المستخدم ورابطه.

• النموذج المُحسَّن من نموذج [اختياري]: base_model

إذا كان لهذا النموذج نموذج أساسي آخر، فقم بربط ذلك النموذج هنا.

مصادر النموذج اختيارية

• المستودع: repo
• الورقة البحثية [اختياري]: paper
• عرض توضيحي [اختياري]: demo

قدّم للمستخدم مصادر تتيح له الاطلاع مباشرة على النموذج وتفاصيله. أما أنواع الموارد الإضافية – مثل سجلات التدريب والدروس المستفادة وما إلى ذلك – فتُدرج في قسم مزيد من المعلومات. إذا أضفت عنصرًا واحدًا لهذا القسم، فاجعل الرابط يشير إلى المستودع.

الاستخدامات

نظرة عامة على القسم: يتناول هذا القسم الأسئلة المتعلقة بكيفية استخدام النموذج المقصود في سياقات تطبيقية مختلفة، ويناقش المستخدمين المتوقعين للنموذج (بما في ذلك أولئك المتأثرون بالنموذج)، ويصف الاستخدامات التي تُعتبر خارج النطاق أو إساءة استخدام للنموذج. يُرجى ملاحظة أن هذا القسم لا يُقصد به تضمين تفاصيل ترخيص الاستخدام. لذلك، يُرجى الربط مباشرةً بالترخيص.

الاستخدام المباشر

direct_use

اشرح كيف يمكن استخدام النموذج دون ضبط دقيق أو معالجة لاحقة أو دمجه في خط أنابيب. يُنصح بتضمين مثال على مقطع من الشيفرة.

الاستخدام في المراحل اللاحقة اختياري

downstream_use

اشرح كيف يمكن استخدام هذا النموذج عند ضبطه الدقيق لمهمة معينة أو عند دمجه في نظام أو تطبيق أكبر. يُنصح بإدراج مثال على مقتطف من الشيفرة.

الاستخدام خارج النطاق

out_of_scope_use

اذكر الطرق التي قد يُساء استخدام النموذج بها بشكل متوقع (أي الاستخدامات التي لن يعمل النموذج بشكل صحيح فيها)، وبيّن ما ينبغي على المستخدمين عدم القيام به بالنموذج.

التحيز والمخاطر والقيود

نظرة عامة على القسم: يحدد هذا القسم الأضرار المحتملة، وسوء الفهم، والقيود التقنية والتقنية الاجتماعية. كما يوفر معلومات حول التحذيرات والإجراءات المحتملة للتخفيف من حدتها. قد تكون التحيزات والمخاطر والقيود غير قابلة للفصل في بعض الأحيان/تشير إلى نفس المشكلات. بشكل عام، التحيزات والمخاطر تقنية اجتماعية، بينما القيود تقنية:

• التحيز هو نمط نمطي أو أداء غير متناسب (انحياز) لبعض المجموعات الفرعية.
• المخاطر هي القضايا ذات الصلة الاجتماعية التي قد يسببها النموذج.
• القيود هي أوضاع فشل محتملة يمكن معالجتها باتباع التوصيات المذكورة.

bias_risks_limitations

ما هي المشكلات المعروفة أو المتوقعة الناجمة عن هذا النموذج؟

التوصيات

bias_recommendations

ما هي التوصيات المتعلقة بالمشاكل المتوقعة؟ يمكن أن يشمل ذلك كل شيء بدءًا من «تقليل دقة صورتك» وصولًا إلى تصفية المحتوى الصريح.

تفاصيل التدريب

نظرة عامة على القسم: يوفّر هذا القسم معلومات لوصف التدريب وتكراره، بما في ذلك بيانات التدريب، وسرعة وعناصر التدريب وحجمها، والأثر البيئي للتدريب. كما يرتبط هذا القسم ارتباطًا وثيقًا بـ المواصفات التقنية، وينبغي أن تربط المحتوى هنا بتلك القسم عندما يكون ذا صلة بإجراء التدريب. وهو مفيد للأشخاص الذين يرغبون في معرفة المزيد حول مدخلات النموذج وأثر التدريب. وهو ذو صلة بأي شخص يرغب في معرفة أساسيات ما يتعلمه النموذج.

بيانات التدريب

training_data

اكتب جملة أو جملتين تصفان بيانات التدريب. يُفضّل أن يتضمن هذا رابطًا إلى بطاقة مجموعة البيانات (Dataset Card) للحصول على مزيد من المعلومات. يمكن أيضًا إدراج الروابط إلى التوثيق المتعلق بمعالجة البيانات الأولية أو الترشيح الإضافي هنا وكذلك في مزيد من المعلومات.

إجراء التدريب اختياري

المعالجة المسبقة

preprocessing

تفصيل عملية الترميز، وإعادة الحجم/إعادة الكتابة (حسب النمط)، وما إلى ذلك.

السرعات، الأحجام، الأزمنة

speeds_sizes_times

تفاصيل الإنتاجية، وقت البدء/الإنهاء، أحجام نقاط التفتيش، وما إلى ذلك.

التقييم

نظرة عامة على القسم: يصف هذا القسم بروتوكولات التقييم، وما الذي يُقاس في عملية التقييم، ويقدّم النتائج. يتكوّن التقييم المثالي من جزأين على الأقل، أحدهما يتناول القياس الكمي للأداء العام (بيانات الاختبار والعوامل والمقاييس)، كما قد يتم من خلال إجراء اختبارات المعيار المرجعي؛ والآخر يتناول الأداء فيما يتعلق بقضايا السلامة الاجتماعية المحددة (تقييم الأثر المجتمعي)، كما قد يتم من خلال إجراء اختبارات الاختراق. يمكنك أيضًا تحديد نتائج تقييم نموذجك بطريقة منظمة في بيانات بطاقة النموذج الوصفية. تُحلَّل النتائج بواسطة Hub وتُعرض في أداة على صفحة النموذج. راجع https://huggingface.co/docs/hub/model-cards#evaluation-results.

اختبار البيانات والعوامل والمقاييس

يُفضَّل أن تكون التقييمات مفصّلة فيما يتعلق بعوامل مختلفة، مثل المهمة والمجال والفرع السكاني؛ وأن تُحسب باستخدام مقاييس تكون الأكثر دلالةً في سياقات الاستخدام المتوقعة. يُقال إن أداء التقييم المتساوي عبر الفروع السكانية المختلفة هو “عادل” تجاه تلك الفروع؛ ويجب تحديد مقاييس العدالة المستهدفة بناءً على الأخطاء التي من المرجح أن تكون أكثر إشكالية في ضوء استخدام النموذج. ومع ذلك، يُستخدم هذا القسم في الغالب للإبلاغ عن أداء التقييم الإجمالي على معايير المهام المختلفة.

بيانات الاختبار

testing_data

صف بيانات الاختبار أو اربط ببطاقة مجموعة البيانات الخاصة بها.

العوامل

testing_factors

ما هي الخصائص المتوقعة التي ستؤثر على سلوك النموذج؟ يجب أن يكون التقييم مفصلاً عبر هذه العوامل، في المثالي، لكشف الفوارق في الأداء.

المقاييس

testing_metrics

ما هي المقاييس التي ستُستخدم للتقييم؟

النتائج

results

يجب أن تستند النتائج إلى العوامل والمقاييس المحددة أعلاه.

ملخص

results_summary

ماذا تقول النتائج؟ يمكن أن تعمل هذه الفقرة كملخص موجز للجمهور العام.

تقييم الأثر المجتمعي اختياري

استخدم هذا القسم النصي المجاني لشرح كيفية تقييم هذا النموذج من حيث مخاطر الإضرار بالمجتمع، مثل مخاطر تتعلق بسلامة الأطفال، والمحتوى غير اللائق (NCII)، والخصوصية، والعنف. وقد يأخذ ذلك شكل إجابات على الأسئلة التالية:

• هل هذا النموذج آمن للاستخدام من قِبل الأطفال؟ ولماذا؟
• هل تم اختبار هذا النموذج لتقييم المخاطر المتعلقة بالصور الحميمة غير المتفق عليها (بما في ذلك CSEM)؟
• هل تم اختبار هذا النموذج لتقييم المخاطر المتعلقة بالأنشطة العنيفة أو صور العنف؟ وماذا كانت النتائج؟

قد يتم أيضًا تقديم أرقام كمية لكل مشكلة.

فحص النموذج اختياري

نظرة عامة على القسم: هذا قسم تجريبي بدأ بعض المطورين بإضافته، وقد يُستضاف فيه العمل المتعلق بالقدرة على التفسير/الإدراك.

model_examination

الأثر البيئي

نظرة عامة على القسم: يلخص المعلومات اللازمة لحساب الآثار البيئية مثل استهلاك الكهرباء وانبعاثات الكربون.

• نوع العتاد: hardware_type
• الساعات المستخدمة: hours_used
• مزود الخدمة السحابية: cloud_provider
• منطقة الحساب: cloud_region
• الانبعاثات الكربونية: co2_emitted

يمكن تقدير انبعاثات الكربون باستخدام حاسبة تأثير تعلم الآلة المقدمة في Lacoste et al. (2019).

المواصفات الفنية اختيارية

نظرة عامة على القسم: يتضمن هذا القسم تفاصيل حول هدف النموذج ومعماريته، والبنية التحتية الحاسوبية. وهو مفيد للأشخاص المهتمين بتطوير النموذج. عادةً ما يتطلب كتابة هذا القسم مشاركة مطوّر النموذج بشكل مباشر.

بنية النموذج والهدف

model_specs

بنية الحوسبة

compute_infrastructure

الأجهزة

hardware_requirements

ما هي الحد الأدنى من متطلبات الأجهزة، مثل متطلبات المعالجة والتخزين والذاكرة؟

البرمجيات

software

الاستشهاد اختياري

نظرة عامة على القسم: الاستشهاد المفضل لدى المطورين لهذا النموذج. وغالبًا ما يكون ذلك ورقة بحثية.

BibTeX

citation_bibtex

APA

citation_apa

المصطلحات اختياري

نظرة عامة على القسم: يحدد هذا القسم المصطلحات الشائعة وكيفية حساب المقاييس.

glossary

حدّد المصطلحات بوضوح لضمان إتاحتها لشرائح متنوعة من الجمهور.

مزيد من المعلومات اختياري

نظرة عامة على القسم: يوفر هذا القسم روابط إلى كتابات حول إنشاء مجموعات البيانات، والمواصفات التقنية، والدروس المستفادة، والنتائج الأولية.

more_information

مؤلفو بطاقة النموذج اختياري

نظرة عامة على القسم: يحدد هذا القسم الأشخاص الذين يقومون بإنشاء بطاقة النموذج، مما يوفر الاعتراف بالمسؤولية عن العمل التفصيلي الذي يُبذل في بنائها.

model_card_authors

تواصل مع بطاقة النموذج

نظرة عامة على القسم: يوفر طريقة للأشخاص الذين لديهم تحديثات لبطاقة النموذج، أو اقتراحات، أو أسئلة، للتواصل مع مؤلفي بطاقة النموذج

model_card_contact

كيفية البدء بالنموذج

نظرة عامة على القسم: يوفر مقتطفًا من الكود لإظهار كيفية استخدام النموذج.

get_started_code

---

يُرجى الاستشهاد بها على النحو التالي: Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook

Update on GitHub