Hub documentation

قائمة التحقق من إصدار النموذج/النماذج

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

قائمة التحقق من إصدار النموذج/النماذج

يُعدّ Hugging Face Hub المنصة المرجعية لمشاركة نماذج تعلّم الآلة. يمكن للإصدار المنفَّذ باحترافية أن يعزّز ظهور نموذجك وتأثيره. تغطي هذه القسم الخطوات الأساسية لإصدار نموذج موجز ومفيد وسهل الاستخدام.

هل تنوي الإصدار باستخدام وكيل برمجي؟ ثبّت مهارة hf سطر الأوامر ليتمكن وكيلك من التعامل عنك مع عملية الرفع وبطاقة النموذج والبيانات الوصفية.

⏳ تجهيز نموذجك للإصدار

رفع أوزان النموذج

عند رفع النماذج إلى Hub، اتبع أفضل الممارسات التالية:

  • استخدام مستودعات منفصلة لأوزان نماذج مختلفة: أنشئ مستودعات فردية لكل متغير من نفس البنية. يتيح لك ذلك تجميعها في مجموعة، وهي أسهل في التنقل من قوائم المجلدات. كما يحسّن هذا الظهور لأن لكل نموذج عنوان URL خاصًا به (hf.co/org/model-name)، ويجعل البحث أسهل، ويوفر عدد مرات التنزيل لكل نموذج من نماذجك. مثال رائع على ذلك هو مجموعة Qwen3-VL الحديثة التي تضم متغيرات مختلفة من بنية VL.

  • يُفضَّل استخدام safetensors بدلاً من pickle لتسلسل الأوزان.: safetensors أكثر أماناً وسرعة من pickle أو pth في بايثون. إذا كان لديك ملف pickle بصيغة .bin، فاستخدم أداة تحويل الأوزان لتحويله.

اكتب بطاقة نموذج شاملة

بطاقة نموذج مُصمَّمة بعناية (ملف README.md في مستودعك) ضرورية للعثور على النموذج، وإعادة إنتاج نتائجه، ومشاركته بفعالية. تأكد من تضمين ما يلي:

  1. إعداد البيانات الوصفية: يُعدّ قسم البيانات الوصفية (YAML) في أعلى بطاقة النموذج عنصراً أساسياً للبحث والتصنيف. يتضمن:

    ---
    pipeline_tag: text-generation    # Specify the task
    library_name: transformers       # Specify the library
    language:
      - en                           # List languages your model supports
    license: apache-2.0              # Specify a license
    datasets:
      - username/dataset             # List datasets used for training
    base_model: username/base-model  # If applicable (your model is a fine-tune, quantized, merged version of another model)
    tags:                            # Add extra tags which would make the repo searchable using the tag
      - tag1 
      - tag2
    ---

    إذا أنشأت README.md في واجهة الويب، فسترى نموذجًا يحتوي على أهم حقول البيانات الوصفية التي نوصي بها 🤗.

    metadata template on the hub ui
    نموذج البيانات الوصفية في واجهة مستخدم Hub
  2. وصف تفصيلي للنموذج: قدّم شرحًا واضحًا لما يفعله نموذجك، وبنيته المعمارية، وحالات الاستخدام المقصودة. ساعد المستخدمين على اتخاذ قرار سريع بشأن ما إذا كان يناسب احتياجاتهم.

  3. أمثلة على الاستخدام: قدّم مقاطع كود واضحة يمكن نسخها وتشغيلها مباشرةً للاستدلال أو الضبط الدقيق أو المهام الشائعة الأخرى. قلّل إلى الحد الأدنى التعديلات التي يحتاج المستخدمون إلى إجرائها.

    مكافأة إضافية: أضف notebook.ipynb منظمًا بشكل جيد في المستودع يعرض الاستدلال أو الضبط الدقيق، بحيث يمكن للمستخدمين فتحه مباشرة في Google Colab و Kaggle Notebooks.

    colab and kaggle button
    أزرار الاستخدام في Google وKaggle
  4. المواصفات التقنية: تضمّن معاملات التدريب، ومتطلبات الأجهزة، وأي تفاصيل أخرى تساعد المستخدمين على تشغيل النموذج بفعالية.

  5. مقاييس الأداء: شارك نتائج الاختبارات المرجعية والتقييم. شمل مقاييس كمية وأمثلة نوعية لإظهار نقاط القوة والقيود.

  6. القيود والتحيزات: وثّق القيود والتحيزات والمقاييس الأخلاقية المعروفة حتى يتمكن المستخدمون من اتخاذ قرارات مستنيرة.

