Hub documentation

البدء باستخدام المستودعات

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

البدء باستخدام المستودعات

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

المتطلبات

يُبيّن هذا المستند كيفية التعامل مع المستودعات عبر واجهة الويب وكذلك عبر الطرفية. لا توجد متطلبات عند العمل مع واجهة المستخدم. إذا كنت ترغب في العمل عبر الطرفية، فالرجاء اتباع تعليمات التثبيت هذه.

إذا لم يكن git متاحًا بعد كأمر سطر أوامر، فستحتاج إلى تثبيت Git لمنصتك. كما ستحتاج إلى تثبيت Git-Xet، والذي سيُستخدم للتعامل مع الملفات الكبيرة مثل الصور وأوزان النماذج.

لتتمكن من تنزيل الملفات الكبيرة ورفعها من Git، تحتاج إلى تثبيت إضافة Git Xet.

للدفع بالكود الخاص بك إلى Hub، ستحتاج إلى المصادقة بطريقة ما. أسهل طريقة للقيام بذلك هي تثبيت hf CLI وتشغيل أمر تسجيل الدخول:

# Install hf:
#   brew install hf
#   or
#   pip install hf
hf auth login

المحتوى الموجود في قسم البدء السريع من هذا المستند متاح أيضًا على شكل فيديو!

إنشاء مستودع

باستخدام واجهة الويب الخاصة بـ Hub يمكنك بسهولة إنشاء المستودعات، وإضافة الملفات (حتى الكبيرة منها!)، واستكشاف النماذج، وتصور الفروقات، والمزيد. هناك ثلاثة أنواع من المستودعات على Hub، وفي هذا الدليل ستقوم بإنشاء مستودع نموذج لأغراض توضيحية. لمزيد من المعلومات حول إنشاء وإدارة النماذج ومجموعات البيانات وSpaces، راجع وثائقها الخاصة.

  1. لإنشاء مستودع جديد، قم بزيارة huggingface.co/new:
  1. حدد مالك المستودع: يمكن أن يكون ذلك أنت أو أي من المنظمات التي تنتمي إليها.

  2. أدخل اسم نموذجك. سيكون هذا أيضًا اسم المستودع.

  3. حدد ما إذا كنت تريد أن يكون نموذجك عامًا أو خاصًا.

  4. حدد الترخيص. يمكنك ترك حقل License فارغًا في الوقت الحالي. للتعرف على التراخيص، قم بزيارة وثائق Licenses.

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

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

إضافة ملفات إلى مستودع (واجهة الويب)

لإضافة ملفات إلى مستودعك عبر واجهة الويب، ابدأ باختيار تبويب Files، ثم انتقل إلى المجلد المطلوب، وانقر على Add file. ستتاح لك خيار إنشاء ملف جديد أو رفع ملف مباشرة من جهازك.

إنشاء ملف جديد

اختيار إنشاء ملف جديد سيأخذك إلى شاشة المحرر التالية، حيث يمكنك اختيار اسم لملفك، وإضافة المحتوى، وحفظ ملفك برسالة تلخص تغييراتك. بدلاً من الالتزام المباشر بالملف الجديد في فرع main في مستودعك، يمكنك تحديد Open as a pull request لإنشاء Pull Request.

رفع ملف

إذا اخترت رفع ملف فستتمكن من اختيار ملف محلي للرفع، إلى جانب رسالة تلخص تغييراتك في المستودع.

كما هو الحال عند إنشاء ملفات جديدة، يمكنك تحديد Open as a pull request لإنشاء Pull Request بدلاً من إضافة تغييراتك مباشرةً إلى فرع main في مستودعك.

إضافة ملفات إلى مستودع (سطر الأوامر)

يمكنك رفع الملفات إلى مستودعك مباشرةً من الطرفية باستخدام أداة سطر الأوامر hf. استخدم الأمر hf upload لدفع الملفات المحلية أو المجلدات بأكملها:

# Upload a single file to your model repo
hf upload your-username/your-model-name model.safetensors

# Upload an entire directory
hf upload your-username/your-model-name ./my-model-directory

