HuggingFace Hub kök kaydedicisi için geçerli seviyeyi döndürür.

HuggingFace Hub aşağıdaki kayıt seviyelerine sahiptir:

• huggingface_hub.logging.CRITICAL, huggingface_hub.logging.FATAL
• huggingface_hub.logging.ERROR
• huggingface_hub.logging.WARNING, huggingface_hub.logging.WARN
• huggingface_hub.logging.INFO
• huggingface_hub.logging.DEBUG

HuggingFace Hub'un kök kayıtçısının seviyesini ayarlar.

Ayrıntı düzeyini logging.INFO olarak ayarlar.

Ayrıntı düzeyini logging.DEBUG olarak ayarlar.

Ayrıntı düzeyini logging.WARNING olarak ayarlar.

Ayrıntı düzeyini logging.ERROR olarak ayarlar.

Kütüphane günlük çıktıları için yayılımı devre dışı bırakır. Not: Günlük yayılımı varsayılan olarak devre dışıdır.

Kütüphane günlük çıktıları için yayılımı etkinleştirin. Kök kayıtçı yapılandırıldıysa, çift günlükleme önlemek için HuggingFace Hub varsayılan işleyicisini devre dışı bırakın.

Belirtilen adla bir kayıtçı döndürür. Bu fonksiyonun kütüphane kullanıcıları tarafından doğrudan erişilmesi beklenmez.

>>> from huggingface_hub import logging

>>> logger = logging.get_logger(__name__)
>>> logging.set_verbosity_info()

İlerleme çubuklarının küresel olarak veya belirli bir grup için devre dışı bırakılıp bırakılmadığını kontrol edin.

Bu fonksiyon, belirli bir grup için veya genel olarak ilerleme çubuklarının devre dışı bırakılıp bırakılmadığını döndürür. Önce HF_HUB_DISABLE_PROGRESS_BARS ortam değişkenini, ardından programatik ayarları kontrol eder.

İlerleme çubuklarını küresel olarak veya belirli bir grup için devre dışı bırakın.

Bu fonksiyon, bir grup adına göre ilerleme çubuklarının durumunu günceller. Grup adı sağlanmazsa, tüm ilerleme çubukları devre dışı bırakılır. İşlem, HF_HUB_DISABLE_PROGRESS_BARS ortam değişkeninin ayarına uyar.

Hem normal bir çağrı hem de bir bağlam yöneticisi olarak çalışır: disable_progress_bars() # enable_progress_bars() çağrılana kadar devre dışı bırakır with disable_progress_bars(): # blok boyunca devre dışı bırakır, çıkışta yeniden etkinleştirir …

İlerleme çubuklarını küresel olarak veya belirli bir grup için etkinleştirin.

Bu fonksiyon, belirtilen grup için veya grup belirtilmemişse küresel olarak ilerleme çubuklarını etkinleştirir. İşlem, HF_HUB_DISABLE_PROGRESS_BARS ortam ayarına tabidir.

huggingface_hub tarafından kullanılacak HTTP istemci fabrikasını ayarlayın.

İstemci fabrikası, httpx2.Client nesnesi döndüren bir yöntemdir. get_session() çağrısının ilk gerçekleşmesinde, istemci fabrikası, huggingface_hub tarafından yapılan tüm çağrılar arasında paylaşılacak yeni bir httpx2.Client nesnesi oluşturmak için kullanılacaktır.

Betiklerinizi özel yapılandırma gerektiren belirli bir ortamda (ör. özel vekil sunucu veya sertifikalar) çalıştırıyorsanız bu işe yarayabilir.

Doğru yapılandırılmış bir httpx2.Client almak için get_session() kullanın.

Kullanıcıdan gelen taşıma fabrikasını kullanarak bir httpx2.Client nesnesi alın.

Bu istemci, huggingface_hub tarafından yapılan tüm çağrılar arasında paylaşılmaktadır. Bu nedenle manuel olarak kapatılmamalıdır.