لجعل العملية أكثر سلاسة، انقر على استيراد قالب بطاقة النموذج لملء ملفات README.md مسبقًا بمواقع نائبة.

model card template button on the hub uimodel card template on the hub
زر استيراد قالب بطاقة النموذجقسم من القالب المستورد

تحسين قابلية اكتشاف النماذج وسهولة استخدامها

لتحقيق أقصى قدر من الانتشار وسهولة الاستخدام:

  1. تكامل المكتبات: أضِف دعمًا لإحدى المكتبات المتكاملة مع Hugging Face Hub (مثل transformers، diffusers، sentence-transformers، timm). يزيد هذا التكامل بشكل كبير من إمكانية الوصول إلى نموذجك، ويوفّر للمستخدمين مقتطفات أكواد للتعامل مع نموذجك.

    على سبيل المثال، لتحديد أن نموذجك يعمل مع مكتبة transformers:

    ---
    library_name: transformers
    ---
    code snippet tab
    تبويب مقتطف الشيفرة

    يمكنك أيضًا تسجيل مكتبة نماذجك الخاصة أو إضافة دعم Hub إلى مكتبتك وقاعدة الكود الخاصة بك، حتى يعرف المستخدمون كيفية تنزيل أوزان النماذج من Hub.

    لقد كتبنا دليلاً شاملاً حول أفضل الممارسات في عملية الرفع هنا.

    يُتيح لك استخدام مكتبة مسجّلة أيضًا تتبع تنزيلات نموذجك بمرور الوقت.

  2. بيانات وصفية صحيحة:

    • وسم خط الأنابيب: اختر وسم خط الأنابيب الصحيح حتى يظهر نموذجك في عمليات البحث والوحدات المناسبة.

    أمثلة على وسوم خطوط الأنابيب الشائعة:

    • text-generation - لنماذج اللغة التي تولّد النص

    • text-to-image - لنماذج توليد الصور من النص

    • image-text-to-text - لنماذج الرؤية واللغة (VLMs) التي تولّد النص

    • text-to-speech - للنماذج التي تولّد الصوت من النص

    • الترخيص: معلومات الترخيص بالغة الأهمية للمستخدمين لفهم كيفية استخدام النموذج.

  3. أوراق البحث: إذا كان لديك أوراق بحثية مرتبطة بنموذجك، فاستشهد بها في بطاقة النموذج. سيتم ربطها تلقائيًا.

    ## References
    
    * [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)
  4. المجموعات: إذا كنت تنوي إصدار عدة نماذج أو متغيرات ذات صلة، فقم بتنظيمها في مجموعة. تساعد المجموعات المستخدمين على اكتشاف النماذج ذات الصلة وفهم العلاقات بين الإصدارات.

  5. التجارب التفاعلية: أنشئ مساحة Hugging Face تتضمن تجربة تفاعلية. يتيح ذلك للمستخدمين تجربة نموذجك دون كتابة أي أكواد. كما يمكنك ربط النموذج من المساحة ليظهر في واجهة صفحة النموذج.

    ## Demo
    
    Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)

    عند إنشاء عرض توضيحي، حمّل النموذج من مستودعه على Hub (وليس من مصادر خارجية مثل Google Drive). يربط هذا بين المخرجات ويحسّن من مستوى الظهور

  6. الإصدارات المُكمّاة: فكّر في رفع الإصدارات المُكمّاة (مثل GGUF) في مستودع منفصل لتحسين إمكانية الوصول للمستخدمين ذوي قدرات الحوسبة المحدودة. اربط هذه الإصدارات باستخدام حقل البيانات الوصفية base_model في بطاقات النماذج المُكمّاة، ووثّق الفروق في الأداء.

    ---
    base_model: username/original-model
    base_model_relation: quantized
    ---
    model tree showcasing relations
    شجرة نماذج تُظهر الإصدارات المُكمّمة
  7. ربط مجموعات البيانات في صفحة النموذج: اربط مجموعات البيانات في بياناتك الوصفية لتظهر مباشرةً في صفحة نموذجك.

    ---
    datasets:
    - username/dataset
    - username/dataset-2
    ---
  8. إصدار جديد للنموذج: إذا كان نموذجك تحديثًا لنموذج موجود مسبقًا، فحدد ذلك في بطاقة النموذج الأقدم. سيؤدي هذا إلى عرض شريط في الصفحة الأقدم يربط بالتحديث.

    ---
    new_version: username/updated-model
    ---
  9. أمثلة بصرية: بالنسبة إلى نماذج توليد الصور أو الفيديو، قم بتضمين الأمثلة مباشرةً في صفحة النموذج الخاصة بك باستخدام مكوّن بطاقة <Gallery>.

    <Gallery>
    ![Example 1](./images/example1.png)
    ![Example 2](./images/example2.png)
    </Gallery>
  10. انبعاثات الكربون: إذا أمكن، حدد انبعاثات الكربون الناتجة عن التدريب.

    ---
    co2_eq_emissions:
      emissions: 123.45
      source: "CodeCarbon"
      training_type: "pre-training"
      geographical_location: "US-East"
      hardware_used: "8xA100 GPUs"
    ---

