Hugging Face's logo

Hub Python Library documentation

المصادقة

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

المصادقة

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

لمزيد من التفاصيل حول المصادقة، راجع هذا القسم.

تسجيل الدخول

huggingface_hub.login

< >

( token: str | None = Noneadd_to_git_credential: bool = Falseskip_if_logged_in: bool = True )

المعاملات

  • token (str، اختياري) — رمز وصول المستخدم لإنشائه من https://huggingface.co/settings/token.
  • add_to_git_credential (bool، القيمة الافتراضية False) — إذا كانت True، فسيتم تعيين الرمز كاعتمادية git. إذا لم يتم تكوين مساعد اعتمادية git، فسيتم عرض تحذير للمستخدم. يُستخدم فقط عند تقديم token؛ ويُتجاهل في التدفق القائم على المتصفح.
  • skip_if_logged_in (bool، القيمة الافتراضية True) — إذا كانت True، فلا تطلب رمز المصادقة إذا كان المستخدم مسجلاً بالفعل. اضبطها على False لإجبار تسجيل الدخول من جديد. في سطر الأوامر، استخدم --force بدلاً من ذلك.

يرفع

ValueError أو DeviceCodeError

  • ValueError — إذا تم تمرير رمز منظمة. الرموز الخاصة بالحسابات الشخصية فقط هي الصالحة للتسجيل في الدخول.
  • ValueError — إذا كان الرمز غير صالح.
  • DeviceCodeError — إذا فشل تسجيل الدخول عبر المتصفح (تم رفض التفويض، انتهت صلاحية الرمز، ...).

سجّل الدخول إلى الجهاز للوصول إلى Hub.

يتم حفظ token في ذاكرة التخزين المؤقت وإعداده كإذن git. بعد الانتهاء، تكون الآلة مسجّلة الدخول، وسيصبح رمز الوصول متاحًا عبر جميع مكوّنات huggingface_hub. إذا لم يتم تقديم token، فسيتم استخدام تدفق OAuth القائم على المتصفح للمصادقة: فتح رابط URL، إدخال رمز قصير، ثم يتم استرداد الرمز وحفظه. في الطرفية، يمكنك أيضًا اختيار لصق رمز وصول موجود مسبقًا بدلاً من ذلك.

للتسجيل من خارج السكربت، يمكن أيضًا استخدام hf auth login وهو أمر سطر أوامر يغلّف login().

عند عدم تمرير الرمز، سيقوم login() تلقائيًا بالكشف عما إذا كان السكربت يعمل داخل دفتر ملاحظات أم لا. ومع ذلك، قد لا يكون هذا الكشف دقيقًا بسبب تنوع دفاتر الملاحظات الموجودة حاليًا. في هذه الحالة، يمكنك دائمًا إجبار الواجهة على استخدام notebook_login() أو interpreter_login().

interpreter_login

huggingface_hub.interpreter_login

< >

( skip_if_logged_in: bool = True )

المعاملات

  • skip_if_logged_in (bool، القيمة الافتراضية True) — إذا كانت True، فلا تطلب رمز المصادقة إذا كان المستخدم مسجلاً بالفعل. اضبطها على False لإجبار تسجيل الدخول من جديد. في سطر الأوامر، استخدم --force بدلاً من ذلك.

يعرض مطالبة لتسجيل الدخول إلى موقع HF وحفظ الرمز.

يُعدّ هذا مكافئًا لاستدعاء login() دون تمرير رمز عند عدم التشغيل في دفتر ملاحظات. يُفيد استخدام interpreter_login() إذا كنت ترغب في فرض استخدام موجه الطرفية بدلاً من سير عمل دفتر الملاحظات.

لمزيد من التفاصيل، راجع login().

notebook_login

huggingface_hub.notebook_login

< >

( skip_if_logged_in: bool = True )

المعاملات

  • skip_if_logged_in (bool، القيمة الافتراضية True) — إذا كانت True، فلا تطلب رمز المصادقة إذا كان المستخدم مسجلاً بالفعل. اضبطها على False لإجبار تسجيل الدخول من جديد. في سطر الأوامر، استخدم --force بدلاً من ذلك.

يعرض مطالبة لتسجيل الدخول إلى موقع HF وحفظ الرمز.

يعادل هذا الأمر login() دون تمرير رمز عند التشغيل في دفتر ملاحظات. يكون notebook_login() مفيداً إذا كنت ترغب في إجبار استخدام تدفق دفتر الملاحظات بدلاً من مطالبة في الطرفية.

لمزيد من التفاصيل، راجع login().

تسجيل الخروج

huggingface_hub.logout

< >

( token_name: str | None = None )

المعاملات

  • token_name (str, اختياري) — اسم رمز الوصول الذي تريد تسجيل الخروج منه. إذا كان None، سيتم تسجيل الخروج من جميع رموز الوصول المحفوظة.

يرفع

ValueError

  • ValueError — إذا لم يتم العثور على اسم رمز الوصول.

سجّل خروج الجهاز من Hub.

يتم حذف الرمز من الجهاز وإزالته من بيانات اعتماد git.

auth_switch

huggingface_hub.auth_switch

< >

( token_name: stradd_to_git_credential: bool = False )

المعاملات

  • token_name (str) — اسم رمز الوصول الذي تريد التبديل إليه.
  • add_to_git_credential (bool، القيمة الافتراضية False) — إذا كانت True، فسيتم تعيين الرمز كـ git credential. إذا لم يتم تكوين مساعد git credential، فسيتم عرض تحذير للمستخدم. إذا كان token هو None، فسيتم تجاهل قيمة add_to_git_credential وسيتم طلبها مرة أخرى من المستخدم النهائي.

يرفع

ValueError

  • ValueError — إذا لم يتم العثور على اسم رمز الوصول.

التبديل إلى رمز وصول مختلف.

auth_list

huggingface_hub.auth_list

< >

( )

list_access_tokens

Update on GitHub

←نظرة عامة متغيرات البيئة→