httpx2.Client'i özelleştirmek için set_client_factory() kullanın.

huggingface_hub tarafından kullanılan küresel httpx2.Client'i kapatın.

Bir Client kapatılırsa, get_session() çağrısının bir sonraki kullanımında yeniden oluşturulur.

Örneğin bir SSL sertifikası güncellendiyse faydalı olabilir.

huggingface_hub tarafından kullanılacak HTTP asenkron istemci fabrikasını ayarlayın.

Asenkron istemci fabrikası, httpx2.AsyncClient nesnesi döndüren bir yöntemdir. Özel yapılandırma gerektiren belirli bir ortamda (ör. özel vekil sunucu veya sertifikalar) betiklerinizi çalıştırıyorsanız bu işe yarayabilir. Doğru yapılandırılmış bir httpx2.AsyncClient almak için get_async_session() kullanın.

huggingface_hub tarafından yapılan tüm çağrılar arasında paylaşılan httpx2.Client'ın aksine, httpx2.AsyncClient paylaşılmaz. Bağlamdan çıkıldığında istemcinin düzgün şekilde kapatılmasını sağlamak için asenkron bir bağlam yöneticisi kullanılması önerilir.

Kullanıcının taşıma fabrikasını kullanarak bir httpx2.AsyncClient nesnesi döndürür.

httpx2.AsyncClient'i özelleştirmek için set_async_client_factory() kullanın.

huggingface_hub tarafından yapılan tüm çağrılar arasında paylaşılan httpx2.Client'ın aksine, httpx2.AsyncClient paylaşılmaz. Bağlamdan çıkıldığında istemcinin düzgün şekilde kapatılmasını sağlamak için asenkron bir bağlam yöneticisi kullanılması önerilir.

response.raise_for_status() işlevinin dahili sürümü; olası bir HTTPError'yi inceler. Atılan istisna, HfHubHTTPError sınıfının bir örneği olacaktır.

Bu yardımcı, Hugging Face Hub'a bir çağrı yapılırken raise_for_status için tek benzersiz yöntem olarak tasarlanmıştır.

İstek başarısız olduğunda yükseltilir:

• RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması, repo_type'in doğru ayarlanmamış olması veya deponun private olması ve erişiminizin olmaması olabilir.
• GatedRepoError Depo mevcut ancak kapalı (gated) ve kullanıcı yetkili listesinde yer almıyorsa.
• RevisionNotFoundError Depo mevcut olsa da revizyon bulunamadığında.
• EntryNotFoundError Depo mevcut olsa da giriş (örneğin istenen dosya) bulunamadığında.
• BadRequestError İstek, HTTP 400 BadRequest hatasıyla başarısız olduysa.
• HfHubHTTPError Yukarıda listelenmeyen bir nedenle istek başarısız olduysa.

Hub için çevrimdışı modda olup olmadığımızı döndürür.

Çevrimdışı mod etkinleştirildiğinde, get_session ile yapılan tüm HTTP istekleri bir OfflineModeIsEnabled istisnası oluşturur.

from huggingface_hub import is_offline_mode

def list_files(repo_id: str):
    if is_offline_mode():
        ... # list files from local cache (degraded experience but still functional)
    else:
        ... # list files from Hub (complete experience)

HF Hub'da özel olarak oluşturulan herhangi bir HTTP Hatası için devralınacak HTTPError.

Herhangi bir HTTPError en azından bir HfHubHTTPError olarak dönüştürülür. Sunucu tarafından bazı bilgiler geri gönderilirse, bu bilgiler hata mesajına eklenir.

Eklenen ayrıntılar:

