Hugging Face's logo

Hub Python Library documentation

Kimlik Doğrulama

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v2.4.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Kimlik Doğrulama

huggingface_hub kütüphanesi, kullanıcıların Hub'a kimlik doğrulamasını programatik olarak yönetmesine olanak tanır. Bu, oturum açma, oturumu kapatma, jetonlar arasında geçiş yapma ve kullanılabilir jetonları listeleme işlemlerini içerir.

Kimlik doğrulama hakkında daha fazla ayrıntı için bu bölümü inceleyin.

giriş yap

huggingface_hub.login

< >

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

Parametreler

  • token (str, isteğe bağlı) — https://huggingface.co/settings/token adresinden oluşturulacak kullanıcı erişim belirteci.
  • add_to_git_credential (bool, varsayılan False) — True ise, token git kimlik bilgisi olarak ayarlanır. Git kimlik bilgisi yardımcısı yapılandırılmamışsa, kullanıcıya bir uyarı görüntülenir. Yalnızca token sağlandığında kullanılır; tarayıcı tabanlı akış tarafından yok sayılır.
  • skip_if_logged_in (bool, varsayılan True) — True ise, kullanıcı zaten oturum açmışsa token için istek yapılmaz. Zorunlu yeniden oturum açmayı uygulamak için False olarak ayarlayın. CLI'da bunun yerine --force kullanın.

Yükseltilen

ValueError veya DeviceCodeError

  • ValueError — Bir organizasyon jetonu geçirilirse. Giriş yapmak için yalnızca kişisel hesap jetonları geçerlidir.
  • ValueError — Token geçersizse.
  • DeviceCodeError — Tarayıcı tabanlı oturum açma işlemi başarısız olursa (yetkilendirme reddedildi, kodun süresi doldu, ...).

Hub'a erişmek için makineye giriş yapın.

token, önbellekte kalıcı olarak saklanır ve bir git kimlik bilgisi olarak ayarlanır. İşlem tamamlandığında makine oturum açmış olur ve erişim jetonu, tüm huggingface_hub bileşenlerinde kullanılabilir hale gelir. token sağlanmazsa, kimlik doğrulama için tarayıcı tabanlı bir OAuth akışı kullanılır: bir URL açılır, kısa bir kod girilir ve jeton alınarak kaydedilir. Bir terminalde, bunun yerine mevcut bir erişim jetonunu yapıştırma seçeneğini de seçebilirsiniz.

Bir betiğin dışından oturum açmak için, login() fonksiyonunu saran bir komut satırı komutu olan hf auth login komutunu da kullanabilirsiniz.

Token geçirilmediğinde, login() betiğin bir notebook'ta mı yoksa değil mi çalıştığını otomatik olarak algılar. Ancak günümüzde mevcut olan çeşitli notebook türleri nedeniyle bu algılama her zaman doğru olmayabilir. Böyle bir durumda, arayüzü notebook_login() veya interpreter_login() kullanarak her zaman zorlayabilirsiniz.

interpreter_login

huggingface_hub.interpreter_login

< >

( skip_if_logged_in: bool = True )

Parametreler

  • skip_if_logged_in (bool, varsayılan True) — True ise, kullanıcı zaten oturum açmışsa token için istek yapılmaz. Zorunlu yeniden oturum açmayı uygulamak için False olarak ayarlayın. CLI'da bunun yerine --force kullanın.

HF web sitesine giriş yapmayı ve belirteci saklamayı içeren bir istem görüntüler.

Bu, bir notebook dışında çalıştırıldığında token geçirilmeden login() çağrısına eşdeğerdir. interpreter_login(), notebook akışı yerine terminal istemcisinin kullanımını zorlamak istediğinizde kullanışlıdır.

Daha fazla ayrıntı için login() bölümüne bakın.

notebook_login

huggingface_hub.notebook_login

< >

( skip_if_logged_in: bool = True )

Parametreler

  • skip_if_logged_in (bool, varsayılan True) — True ise, kullanıcı zaten oturum açmışsa token için istek yapılmaz. Zorunlu yeniden oturum açmayı uygulamak için False olarak ayarlayın. CLI'da bunun yerine --force kullanın.

HF web sitesine giriş yapmayı ve belirteci saklamayı içeren bir istem görüntüler.

Bu, bir notebook'ta çalıştırıldığında token geçirilmeden login() çağrısına eşdeğerdir. Terminalde bir istek yerine notebook akışının kullanımını zorlamak istiyorsanız notebook_login() kullanışlıdır.

Daha fazla ayrıntı için login() bölümüne bakın.

oturumu kapat

huggingface_hub.logout

< >

( token_name: str | None = None )

Parametreler

  • token_name (str, isteğe bağlı) — Çıkış yapılmak istenen erişim jetonunun adı. None ise, kayıtlı tüm erişim jetonlarından çıkış yapılır.

Yükseltilen

ValueError

Makineyi Hub'dan çıkış yapın.

Token makineden silinir ve git kimlik bilgisi (credential) üzerinden kaldırılır.

auth_switch

huggingface_hub.auth_switch

< >

( token_name: stradd_to_git_credential: bool = False )

Parametreler

  • token_name (str) — Geçilecek erişim jetonunun adı.
  • add_to_git_credential (bool, varsayılan False) — True ise, token git credential olarak ayarlanır. Git credential helper yapılandırılmamışsa, kullanıcıya bir uyarı görüntülenir. token None ise, add_to_git_credential değeri yok sayılır ve nihai kullanıcıdan yeniden istenir.

Yükseltilen

ValueError

Farklı bir erişim belirteçine geçin.

auth_list

huggingface_hub.auth_list

< >

( )

Tüm depolanan erişim jetonlarını listeler.

Update on GitHub

←Genel Bakış Ortam değişkenleri→