التحكم في الوصول والإظهار

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

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

🏁 بعد نشر نموذجك

إن إطلاق نموذج ناجح يتجاوز مجرد النشر الأولي. للحفاظ على الجودة وتعظيم الأثر:

الصيانة والتفاعل مع المجتمع

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

    على سبيل المثال، إذا كان نموذجك نموذج لغة كبير متوافق مع transformers:

    from transformers import pipeline
    
    # This should run without errors
    pipe = pipeline("text-generation", model="your-username/your-model")
    result = pipe("Your test prompt")
    print(result)
  2. مشاركة مشاركة مشاركة: يكتشف معظم المستخدمين النماذج عبر وسائل التواصل الاجتماعي، وقنوات المحادثة (مثل Slack أو Discord)، أو النشرات الإخبارية. شارك روابط نماذجك في هذه المساحات، وأضفها أيضًا إلى موقعك الإلكتروني أو مستودعات GitHub الخاصة بك.

    كلما زادت الزيارات والإعجابات التي يتلقاها نموذجك، ارتفع ترتيبه في قسم النماذج الرائجة على Hugging Face، مما يمنحه مزيداً من الظهور

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

إضافة نتائج التقييم

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

لإضافة نتائج التقييم، أنشئ ملفات YAML في مجلد .eval_results/ في مستودع النموذج الخاص بك. يشير كل ملف إلى مجموعة بيانات Hub Benchmark:

# .eval_results/gpqa.yaml
- dataset:
    id: Idavidrein/gpqa
    task_id: diamond
  value: 76.1
  date: "2026-03-19"
  source:
    url: https://huggingface.co/your-org/your-model
    name: Model Card
    user: your-username

يجب أن يتطابق task_id مع مهمة معرّفة في ملف eval.yaml الخاص بمجموعة بيانات المعيار. يمكنك العثور على المعايير المتاحة ومعرّفات مهامها عن طريق فحص ملف eval.yaml في مستودعات مجموعات بيانات المعايير مثل HLE.

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

تتبع الاستخدام والأثر

  1. مقاييس الاستخدام: تتبّع عمليات التنزيل والإعجابات لفهم مدى انتشار نموذجك وتبنيه. يمكنك عرض مقاييس التنزيل الإجمالية في إعدادات نموذجك.

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

🏢 ميزات المؤسسات

توفر اشتراكات فريق Hugging Face والمؤسسات قدرات إضافية للفرق والمنظمات:

  1. التحكم في الوصول: اضبط مجموعات الموارد لإدارة الوصول للفرق أو المستخدمين المحددين. يضمن ذلك منح الصلاحيات المناسبة والتعاون الآمن عبر مؤسستك.

  2. منطقة التخزين: اختر منطقة تخزين البيانات (الولايات المتحدة أو الاتحاد الأوروبي) لملفات النموذج الخاصة بك لتلبية لوائح البيانات الإقليمية ومتطلبات الامتثال.

  3. التحليلات المتقدمة: استخدم Publisher Analytics للحصول على رؤى أعمق حول أنماط استخدام النماذج، والتحميلات، واتجاهات الاعتماد عليها في مؤسستك.

  4. التخزين الموسّع: الوصول إلى سعة تخزين خاصة إضافية لاستضافة المزيد من النماذج والمخرجات الأكبر حجمًا مع توسع محفظتك من النماذج.

  5. منشورات المدونات الخاصة بالمنظمات: يمكن للمنظمات المؤسسية الآن نشر مقالات المدونات مباشرةً على Hugging Face. يتيح لك ذلك مشاركة إصدارات النماذج، وتحديثات الأبحاث، والإعلانات مع المجتمع الأوسع، كل ذلك من ملف منطمتك الشخصي.

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

لا نتمالك أنفسنا من شوقنا لرؤية ما ستشاركه تالياً! 🤗

Update on GitHub