• Öncelik sırasına göre başlıklardan alınan Request ID: “X-Request-Id”, “X-Amzn-Trace-Id”, “X-Amz-Cf-Id”.
• Başlık “X-Error-Message”’ten gelen sunucu hata mesajı.
• Yanıt gövdesinde bir hata mesajı bulunabilirse sunucu hata mesajı.

    import httpx2
    from huggingface_hub.utils import get_session, hf_raise_for_status, HfHubHTTPError

    response = get_session().post(...)
    try:
        hf_raise_for_status(response)
    except HfHubHTTPError as e:
        print(str(e)) # formatted message
        e.request_id, e.server_message # details returned by server

        # Complete the error message with additional information once it's raised
        e.append_to_message("
ate_commit` expects the repository to exist.")
        raise

Geçersiz bir depo adıyla veya kullanıcının erişim yetkisi olmayan özel bir depo adıyla bir hf.co URL'sine erişilmeye çalışıldığında tetiklenir.

>>> from huggingface_hub import model_info
>>> model_info("<non_existent_repository>")
(...)
huggingface_hub.errors.RepositoryNotFoundError: 401 Client Error. (Request ID: PvMw_VjBMjVdMz53WKIzP)

Repository Not Found for url: https://huggingface.co/api/models/%3Cnon_existent_repository%3E.
Please make sure you specified the correct `repo_id` and `repo_type`.
If the repo is private, make sure you are authenticated and your token has the required permissions.
Invalid username or password.

Kullanıcının yetkili listesinde bulunmadığı bir gated repository'ye erişilmeye çalışıldığında yükseltilir.

Not: Geriye dönük uyumluluğu sağlamak için RepositoryNotFoundError'dan türetilir.

>>> from huggingface_hub import model_info
>>> model_info("<gated_repository>")
(...)
huggingface_hub.errors.GatedRepoError: 403 Client Error. (Request ID: ViT1Bf7O_026LGSQuVqfa)

Cannot access gated repo for url https://huggingface.co/api/models/ardent-figment/gated-model.
Access to model ardent-figment/gated-model is restricted and you are not in the authorized list.
Visit https://huggingface.co/ardent-figment/gated-model to ask for access.

Geçerli bir depoya sahip ancak geçersiz bir revizyon içeren bir hf.co URL'sine erişilmeye çalışıldığında yükseltilir.

>>> from huggingface_hub import hf_hub_download
>>> hf_hub_download('bert-base-cased', 'config.json', revision='<non-existent-revision>')
(...)
huggingface_hub.errors.RevisionNotFoundError: 404 Client Error. (Request ID: Mwhe_c3Kt650GcdKEFomX)

Revision Not Found for url: https://huggingface.co/bert-base-cased/resolve/%3Cnon-existent-revision%3E/config.json.

Bir revizyonun commit hash'ine çözümlenememesi durumunda HfApi.resolve_revision() tarafından yükseltilir: Hub'a ulaşılamadı (çevrimdışı mod, bağlantı hatası, zaman aşımı, Hub kesintisi, …) ve yerel önbellekte eşleşen bir kayıt bulunamadı.

Sunucu bir HTTP 400 hatası döndürdüğünde hf_raise_for_status tarafından oluşturulur.

>>> resp = httpx2.post("hf.co/api/check", ...)
>>> hf_raise_for_status(resp, endpoint_name="check")
huggingface_hub.errors.BadRequestError: Bad request for check endpoint: {details} (Request ID: XXX)

Girdi yerel veya uzaktan bulunamadığında oluşturulur.

>>> from huggingface_hub import hf_hub_download
>>> hf_hub_download('bert-base-cased', '<non-existent-file>')
(...)
huggingface_hub.errors.RemoteEntryNotFoundError (...)
>>> hf_hub_download('bert-base-cased', '<non-existent-file>', local_files_only=True)
(...)
huggingface_hub.utils.errors.LocalEntryNotFoundError (...)

Geçerli bir depo ve revizyona sahip ancak geçersiz bir dosya adıyla bir hf.co URL'sine erişilmeye çalışıldığında yükseltilir.

>>> from huggingface_hub import hf_hub_download
>>> hf_hub_download('bert-base-cased', '<non-existent-file>')
(...)
huggingface_hub.errors.EntryNotFoundError: 404 Client Error. (Request ID: 53pNl6M0MxsnG5Sw8JA6x)

Entry Not Found for url: https://huggingface.co/bert-base-cased/resolve/main/%3Cnon-existent-file%3E.

Ağ devre dışı bırakıldığında veya kullanılamadığında (bağlantı sorunu) diskte bulunmayan bir dosyaya veya anlık görüntüye erişilmeye çalışıldığında yükseltilir. Girdi Hub'da mevcut olabilir.

>>> from huggingface_hub import hf_hub_download
>>> hf_hub_download('bert-base-cased', '<non-cached-file>',  local_files_only=True)
(...)
huggingface_hub.errors.LocalEntryNotFoundError: Cannot find the requested files in the disk cache and outgoing traffic has been disabled. To enable hf.co look-ups and downloads online, set 'local_files_only' to False.

Hub'a ulaşılamadığında (çevrimdışı, bağlantı sorunu veya local_files_only=True) ve önbelleğe alınmış görüntünün eksik olduğu bilindiğinde, snapshot_download() tarafından yükseltilir: depoyun önbelleğe alınmış ağaç listesinde yer alan bazı dosyalar yerel görüntüde bulunmamaktadır.

Bu, geriye dönük uyumluluk için LocalEntryNotFoundError'nin bir alt sınıfıdır.

snapshot_path özniteliği, eksik yerel görüntünün yolunu tutar; böylece bir aşağı akış kütüphanesi, dosyaların eksik olduğu biliniyorsa bile önbellekteki en son dosyaları bulabilir.

İstenen revizyon için önbelleğe alınmış bir ağaç listesi bulunmadığında get_cached_repo_tree() tarafından oluşturulur.

Ağaç listesi, snapshot_download() işlevinin yan etkisi olarak doldurulur.

Bir istek yapıldığında ancak HF_HUB_OFFLINE=1 ortam değişkeni olarak ayarlandığında yükseltilir.

Farklı HF kütüphanelerinin kullanımını izlemeye yardımcı olan telemetri gönderir.

Bu kullanım verileri, sorunları ayıklamamıza ve yeni özellikleri önceliklendirmemize yardımcı olur. Ancak herkesin ek bilgi paylaşmak istemediğini anlıyor ve gizliliğinize saygı duyuyoruz. HF_HUB_DISABLE_TELEMETRY=1 ortam değişkenini ayarlayarak telemetri toplama işlevini devre dışı bırakabilirsiniz. Çevrimdışı modda (yani HF_HUB_OFFLINE=1 ayarlandığında) telemetri de devre dışıdır.

Telemetri toplama işlemi, kullanıcı üzerindeki etkiyi en aza indirmek için ayrı bir iş parçacığında (thread) çalıştırılır.

>>> from huggingface_hub.utils import send_telemetry

# Send telemetry without library information
>>> send_telemetry("ping")

# Send telemetry to subtopic with library information
>>> send_telemetry("gradio/local_link", library_name="gradio", library_version="3.22.1")

# Send telemetry with additional data
>>> send_telemetry(
...     topic="examples",
...     library_name="transformers",
...     library_version="4.26.0",
...     user_agent={"pipeline": "text_classification", "framework": "flax"},
... )

huggingface_hub'ün herhangi bir genel metoduna argüman olarak gelen değerleri doğrular.

Bu dekoratörün amacı, her yerde yeniden kullanılan argümanların doğrulamasını uyumlu hale getirmektir. Varsayılan olarak, tanımlanan tüm doğrulayıcılar test edilir.

Doğrulayıcılar:

• validate_repo_id(): repo_id, "repo_name" veya "namespace/repo_name" olmalıdır. Namespace bir kullanıcı adı veya bir kuruluştur.
• ~utils.smoothly_deprecate_legacy_arguments: Dosya indirirken proxies parametresini yok sayın (küresel olarak ayarlanmalıdır).

>>> from huggingface_hub.utils import validate_hf_hub_args

>>> @validate_hf_hub_args
... def my_cool_method(repo_id: str):
...     print(repo_id)

>>> my_cool_method(repo_id="valid_repo_id")
valid_repo_id

>>> my_cool_method("other..repo..id")
huggingface_hub.utils._validators.HFValidationError: Cannot have -- or .. in repo_id: 'other..repo..id'.

>>> my_cool_method(repo_id="other..repo..id")
huggingface_hub.utils._validators.HFValidationError: Cannot have -- or .. in repo_id: 'other..repo..id'.

huggingface_hub doğrulayıcıları tarafından atılan genel istisna.

ValueError sınıfından devralır.

repo_id'nin geçerli olduğunu doğrulayın.

Bu, Hub üzerinde yapılan uygun doğrulamayı değiştirmek için değil, mümkün olan her durumda yerel tutarsızlıklardan kaçınmak içindir (örnek: repo_id içinde repo_type geçirmek yasaktır).

Kurallar:

• 1 ile 96 karakter arasında.
• “repo_name” veya “namespace/repo_name”
• [a-zA-Z0-9] veya ”-”, ”_”, ”.”
• ”—” ve ”..” yasaktır

Geçerli: "foo", "foo/bar", "123", "Foo-BAR_foo.bar123"

Geçersiz: "datasets/foo/bar", ".repo_id", "foo--bar", "foo.git"

>>> from huggingface_hub.utils import validate_repo_id
>>> validate_repo_id(repo_id="valid_repo_id")
>>> validate_repo_id(repo_id="other..repo..id")
huggingface_hub.utils._validators.HFValidationError: Cannot have -- or .. in repo_id: 'other..repo..id'.

https://github.com/huggingface/huggingface_hub/issues/1008 adresinde tartışıldı. moon-landing (iç depoda):

• https://github.com/huggingface/moon-landing/blob/main/server/lib/Names.ts#L27
• https://github.com/huggingface/moon-landing/blob/main/server/views/components/NewRepoForm/NewRepoForm.svelte#L138

huggingface_hub kod tabanındaki eski argümanları kademeli olarak devre dışı bırakın.

Bu fonksiyon, kwargs içindeki bazı kullanımdan kaldırılmış argümanları yok sayar ve kullanıcının bunların yok sayıldığını bildiren bir uyarı verir. Amaç, mevcut kodu bozmadan kullanıcıyı yeni çalışma yöntemine yönlendirmektir.

Kullanımı durdurulan argümanların listesi:

• proxies: Vekilleri yapılandırmak için kullanıcının ya HTTP_PROXY ortam değişkenini kullanması ya da httpx2.Client nesnesini set_client_factory() işleviyle manuel olarak yapılandırması gerekir.

  huggingface_hub 0.x sürümünde proxies, doğrudan requests.request fonksiyonuna aktarılan bir sözlüktü. huggingface_hub 1.x sürümünden itibaren istek başına proxies desteği kaldırıldı. Özellikle, proxy ayarlarını istek bazında yapılandırmak artık mümkün değildir. Çözüm, set_client_factory() fonksiyonunu veya HTTP_PROXY ortam değişkenini kullanarak yapılandırmayı küresel olarak yapmaktır.

  Daha fazla ayrıntı için bkz:

  • https://httpx2.pydantic.dev/advanced/proxies/

• resume_download: yerine geçecek bir şey olmadan kaldırıldı. huggingface_hub her zaman mümkün olduğunda indirmeleri yeniden başlatır.

• force_filename: yerine geçecek bir şey olmadan kaldırıldı. Dosya adı her zaman Hub'dakiyle aynıdır.

• local_dir_use_symlinks: yerine geçecek bir özellik olmadan kaldırıldı. Yerel bir dizine indirme işlemi artık sembolik bağlantılar kullanmıyor.