# Upload to a dataset repo
hf upload your-username/your-dataset-name ./data --repo-type dataset

يتعامل سطر الأوامر hf مع الملفات الكبيرة تلقائيًا — لا حاجة إلى أي إعداد إضافي.

إضافة ملفات إلى مستودع (git)

استنساخ المستودعات

يُطلق على تنزيل المستودعات إلى جهازك المحلي اسم استنساخ. يمكنك استخدام الأوامر التالية لتحميل مستودعك والتنقل إليه:

git clone https://huggingface.co/<your-username>/<your-model-name>
cd <your-model-name>

أو لمتخزن مجموعة بيانات:

git clone https://huggingface.co/datasets/<your-username>/<your-dataset-name>
cd <your-dataset-name>

يمكنك الاستنساخ عبر SSH باستخدام الأمر التالي:

git clone git@hf.co:<your-username>/<your-model-name>
cd <your-model-name>

ستحتاج إلى إضافة مفتاح SSH العام الخاص بك إلى إعدادات المستخدم لديك لدفع التغييرات أو الوصول إلى المستودعات الخاصة.

الإعداد

الآن حان الوقت، يمكنك إضافة أي ملفات تريدها إلى المستودع! 🔥

هل لديك ملفات أكبر من 10 ميغابايت؟ يجب تتبع هذه الملفات باستخدام git-xet، والذي يمكنك تهيئته عبر:

git xet install

عند استخدامك Hugging Face لإنشاء مستودع، يوفر Hugging Face تلقائيًا قائمة بامتدادات الملفات الشائعة للملفات الكبيرة الشائعة في تعلم الآلة داخل ملف .gitattributes، والذي يستخدمه git-xet لتتبع التغييرات على ملفاتك الكبيرة بكفاءة. ومع ذلك، قد تحتاج إلى إضافة امتدادات جديدة إذا لم تكن أنواع ملفاتك مدعومة بالفعل. يمكنك القيام بذلك باستخدام git xet track "*.your_extension".

دفع الملفات

يمكنك استخدام Git لحفظ الملفات الجديدة وأي تغييرات على الملفات الموجودة مسبقًا في حزمة من التغييرات تُسمى commit، والتي يمكن اعتبارها “مراجعة” لمشروعك. لإنشاء commit، يجب عليك add الملفات لإعلام Git بأننا نخطط لحفظ التغييرات، ثم commit تلك التغييرات. لمزامنة الـ commit الجديد مع Hugging Face Hub، تقوم بعد ذلك بـ push الـ commit إلى الـ Hub.

# Create any files you like! Then...
git add .
git commit -m "First model version"  # You can choose any descriptive message
git push

وقد انتهيت! يمكنك التحقق من مستودعك على Hugging Face مع جميع الملفات التي أُضيفت مؤخرًا. على سبيل المثال، في لقطة الشاشة أدناه، أضاف المستخدم عددًا من الملفات. لاحظ أن بعض الملفات في هذا المثال يبلغ حجمها 1.04 GB، لذا يستخدم المستودع Xet لتتبعها.

إذا قمت بتنزيل المستودع عبر HTTP، فقد يُطلب منك إدخال اسم المستخدم وكلمة المرور في كل عملية دفع. أبسط طريقة لتجنب التكرار هي التبديل إلى SSH بدلاً من HTTP. أو، إذا كان عليك استخدام HTTP، فقد تجد من المفيد إعداد git credential helper لتعبئة اسم المستخدم وكلمة المرور تلقائياً.

عرض سجل المستودع

في كل مرة تمر فيها بدورة add-commit-push، يقوم المستودع بتتبع كل تغيير أجريته على ملفاتك. يتيح لك الواجهة الرسومية استكشاف ملفات النموذج والتزامات (commits) ورؤية الفرق (المعروف أيضًا باسم diff) الذي أدخلته كل التزام. لعرض السجل، يمكنك النقر على رابط History: X commits.

يمكنك النقر على أي التزامن (commit) فردي لرؤية التغييرات التي أدخلها ذلك التزامن:

Update on GitHub