Hugging Face's logo

Hub Python Library documentation

HfApi İstemcisi

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

HfApi İstemcisi

Aşağıda, Hugging Face Hub API’sinin bir Python sarmalayıcısı olarak hizmet veren HfApi sınıfının belgeleri yer almaktadır.

HfApi sınıfındaki tüm yöntemler, paketin kökünden de doğrudan erişilebilir. Her iki yaklaşım da aşağıda ayrıntılı olarak açıklanmıştır.

Kök yöntemi kullanmak daha doğrudan bir yol olmakla birlikte HfApi sınıfı size daha fazla esneklik sunar. Özellikle, tüm HTTP çağrılarında yeniden kullanılacak bir token iletebilirsiniz. Bu, tokenın makinede kalıcı olarak saklanmaması nedeniyle hf auth login veya login() komutlarından farklıdır. Ayrıca farklı bir uç nokta (endpoint) belirtmek veya özel bir user-agent yapılandırmak da mümkündür.

from huggingface_hub import HfApi, list_models

# Use root method
models = list_models()

# Or configure a HfApi client
hf_api = HfApi(
    endpoint="https://huggingface.co", # Can be a Private Hub endpoint.
    token="hf_xxx", # Token is not persisted on the machine.
)
models = hf_api.list_models()

HfApi

sınıf huggingface_hub.HfApi

< >

( endpoint: str | None = Nonetoken: str | bool | None = Nonelibrary_name: str | None = Nonelibrary_version: str | None = Noneuser_agent: dict | str | None = Noneheaders: dict[str, str] | None = None )

Parametreler

  • endpoint (str, isteğe bağlı) — Hub uç noktası. Varsayılan olarak https://huggingface.co.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • library_name (str, isteğe bağlı) — HTTP isteğini yapan kütüphanenin adı. Kullanıcı-ajan (user-agent) başlığına eklenecektir. Örnek: "transformers".
  • library_version (str, isteğe bağlı) — HTTP isteğini yapan kütüphanenin sürümü. Kullanıcı-ajan (user-agent) başlığına eklenecektir. Örnek: "4.24.0".
  • user_agent (str, dict, isteğe bağlı) — Sözlük veya tek bir dize biçimindeki kullanıcı ajanı bilgisi. Yüklenmiş paketlere dair bilgilerle tamamlanacaktır.
  • headers (dict, isteğe bağlı) — Her istekle birlikte gönderilecek ek başlıklar. Örnek: {"X-My-Header": "value"}. Buradan geçirilen başlıklar, varsayılan başlıklara göre önceliklidir.

HTTP üzerinden Hugging Face Hub ile etkileşime girmek için istemci.

İstemci, Hub'a (HF uç noktası, kimlik doğrulama, kullanıcı ajanları…) yapılan tüm isteklerde kullanılan bazı yüksek düzey ayarlarla başlatılır. HfApi istemcisinin kullanılması tercih edilir ancak zorunlu değildir; çünkü tüm genel yöntemleri huggingface_hub'ün kökünde doğrudan erişilebilir durumdadır.

accept_access_request

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Erişim isteğinin kabul edileceği repozituarın kimliği.
  • user (str, isteğe bağlı) — Erişim isteğinin kabul edileceği kullanıcının kullanıcı adı. user veya request_id parametrelerinden tam olarak biri sağlanmalıdır.
  • request_id (str, isteğe bağlı) — Kabul edilecek erişim isteğinin kimliği (bkz. AccessRequest). Depo, istek sahiplerinin kullanıcı adlarını paylaşmayacak şekilde yapılandırıldığında zorunludur. user veya request_id parametrelerinden tam olarak biri sağlanmalıdır.
  • repo_type (str, isteğe bağlı) — Erişim isteğinin kabul edileceği repoyu türü. model, dataset veya space değerlerinden biri olmalıdır. Varsayılan değer model'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Depo gated değilse HTTP 400.
  • HfHubHTTPError — Depoya yalnızca salt okunur erişiminiz varsa HTTP 403. Deponun ait olduğu organizasyonda write veya admin rolünüz yoksa ya da read belirteci geçirdiyseniz bu durumla karşılaşabilirsiniz.
  • HfHubHTTPError — Kullanıcı Hub'da yoksa HTTP 404.
  • HfHubHTTPError — Kullanıcı erişim isteği bulunamazsa HTTP 404.
  • HfHubHTTPError — Kullanıcı erişim isteği zaten kabul edilenler listesindeyse HTTP 404.

Belirli bir gated repo için bir kullanıcının erişim isteğini kabul edin.

İstek kabul edildikten sonra, kullanıcı depodaki herhangi bir dosyayı indirebilir ve topluluk sekmesine erişebilir. Onay modu otomatikse, istekleri manuel olarak kabul etmenize gerek yoktur. Kabul edilmiş bir istek, cancel_access_request() ve reject_access_request() kullanılarak herhangi bir zamanda iptal edilebilir veya reddedilebilir.

Kapalı depolar hakkında daha fazla bilgi için https://huggingface.co/docs/hub/models-gated adresine bakın.

add_collection_item

< >

( collection_slug: stritem_id: stritem_type: CollectionItemType_Tnote: str | None = Noneexists_ok: bool = Falsetoken: bool | str | None = None )

Parametreler

  • collection_slug (str) — Güncellenecek koleksiyonun slug'ı. Örnek: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_id (str) — Koleksiyona eklenecek öğenin kimliği. Depolar/uzaylar/veri kümeleri için repo_id, makaleler için makale kimliği, başka bir koleksiyonun slug'ı (ör. "moonshotai/kimi-k2") veya bir varil kimliği (ör. "namespace/bucket-name") kullanın.
  • item_type (str) — Eklenecek öğenin türü. "model", "dataset", "space", "paper", "collection" veya "bucket" değerlerinden biri olabilir.
  • note (str, isteğe bağlı) — Koleksiyondaki öğeye eklenmesi gereken bir not. Bir notun maksimum boyutu 500 karakterdir.
  • exists_ok (bool, isteğe bağlı) — True ise, öğe zaten varsa hata yükseltilmez.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Depoya yalnızca salt okunur erişiminiz varsa HTTP 403. Deponun ait olduğu organizasyonda write veya admin rolünüz yoksa ya da read belirteci geçirdiyseniz bu durumla karşılaşabilirsiniz.
  • HfHubHTTPError — Hub'da eklemeye çalıştığınız öğe yoksa HTTP 404.
  • HfHubHTTPError — Koleksiyona eklemeye çalıştığınız öğe zaten koleksiyonda varsa (ve exists_ok=False ise) HTTP 409

Hub'daki bir koleksiyona öğe ekleyin.

Dönüş: Collection

Örnek:

>>> from huggingface_hub import add_collection_item
>>> collection = add_collection_item(
...     collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",
...     item_id="pierre-loic/climate-news-articles",
...     item_type="dataset"
... )
>>> collection.items[-1].item_id
"pierre-loic/climate-news-articles"
# ^item got added to the collection on last position

# Add item with a note
>>> add_collection_item(
...     collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",
...     item_id="datasets/climate_fever",
...     item_type="dataset",
...     note="This dataset adopts the FEVER methodology that consists of 1,535 real-world claims regarding climate-change collected on the internet."
... )
(...)

add_space_secret

< >

( repo_id: strkey: strvalue: strdescription: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Güncellenecek depoyun kimliği. Örnek: "bigcode/in-the-stack".
  • key (str) — Gizli anahtar. Örnek: "GITHUB_API_KEY"
  • value (str) — Gizli değer. Örnek: "your_github_api_key".
  • description (str, optional) — Secret description. Example: "Github API key to access the Github API".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir Space'te gizli bir değeri ekler veya günceller.

Secrets, bir Space'e gizli anahtarlar veya jetonları bunları kodun içine gömmeden ayarlamayı sağlar. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

add_space_variable

< >

( repo_id: strkey: strvalue: strdescription: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Güncellenecek depoyun kimliği. Örnek: "bigcode/in-the-stack".
  • key (str) — Değişken anahtarı. Örnek: "MODEL_REPO_ID"
  • value (str) — Değişken değeri. Örnek: "the_model_repo_id".
  • description (str) — Değişkenin açıklaması. Örnek: "Model Repo ID of the implemented model".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir Space'te değişken ekler veya günceller.

Değişkenler, bir Space'e ortam değişkenlerini sabit kodlamadan ayarlamayı sağlar. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

auth_check

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = Nonewrite: bool = False )

Parametreler

  • repo_id (str) — Erişimin kontrol edileceği depo. Biçim "user/repo_name" olmalıdır. Örnek: "user/my-cool-model".
  • repo_type (str, isteğe bağlı) — Deponun türü. "model", "dataset" veya "space" değerlerinden biri olmalıdır. Belirtilmezse, varsayılan değer "model"'dir.
  • token (Union[bool, str, None], isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.
  • write (bool, isteğe bağlı) — True ise, kullanıcının depoda içerik yazma iznine sahip olup olmadığını kontrol eder. False ise (varsayılan), yalnızca okuma erişimini kontrol eder.

Yükseltilen

RepositoryNotFoundError veya GatedRepoError

  • RepositoryNotFoundError — Depo mevcut değilse, özel ise veya kullanıcının erişim yetkisi yoksa yükseltilir. repo_id veya repo_type hatalıysa ya da depo özel olup kullanıcı kimlik doğrulaması yapmamışsa bu durumla karşılaşılabilir.

  • GatedRepoError — Depo mevcut ancak kapalı (gated) ve kullanıcının erişim yetkisi yoksa yükseltilir.

Sağlanan kullanıcı belirtecinin Hugging Face Hub'daki belirli bir depoya erişim yetkisi olup olmadığını kontrol edin.

Bu yöntem, sağlanan jetonla kimliği doğrulanmış kullanıcının belirtilen depoya erişim yetkisine sahip olup olmadığını doğrular. Depo bulunamazsa veya kullanıcının erişim için gerekli izinleri yoksa, yöntem uygun bir istisna fırlatır.

Örnek:

Kullanıcının bir depoya erişimi olup olmadığını kontrol edin:

>>> from huggingface_hub import auth_check
>>> from huggingface_hub.utils import GatedRepoError, RepositoryNotFoundError

try:
    auth_check("user/my-cool-model")
except GatedRepoError:
    # Handle gated repository error
    print("You do not have permission to access this gated repository.")
except RepositoryNotFoundError:
    # Handle repository not found error
    print("The repository was not found or you do not have access.")

Bu örnekte:

  • Kullanıcının erişim yetkisi varsa, yöntem başarıyla tamamlanır.
  • Depo kapalıysa veya mevcut değilse, kullanıcının bunları uygun şekilde ele almasına olanak tanıyan uygun istisnalar oluşturulur.

batch_bucket_files

< >

( bucket_id: stradd: list[tuple[str | Path | bytes, str]] | None = Nonecopy: list[tuple[str, str, str, str]] | None = Nonedelete: list[str] | None = Nonetoken: str | bool | None = None )

Parametreler

  • bucket_id (str) — Kovanın kimliği (ör. "username/my-bucket").
  • add (list of tuple, isteğe bağlı) — Yüklenecek dosyalar. Her öğe, source'ün yerel bir dosyanın yolu (str veya Path) veya ham bytes içeriği, destination'ün ise kovadaki yol olduğu bir (source, destination) demetidir.
  • copy (list bir tuple, isteğe bağlı) — xet hash'i ile kopyalanacak dosyalar. Her öğe bir (source_repo_type, source_repo_id, xet_hash, destination) tuple'idir ve şunları içerir:
    • source_repo_type, kaynak depoyun türüdür: "model", "dataset", "space" veya "bucket".
    • source_repo_id, kaynak depo veya varlığın kimliğidir (ör. "username/my-model").
    • xet_hash, kopyalanacak dosyanın xet hash'idir.
    • destination, bucket içindeki hedef yoludur. Bu, sunucu tarafında gerçekleştirilen bir işlemdir — veri indirilmez veya yeniden yüklenmez.
  • delete (list of str, opsiyonel) — Kovadan silinecek dosyaların yolları.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

BucketBatchError

  • BucketBatchError — Sunucu, bazı işlemlerin başarısız olduğunu bildirirse. Hata, her işlem gönderildikten sonra bir kez yükseltilir, bu nedenle toplu işlemin diğer işlemleri uygulanmıştır.

Bir kovadaki dosyaları ekleyin, kopyalayın ve/veya silin.

Bu işlem işlem dışıdır (non-transactional). Süreç sırasında bir hata oluşursa, bazı dosyalar yüklenmiş, kopyalanmış veya silinmiş olabilirken diğerleri bu işlemlerden etkilenmemiş olabilir.

Örnek:

>>> from huggingface_hub import batch_bucket_files

# Upload files
>>> batch_bucket_files(
...     "username/my-bucket",
...     add=[
...         ("./model.safetensors", "models/model.safetensors"),
...         (b'{{"key": "value"}}', "config.json"),
...     ],
... )

# Copy xet files from another bucket or repo (server-side, no data transfer)
>>> batch_bucket_files(
...     "username/my-bucket",
...     copy=[
...         ("bucket", "username/source-bucket", "<xethash_1>", "models/model.safetensors"),
...         ("model", "username/my-model", "<xethash_2>", "models/config.safetensors"),
...     ],
... )

# Delete files
>>> batch_bucket_files("username/my-bucket", delete=["old-model.bin"])

# Upload and delete in one batch
>>> batch_bucket_files(
...     "username/my-bucket",
...     add=[("./new.txt", "new.txt")],
...     delete=["old.txt"],
... )

bucket_info

< >

( bucket_id: strtoken: bool | str | None = None ) → BucketInfo

Parametreler

  • bucket_id (str) — Kovanın kimliği (ör. "username/my-bucket").
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

BucketInfo

Kova bilgisi.

Yükseltilen

BucketNotFoundError veya or

  • BucketNotFoundError — Bucket bulunamadığında. Bunun nedeni, bucket'ın var olmaması olabilir,
  • or — çünkü private olarak ayarlanmış ve erişiminiz yok.

Hub'da belirli bir bucket hakkında bilgi alın.

Örnek:

>>> from huggingface_hub import bucket_info
>>> info = bucket_info(bucket_id="Wauplin/first-bucket")
>>> info.id
'Wauplin/first-bucket'
>>> info.private
False
>>> info.created_at
datetime.datetime(2026, 2, 6, 17, 37, 57, tzinfo=datetime.timezone.utc)
>>> info.size
551879671
>>> info.total_files
12

cancel_access_request

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Erişim isteğinin iptal edileceği depoyun kimliği.
  • user (str, isteğe bağlı) — Erişim isteği iptal edilecek kullanıcının kullanıcı adı. user veya request_id parametrelerinden tam olarak biri sağlanmalıdır.
  • request_id (str, isteğe bağlı) — İptal edilecek erişim isteğinin kimliği (bkz. AccessRequest). Depo, istek sahiplerinin kullanıcı adlarını paylaşmayacak şekilde yapılandırıldığında zorunludur. user veya request_id parametrelerinden tam olarak biri sağlanmalıdır.
  • repo_type (str, isteğe bağlı) — Erişim isteğinin iptal edileceği repoyu türü. model, dataset veya space değerlerinden biri olmalıdır. Varsayılan değer model'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Depo gated değilse HTTP 400.
  • HfHubHTTPError — Depoya yalnızca salt okunur erişiminiz varsa HTTP 403. Deponun ait olduğu organizasyonda write veya admin rolünüz yoksa ya da read belirteci geçirdiyseniz bu durumla karşılaşabilirsiniz.
  • HfHubHTTPError — Kullanıcı Hub'da yoksa HTTP 404.
  • HfHubHTTPError — Kullanıcı erişim isteği bulunamazsa HTTP 404.
  • HfHubHTTPError — Kullanıcı erişim isteği zaten bekleyenler listesindeyse HTTP 404.

Belirli bir gated repo için bir kullanıcının erişim isteğini iptal edin.

İptal edilen bir istek bekleyenler listesine geri döner ve kullanıcı repoya erişimini kaybeder.

Kapalı depolar hakkında daha fazla bilgi için https://huggingface.co/docs/hub/models-gated adresine bakın.

cancel_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • job_id (str) — Job'un kimliği.
  • namespace (str, isteğe bağlı) — Job'un çalıştığı namespace. Varsayılan olarak kullanıcının mevcut namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında bir hesaplama İşini iptal edin.

change_discussion_status

< >

( repo_id: strdiscussion_num: intnew_status: Literal['open', 'closed']token: bool | str | None = Nonecomment: str | None = Nonerepo_type: str | None = None ) → DiscussionStatusChange

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • discussion_num (int) — Discussion veya Pull Request numarası. Kesinlikle pozitif bir tam sayı olmalıdır.
  • new_status (str) — Tartışma için yeni durum, "open" veya "closed".
  • comment (str, isteğe bağlı) — Durum değişikliğiyle birlikte gönderilecek isteğe bağlı bir yorum.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

DiscussionStatusChange

durum değişikliği olayı

Bir Tartışma veya Pull Request'i kapatır veya yeniden açar.

Örnekler:

>>> HfApi().change_discussion_status(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     new_status="closed"
... )
# DiscussionStatusChange(id='deadbeef0000000', type='status-change', ...)

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

yorum_tartışması

< >

( repo_id: strdiscussion_num: intcomment: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • discussion_num (int) — Discussion veya Pull Request numarası. Kesinlikle pozitif bir tam sayı olmalıdır.
  • comment (str) — Oluşturulacak yorumun içeriği. Yorumlar markdown biçimlendirmesini destekler.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

TartışmaYorumu

yeni oluşturulan yorum

Belirtilen Tartışma üzerinde yeni bir yorum oluşturur.

Örnekler:


>>> comment = """
... Hello @otheruser!
...
... # This is a title
...
... **This is bold**, *this is italic* and ~this is strikethrough~
... And [this](http://url) is a link
... """

>>> HfApi().comment_discussion(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     comment=comment
... )
# DiscussionComment(id='deadbeef0000000', type='comment', ...)

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

copy_files

< >

( source: strdestination: strtoken: str | bool | None = None )

Parametreler

  • source (str) — hf:// URI olarak kaynak konumu. Bir varol yolu (ör. "hf://buckets/my-bucket/path/to/file") veya bir depo yolu (ör. "hf://username/my-model/weights.bin", "hf://datasets/username/my-dataset/data/") olabilir.
  • destination (str) — Bir kovaya (ör. "hf://buckets/my-bucket/target/path") veya bir repoya (ör. "hf://username/my-model/target/path") işaret eden hf:// URI'si olarak hedef konum.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

ValueError

  • ValueError — Kaynak/hedef URI'leri geçersizse veya bir bucket'tan bir repo'ya kopyalama yapılıyorsa.

Hub üzerindeki konumlar arasında dosyaları kopyalayın.

Bir bucket'tan veya bir repodan (model, veri seti, space) bir bucket'a veya başka bir repoya dosya kopyalayın. Hem bireysel dosyalar hem de tüm klasörler desteklenir.

Klasörleri kopyalarken, kaynak yolunun sonundaki / rsync tarzı bir semantiği kullanır: kaynak klasörün kendisini iç içe geçirmeden, içeriğini hedefe kopyalar. Sonda / yoksa, kaynak klasör hedefin içine iç içe yerleştirilir (tıpkı cp -r gibi).

Bir depodan bir kovaya kopyalama sırasında, .gitattributes dosyaları git'e özgü meta veriler olduğu ve kovak bağlamında ilgili olmadığı için otomatik olarak hariç tutulur.

Depodan depoya kopyalamalar, arka planda CommitOperationCopy kullanır ve hedef depoda bir commit oluşturur. Kova-dan depoya kopyalamalar desteklenmez.

Sunucu tarafı kopyalar yalnızca aynı depolama bölgesi içinde çalışır.

Örnek:

>>> from huggingface_hub import copy_files

# Copy a single file between buckets
>>> copy_files("hf://buckets/my-bucket/data.bin", "hf://buckets/other-bucket/data.bin")

# Copy a folder into another bucket (nests: backup/models/...)
>>> copy_files("hf://buckets/my-bucket/models", "hf://buckets/other-bucket/backup/")

# Copy folder contents (trailing /): files go directly into backup/
>>> copy_files("hf://buckets/my-bucket/models/", "hf://buckets/other-bucket/backup/")

# Copy a file from a model repo to a bucket
>>> copy_files("hf://username/my-model/model.safetensors", "hf://buckets/my-bucket/")

# Copy an entire dataset to a bucket
>>> copy_files("hf://datasets/username/my-dataset/", "hf://buckets/my-bucket/datasets/")

# Copy files between repositories
>>> copy_files("hf://username/source-model/", "hf://username/dest-model/")

# Copy a file from one repo to another
>>> copy_files("hf://username/source-model/config.json", "hf://username/dest-model/config.json")

create_branch

< >

( repo_id: strbranch: strrevision: str | None = Nonetoken: bool | str | None = Nonerepo_type: str | None = Noneexist_ok: bool = False )

Parametreler

  • repo_id (str) — Dalın oluşturulacağı depo. Örnek: "user/my-cool-model".
  • branch (str) — Oluşturulacak dalın adı.
  • revision (str, isteğe bağlı) — Dalanın oluşturulacağı git revizyonu. Bir dal adı veya bir commit'in OID/SHA'sı olarak onaltılık bir dize olabilir. Varsayılan olarak "main" dalının başıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri seti veya space üzerinde dal oluşturuyorsanız "dataset" veya "space", bir modele etiket atıyorsanız None veya "model" olarak ayarlayın. Varsayılan değer None'dir.
  • exist_ok (bool, isteğe bağlı, varsayılan False) — True ise, dal zaten varsa hata yükseltilmez.

Yükseltilen

RepositoryNotFoundError veya BadRequestError veya HfHubHTTPError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.
  • BadRequestError — Geçersiz bir branch referansı verilirse. Ör: refs/pr/5 veya ‘refs/foo/bar’.
  • HfHubHTTPError — Dal, depoda zaten varsa (hata 409) ve exist_ok False olarak ayarlanmışsa.

Hub'daki bir depo için, belirtilen revizyondan (varsayılan olarak main) başlayarak yeni bir dal oluşturun. İhtiyacınıza uygun bir revizyon bulmak için list_repo_refs() veya list_repo_commits() kullanabilirsiniz.

create_bucket

< >

( bucket_id: strprivate: bool | None = Nonevisibility: Literal['public', 'private'] | None = Noneresource_group_id: str | None = Noneregion: REPO_REGIONS | None = Noneexist_ok: bool = Falsetoken: bool | str | None = None ) → BucketUrl

Parametreler

  • bucket_id (str) — Bir ad alanı (kullanıcı veya bir kuruluş) ve / ile ayrılmış bir varlık adı. Ad alanı belirtilmezse, varlık mevcut kullanıcının ad alanında oluşturulur.
  • private (bool, isteğe bağlı) — Kovanın özel yapılıp yapılmayacağını belirtir. None (varsayılan) ise, organizasyonun varsayılanı özel olmadıkça kovan herkese açık olur. visibility parametresiyle birlikte geçirilemez.
  • visibility (Literal["public", "private"], isteğe bağlı) — Kovanın görünürlüğü. "public" veya "private" olabilir. None (varsayılan) ise, kuruluşun varsayılanı private olmadıkça kovan public olur.
  • resource_group_id (str, isteğe bağlı) — Kovanın oluşturulacağı kaynak grubu. Kaynak grupları yalnızca Enterprise Hub organizasyonları için kullanılabilir ve organizasyonun hangi üyelerinin kaynağa erişebileceğini tanımlamaya olanak tanır. Bir kaynak grubunun kimliği, Hub'daki kaynağın sayfasındaki URL'de bulunabilir (ör. "66670e5163145ca562cb1988"). Kaynak grupları hakkında daha fazla bilgi için bkz. https://huggingface.co/docs/hub/en/security-resource-groups.
  • region (Literal["us", "eu"], isteğe bağlı) — Kovanın oluşturulacağı bulut bölgesi. "us" veya "eu" değerlerinden biri olabilir. Belirtilmezse, kovan varsayılan bölgede oluşturulur. Team planı veya üstü gerektirir.
  • exist_ok (bool, isteğe bağlı, varsayılan False) — True ise, varlık (bucket) zaten mevcutse hata yükseltilmez.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

BucketUrl

endpoint, namespace ve bucket_id gibi öznitelikleri içeren, yeni oluşturulan bucket'ın URL'si.

Hub'da bir varlık oluşturun.

Örnek:

>>> from huggingface_hub import create_bucket

>>> url = create_bucket(bucket_id="my-bucket")
>>> url.bucket_id
'user/my-bucket'
>>> url.url
'https://huggingface.co/buckets/user/my-bucket'
>>> url.uri.to_uri()
'hf://buckets/user/my-bucket'

>>> create_bucket(bucket_id="my-bucket", private=True, exist_ok=True)
BucketUrl(...)

>>> create_bucket(bucket_id="my-bucket", region="us")
BucketUrl(...)

create_collection

< >

( title: strnamespace: str | None = Nonedescription: str | None = Noneprivate: bool = Falseresource_group_id: str | None = Noneexists_ok: bool = Falsetoken: bool | str | None = None )

Parametreler

  • title (str) — Oluşturulacak koleksiyonun başlığı. Örnek: "Recent models".
  • namespace (str, isteğe bağlı) — Oluşturulacak koleksiyonun ad alanı (kullanıcı adı veya kuruluş). Varsayılan olarak sahip adı kullanılır.
  • description (str, isteğe bağlı) — Oluşturulacak koleksiyonun açıklaması. Bir açıklamanın maksimum boyutu 150 karakterdir.
  • private (bool, isteğe bağlı) — Koleksiyonun özel olup olmayacağı. Varsayılan olarak False (yani herkese açık koleksiyon).
  • resource_group_id (str, isteğe bağlı) — Koleksiyonu, sahip olan organizasyonun bir kaynak grubuna atayın. Yalnızca organizasyona ait koleksiyonlar için geçerlidir. Kaynak grubu kimliği, 24 karakterli onaltılık bir dizidir.
  • exists_ok (bool, isteğe bağlı) — True ise, koleksiyon zaten varsa hata fırlatmaz.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Hub'da yeni bir Collection oluşturun.

Dönüş: Collection

Örnek:

>>> from huggingface_hub import create_collection
>>> collection = create_collection(
...     title="ICCV 2023",
...     description="Portfolio of models, papers and demos I presented at ICCV 2023",
... )
>>> collection.slug
"username/iccv-2023-64f9a55bb3115b4f513ec026"

create_commit

< >

( repo_id: stroperations: Iterable[CommitOperation]commit_message: strcommit_description: str | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Nonenum_threads: int = 5parent_commit: str | None = Nonerun_as_future: bool = False_hot_reload: bool | None = None ) → CommitInfo or Future

Parametreler

  • repo_id (str) — Commit'in oluşturulacağı depo, örneğin: "username/custom_transformers"
  • operations (Iterable içeren ~hf_api.CommitOperation) — commit'e dahil edilecek işlemlerin bir iterable'ı, şunlardan biri:
    • Bir dosya yüklemek için ~hf_api.CommitOperationAdd
    • Bir dosyayı silmek için ~hf_api.CommitOperationDelete
    • Bir dosyayı kopyalamak için ~hf_api.CommitOperationCopy

    Operation nesneleri, yüklemeyle ilgili bilgileri içerecek şekilde değiştirilecektir. Aynı nesneleri birden fazla commit için yeniden kullanmayın.

  • commit_message (str) — Oluşturulacak commit'in özeti (ilk satırı).
  • commit_description (str, isteğe bağlı) — Oluşturulacak commit'in açıklaması
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri seti, alan veya çekirdek deposuna yükleniyorsa "dataset", "space" veya "kernel" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan None'dir.
  • revision (str, isteğe bağlı) — Taahhüt edilecek git revizyonu. Varsayılan olarak "main" dalının başıdır.
  • create_pr (boolean, isteğe bağlı) — Bu commit ile bir Pull Request oluşturulup oluşturulmayacağı. Varsayılan olarak False. revision ayarlanmadıysa, PR "main" dalına karşı açılır. revision ayarlandıysa ve bir dal ise, PR bu dala karşı açılır. revision ayarlandıysa ve bir dal adı değilse (örneğin: bir commit oid), sunucu tarafından RevisionNotFoundError döndürülür.
  • num_threads (int, isteğe bağlı) — Dosyaları yüklemek için eşzamanlı iş parçacığı sayısı. Varsayılan değer 5'tir. 2 olarak ayarlanması, en fazla 2 dosyanın eşzamanlı yükleneceği anlamına gelir.
  • parent_commit (str, isteğe bağlı) — Ebeveyn commit'in OID / SHA'sı, onaltılık bir dize olarak. Kısaltmalar (ilk 7 karakter) de desteklenir. Belirtilirse ve create_pr False ise, revision parent_commit'e işaret etmiyorsa commit başarısız olur. Belirtilirse ve create_pr True ise, pull request parent_commit'den oluşturulur. parent_commit'in belirtilmesi, değişiklikler commit edilmeden önce repoyun değişmediğinden emin olunmasını sağlar ve repoyun eşzamanlı olarak güncellenmesi / commit edilmesi durumunda özellikle faydalı olabilir.
  • run_as_future (bool, isteğe bağlı) — Bu yöntemin arka planda çalıştırılıp çalıştırılmayacağı. Arka plan işleri, ana iş parçacığını bloklamadan sıralı olarak çalıştırılır. run_as_future=True geçirilirse bir Future nesnesi döndürülür. Varsayılan değer False'tir.

Dönüş değeri

CommitInfo veya Future

Yeni oluşturulan commit hakkında bilgi içeren CommitInfo örneği (commit hash, commit url, pr url, commit message,…). run_as_future=True geçirilirse, çalıştırıldığında sonucu içerecek bir Future nesnesi döndürülür.

Yükseltilen

ValueError veya RepositoryNotFoundError

  • ValueError — Commit mesajı boşsa.
  • ValueError — Ebeveyn commit geçerli bir commit OID'si değilse.
  • ValueError — Geçersiz bir metadata bölümüne sahip bir README.md dosyası commit edilirse. Bu durumda, herhangi bir dosya yüklenmeye çalışılmadan önce commit erken aşamada başarısız olur.
  • ValueError — create_pr True ise ve revision ne None ne de "main" ise.
  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.

Verilen depoda bir commit oluşturur; gerektiği gibi dosyaları siler ve yükler.

CommitOperation giriş listesi, commit işlemi sırasında değiştirilecektir. Aynı nesneleri birden fazla commit için yeniden kullanmayın.

create_commit, Hub'da zaten var olan bir repoyu varsayar. 404 istemci hatası alırsanız, kimlik doğrulamanızın yapıldığından, token'ınızın gerekli izinlere sahip olduğundan ve repo_id ile repo_type değerlerinin doğru ayarlandığından emin olun. Repo yoksa, önce create_repo() kullanarak oluşturun.

create_commit, 25 bin LFS dosyası ve normal dosyalar için 1 GB yük ile sınırlıdır.

create_discussion

< >

( repo_id: strtitle: strtoken: bool | str | None = Nonedescription: str | None = Nonerepo_type: str | None = Nonepull_request: bool = False )

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • title (str) — Tartışmanın başlığı. En fazla 200 karakter uzunluğunda olabilir ve en az 3 karakter uzunluğunda olmalıdır. Baştaki ve sonda boşluklar kaldırılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • description (str, isteğe bağlı) — Pull Request için isteğe bağlı bir açıklama. Varsayılan değer "Discussion opened with the huggingface_hub Python library"
  • pull_request (bool, isteğe bağlı) — Bir Pull Request veya tartışma oluşturulup oluşturulmayacağını belirtir. True ise bir Pull Request oluşturur. False ise bir tartışma oluşturur. Varsayılan değer False'tir.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.

Bir Tartışma veya Pull Request oluşturur.

Programatik olarak oluşturulan Pull Request'ler "draft" durumunda olacaktır.

Değişikliklerle bir Pull Request oluşturmak, HfApi.create_commit() ile tek seferde yapılabilir.

Dönüş: DiscussionWithDetails

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

create_inference_endpoint

< >

( name: strrepository: strframework: straccelerator: strinstance_size: strinstance_type: strregion: strvendor: straccount_id: str | None = Noneprivate_link_account_id: str | None = Noneprivate_link_region: str | None = Nonemin_replica: int = 1max_replica: int = 1scaling_metric: InferenceEndpointScalingMetric | None = Nonescaling_threshold: float | None = Nonescale_to_zero_timeout: int | None = Nonerevision: str | None = Nonetask: str | None = Nonecustom_image: dict | None = Nonecontainer_registry_username: str | None = Nonecontainer_registry_password: str | None = Nonecontainer_command: list[str] | None = Nonecontainer_args: list[str] | None = Noneenv: dict[str, str] | None = Nonesecrets: dict[str, str] | None = Nonetype: InferenceEndpointType | str = <InferenceEndpointType.AUTHENTICATED: 'authenticated'>domain: str | None = Nonepath: str | None = Nonecache_http_responses: bool | None = Nonetags: list[str] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parametreler

  • name (str) — Yeni Inference Endpoint için benzersiz ad.
  • repository (str) — Inference Endpoint ile ilişkili model deposunun adı (ör. "gpt2").
  • framework (str) — Model için kullanılan makine öğrenimi çerçevesi (ör. "custom").
  • accelerator (str) — Çıkarım için kullanılacak donanım hızlandırıcısı (ör. "cpu").
  • instance_size (str) — Modelin barındırılmasında kullanılacak örneğin boyutu veya türü (ör. "x4").
  • instance_type (str) — Inference Endpoint'in dağıtılacağı bulut örnek türü (ör. "intel-icl").
  • region (str) — Inference Endpoint'in oluşturulacağı bulut bölgesi (ör. "us-east-1").
  • vendor (str) — Inference Endpoint'in barındırılacağı bulut sağlayıcısı veya tedarikçi (ör. "aws").
  • account_id (str, isteğe bağlı) — Kullanımdan kaldırıldı ve yok sayılır. AWS PrivateLink'i yapılandırmak için private_link_account_id ve private_link_region kullanın.
  • private_link_account_id (str, isteğe bağlı) — AWS PrivateLink üzerinden Inference Endpoint'e erişmesine izin verilen AWS hesap kimliği. private_link_region gerektirir.
  • private_link_region (str, isteğe bağlı) — PrivateLink giriş noktasının AWS bölgesi ("us-east-1" veya "eu-west-1"), private_link_account_id VPC uç noktasının bağlanacağı bölge. Hesaplama region ve vendor değerlerinden bağımsızdır.
  • min_replica (int, isteğe bağlı) — Inference Endpoint için çalışmaya devam ettirilecek en az replika (örnek) sayısı. Sıfıra ölçeklemeyi etkinleştirmek için bu değeri 0 olarak ayarlayın ve scale_to_zero_timeout değerini buna göre düzenleyin. Varsayılan değer 1'dir.
  • max_replica (int, isteğe bağlı) — Inference Endpoint için ölçeklenecek maksimum replika (örnek) sayısı. Varsayılan değer 1'dir.
  • scaling_metric (str veya InferenceEndpointScalingMetric , isteğe bağlı) — Ölçeklendirme için metrik referansı. Verildiğinde “pendingRequests” veya “hardwareUsage” olmalıdır. Varsayılan değeri None'dir (anlamı: metrik, HF Endpoints servisi tarafından belirlensin).
  • scaling_threshold (float, isteğe bağlı) — Yukarı ölçeklemeyi tetiklemek için kullanılan ölçekleme metriği eşiği. Ölçekleme metriği sağlanmadığında yok sayılır. Varsayılan değeri None'dır (anlamı: eşiği HF Endpoints servisinin belirlemesine izin ver).
  • scale_to_zero_timeout (int, isteğe bağlı) — Pasif bir uç noktanın sıfıra ölçeklenmeden önceki dakika cinsinden süresi; None olarak ayarlanırsa ve min_replica 0 değilse sıfıra ölçekleme yapılmaz. Varsayılan değeri None'dır.
  • revision (str, isteğe bağlı) — Inference Endpoint üzerinde dağıtılacak belirli model revizyonu (ör. "6c0e6080953db56375760c0471a8c5f2929baf11").
  • task (str, isteğe bağlı) — Modelin dağıtılacağı görev (ör. "text-classification").
  • custom_image (dict, isteğe bağlı) — Çalıştırılacak konteyner görüntüsü. Anahtarları görüntü varyantı olan bir sözlük (ör. {"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}‌}, ayrıca sGLang, tgi, tei, llamacpp, hfServe, …) olarak, olduğu gibi iletilebilir veya özel bir konteyneri tanımlayan düz bir sözlük (ör. {"url": ..., "port": ...}) olarak, {"custom": ...} olarak gönderilir (örnekleri bkz.). Varsayılan olarak Hugging Face tarafından yönetilen görüntü kullanılır.
  • container_registry_username (str, isteğe bağlı) — Özel bir konteyner görüntüsünü barındıran kayıt defteriyle kimlik doğrulama için kullanılan kullanıcı adı.
  • container_registry_password (str, isteğe bağlı) — Özel bir konteyner görüntüsünü barındıran kayıt defteriyle kimlik doğrulama için kullanılan şifre. container_registry_username parametresini gerektirir. Sağlanmadığında API yükünden (payload) çıkarılır.
  • container_command (list[str], isteğe bağlı) — Kapsayıcı giriş noktası komutunu geçersiz kılar (API yükünde model.command alanına eşlenir). Hem yönetilen motor görüntüleriyle (ör. vLLM, SGLang) hem de özel görüntülerle çalışır.
  • container_args (list[str], isteğe bağlı) — Kapsayıcı giriş noktasına eklenen argümanlar (API yüklemesinde model.args alanına eşlenir). Hem yönetilen motor görüntüleriyle (ör. vLLM, SGLang) hem de özel görüntülerle çalışır.
  • env (dict[str, str], isteğe bağlı) — Kapsayıcı ortamına enjekte edilecek gizli olmayan ortam değişkenleri.
  • secrets (dict[str, str], isteğe bağlı) — Kapsayıcı ortamına enjekte edilecek gizli değerler.
  • type ([`InferenceEndpointType], *optional*) -- The type of the Inference Endpoint, which can be “authenticated”(default),“public”or“private”`.
  • domain (str, isteğe bağlı) — Inference Endpoint dağıtımı için özel alan adı; yapılandırılırsa inference endpoint bu alan adında kullanılabilir hale gelir (ör. "my-new-domain.cool-website.woof").
  • path (str, isteğe bağlı) — Dağıtılan modele özel yol, / ile başlamalıdır (ör. "/models/google-bert/bert-base-uncased").
  • cache_http_responses (bool, isteğe bağlı) — Inference Endpoint'ten gelen HTTP yanıtlarının önbelleğe alınıp alınmayacağını belirtir. Varsayılan olarak False'tur.
  • tags (list[str], isteğe bağlı) — Inference Endpoint ile ilişkilendirilecek etiketlerin listesi.
  • namespace (str, isteğe bağlı) — Inference Endpoint'in oluşturulacağı namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

InferenceEndpoint

güncellenmiş Inference Endpoint hakkında bilgi.

Yeni bir Inference Endpoint oluşturun.

accelerator, instance_size, instance_type, region ve vendor değerleri birbirine bağlıdır; geçerli kombinasyonları listelemek için list_inference_endpoints_hardware() kullanın.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "my-endpoint-name",
...     repository="gpt2",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="cpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x2",
...     instance_type="intel-icl",
... )
>>> endpoint
InferenceEndpoint(name='my-endpoint-name', status="pending",...)

# Run inference on the endpoint
>>> endpoint.client.text_generation(...)
"..."
# Start an Inference Endpoint running Zephyr-7b-beta on TGI
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "aws-zephyr-7b-beta-0486",
...     repository="HuggingFaceH4/zephyr-7b-beta",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="gpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x1",
...     instance_type="nvidia-a10g",
...     env={
...           "MAX_BATCH_PREFILL_TOKENS": "2048",
...           "MAX_INPUT_LENGTH": "1024",
...           "MAX_TOTAL_TOKENS": "1512",
...           "MODEL_ID": "/repository"
...         },
...     custom_image={
...         "healthRoute": "/health",
...         "url": "ghcr.io/huggingface/text-generation-inference:1.1.0",
...     },
...    secrets={"MY_SECRET_KEY": "secret_value"},
...    tags=["dev", "text-generation"],
... )
# Start an Inference Endpoint running ProsusAI/finbert while scaling to zero in 15 minutes
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "finbert-classifier",
...     repository="ProsusAI/finbert",
...     framework="pytorch",
...     task="text-classification",
...     min_replica=0,
...     scale_to_zero_timeout=15,
...     accelerator="cpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x2",
...     instance_type="intel-icl",
... )
>>> endpoint.wait(timeout=300)
# Run inference on the endpoint
>>> endpoint.client.text_generation(...)
TextClassificationOutputElement(label='positive', score=0.8983615040779114)

create_inference_endpoint_from_catalog

< >

( repo_id: str | None = Nonerecipe_id: str | None = Nonename: str | None = Noneaccelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = Nonegguf_file: str | None = Nonetoken: bool | str | None = Nonenamespace: str | None = None ) → InferenceEndpoint

Parametreler

  • repo_id (str, isteğe bağlı) — Bir Inference Endpoint olarak dağıtılacak katalogdaki modelin kimliği. recipe_id ile birlikte kullanılamaz.
  • recipe_id (str, isteğe bağlı) — Dağıtılacak katalog tarifinin kimliği (bkz. InferenceCatalogRecipe). repo_id ile birlikte kullanılamaz.
  • name (str, isteğe bağlı) — Yeni Inference Endpoint için benzersiz ad. Sağlanmazsa rastgele bir ad oluşturulur.
  • accelerator (str, isteğe bağlı) — Çıkarım için kullanılacak donanım hızlandırıcısı. Olası değerler arasında "cpu", "gpu" ve "neuron" bulunur. Belirtilmezse, sunucu model için uygun bir varsayılanı kullanır. Yalnızca repo_id ile geçerlidir.
  • gguf_file (str, isteğe bağlı) — Her kuantizasyon için bir tarife içeren modellerde dağıtılacak GGUF dosyası (ör. "Qwen2.5-Coder-32B-Instruct-Q4_K_M.gguf"). Yalnızca repo_id ile geçerlidir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication).
  • namespace (str, isteğe bağlı) — Inference Endpoint'in oluşturulacağı namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.

Dönüş değeri

InferenceEndpoint

yeni Inference Endpoint hakkında bilgi.

Hugging Face Inference Catalog'dan yeni bir Inference Endpoint oluşturun.

Inference Catalog'un amacı, çıkarım için optimize edilmiş ve varsayılan yapılandırmaları test edilmiş modellerin küratörlü bir listesini sağlamaktır. Katalogdaki mevcut modellerin listesini https://huggingface.co/static-proxy/endpoints.huggingface.co/catalog adresinde bulabilirsiniz.

Her katalog modeli, bunun için test edilmiş bir donanım ve motor kombinasyonu olan bir tarife üzerinden dağıtılır. Bir modelin varsayılan tarifesini dağıtmak için repo_id parametresini, isteğe bağlı olarak accelerator ve gguf_file ile daraltılmış olarak, veya list_inference_catalog() tarafından listelenen tam bir tarifeyi dağıtmak için recipe_id parametresini iletin.

create_inference_endpoint_from_catalog deneyseldir. API'si gelecekte değişiklik gösterebilir. Öneri veya talepleriniz varsa lütfen geri bildirimde bulunun.

create_pull_request

< >

( repo_id: strtitle: strtoken: bool | str | None = Nonedescription: str | None = Nonerepo_type: str | None = None )

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • title (str) — Tartışmanın başlığı. En fazla 200 karakter uzunluğunda olabilir ve en az 3 karakter uzunluğunda olmalıdır. Baştaki ve sonda boşluklar kaldırılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • description (str, isteğe bağlı) — Pull Request için isteğe bağlı bir açıklama. Varsayılan değer "Discussion opened with the huggingface_hub Python library"
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.

Bir Pull Request oluşturur. Programatik olarak oluşturulan Pull Request'ler "draft" durumundadır.

Değişikliklerle bir Pull Request oluşturmak, HfApi.create_commit() ile tek seferde de yapılabilir;

Bu, HfApi.create_discussion() etrafında bir sarmalayıcıdır.

Dönüş: DiscussionWithDetails

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

create_repo

< >

( repo_id: strtoken: str | bool | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonerepo_type: str | None = Noneexist_ok: bool = Falseresource_group_id: str | None = Noneregion: REPO_REGIONS | None = Nonespace_sdk: str | None = Nonespace_hardware: SpaceHardware | None = Nonespace_sleep_time: int | None = Nonespace_secrets: list[dict[str, str]] | None = Nonespace_variables: list[dict[str, str]] | None = Nonespace_volumes: list[Volume] | None = Nonespace_template: str | None = None ) → RepoUrl

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • private (bool, isteğe bağlı) — Depoyu özel yapılıp yapılmayacağı. None (varsayılan) ise, organizasyonun varsayılanı özel değilse depo herkese açık olur. Depo zaten mevcutsa bu değer yok sayılır. visibility ile birlikte geçirilemez.
  • visibility (Literal["public", "private", "protected"], isteğe bağlı) — Deponun görünürlüğü. "public" veya "private" olabilir, Spaces için "protected" olabilir. None (varsayılan) ise, organizasyonun varsayılanı özel olmadıkça depo herkese açık olur. Depo zaten mevcut ise bu değer yok sayılır.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • exist_ok (bool, isteğe bağlı, varsayılan False) — True ise, depo zaten varsa hata yükseltilmez.
  • resource_group_id (str, isteğe bağlı) — Deponun oluşturulacağı kaynak grubu. Kaynak grupları yalnızca Enterprise Hub kuruluşları için kullanılabilir ve kuruluşun hangi üyelerinin kaynağa erişebileceğini tanımlamaya olanak tanır. Bir kaynak grubunun kimliği, Hub'daki kaynağın sayfasındaki URL'de bulunabilir (ör. "66670e5163145ca562cb1988"). Kaynak grupları hakkında daha fazla bilgi için https://huggingface.co/docs/hub/en/security-resource-groups adresine bakın.
  • region (Literal["us", "eu"], isteğe bağlı) — Deponun oluşturulacağı bulut bölgesi. "us" veya "eu" değerlerinden biri olabilir. Belirtilmezse depo, varsayılan bölgede oluşturulur. Team planı veya üstü bir plan gerektirir.
  • space_sdk (str, isteğe bağlı) — repo_type “space” ise kullanılacak SDK seçimi. “streamlit”, “gradio”, “docker” veya “static” olabilir. "static" Spaces herkes için ücretsizdir. Diğer SDK'lar hesaplama üzerinde çalışır: ücretsiz cpu-basic donanımında abonelik gerektirirler (kullanıcılar için PRO, kuruluşlar için Team veya Enterprise), ücretli donanımda ise yalnızca faturalandırma (bir ödeme yöntemi ve önceden yüklenmiş krediler) yeterlidir.
  • space_hardware (SpaceHardware veya str, isteğe bağlı) — repo_type “space” ise donanım seçimi. Tam liste için SpaceHardware’e bakın.
  • space_sleep_time (int, isteğe bağlı) — Bir Space'in uyku moduna alınmadan önce beklenen hareketsizlik süresi (saniye cinsinden). Space'inizin uyumasını istemiyorsanız -1 olarak ayarlayın (yükseltilmiş donanımlar için varsayılan davranış). Ücretsiz donanımlarda uyku süresi yapılandırılamaz (değer 48 saat hareketsizlik olarak sabittir). Daha fazla ayrıntı için https://huggingface.co/docs/hub/spaces-gpus#sleep-time adresine bakın.
  • space_secrets (list[dict[str, str]], isteğe bağlı) — Space'inizde ayarlanacak gizli anahtarların listesi. Her öğe {"key": ..., "value": ..., "description": ...} biçimindedir ve description isteğe bağlıdır. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets.
  • space_variables (list[dict[str, str]], isteğe bağlı) — Space'inizde ayarlanacak herkese açık ortam değişkenlerinin listesi. Her öğe {"key": ..., "value": ..., "description": ...} biçimindedir ve description isteğe bağlıdır. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables.
  • space_volumes (list[Volume], isteğe bağlı) — Oluşturma sırasında Space'e bağlanacak Volume nesnelerinin listesi. Her hacmin bir type ("bucket", "model", "dataset" veya "space"), bir source (repo veya bucket kimliği), bir mount_path (kapsayıcı içindeki yol) ve isteğe bağlı revision, read_only ile path alanları vardır. Yalnızca repo_type “space” ise geçerlidir.
  • space_template (str, isteğe bağlı) — Yeni Space'i resmi bir şablondan başlatır. Şablon depo kimliği (ör. "SpacesExamples/jupyterlab") veya kısa adı (ör. "JupyterLab") olabilir. Mevcut şablonları listelemek için HfApi.list_space_templates() kullanın. Yalnızca repo_type “space” ise geçerlidir. Şablonun özel olarak önerilmesi ve görünürlük açıkça ayarlanmamışsa, Space özel olarak oluşturulur.

Dönüş değeri

RepoUrl

Yeni oluşturulan depoya ait URL. Değer, endpoint, repo_type ve repo_id gibi öznitelikler içeren str alt sınıfıdır.

HuggingFace Hub üzerinde boş bir depo oluşturun.

create_scheduled_job

< >

( image: strcommand: list[str]schedule: strsuspend: bool | None = Noneconcurrency: bool | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • image (str) — Kullanılacak Docker görüntüsü. Örnekler: "ubuntu", "python:3.12", "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel". Bir Space'ten görüntü içeren örnek: "hf.co/spaces/lhoestq/duckdb".
  • command (list[str]) — Çalıştırılacak komut. Örnek: ["echo", "hello"].
  • schedule (str) — “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly” değerlerinden biri veya bir CRON zamanlama ifadesi (ör. her Pazartesi saat 9:00 için ‘0 9 * * 1’).
  • suspend (bool, isteğe bağlı) — True ise, planlanan Job askıya alınır (durdurulur). Varsayılan olarak False'dur.
  • concurrency (bool, isteğe bağlı) — True ise, bu Job'un birden fazla örneği eşzamanlı olarak çalıştırılabilir. Varsayılan değeri False'dur.
  • env (dict[str, Any], isteğe bağlı) — Job için ortam değişkenlerini tanımlar.
  • secrets (dict[str, Any], isteğe bağlı) — Job için gizli ortam değişkenlerini tanımlar.
  • flavor (str, isteğe bağlı) — Donanım için tad. Olası değerler için JobHardware’a bakın. Varsayılan değer "cpu-basic"’tür.
  • timeout (Union[int, float, str], isteğe bağlı) — Job için maksimum süre: int, s (saniye, varsayılan), m (dakika), h (saat) veya d (gün) birimiyle. Örnek: 5 dakika için 300 veya "5m".
  • attempts (int, isteğe bağlı) — Her çalıştırma için, ilk deneme dahil olmak üzere, maksimum deneme sayısı. Varsayılan değer 1'dir.
  • name (str, isteğe bağlı) — Planlanan Job için bir ad. name etiketi olarak saklanır. labels içindeki name anahtarıyla birlikte geçirilemez. Adların benzersiz olması gerekmez. Varsayılan olarak, görüntüden ve komuttan türetilen (kısa bir hash sonekiyle) bir ad kullanılır.
  • labels (dict[str, str], isteğe bağlı) — İşin eklenmesi gereken etiketler (anahtar-değer çiftleri).
  • volumes (list[Volume], isteğe bağlı) — İş konteynerinde hacim olarak bağlanacak Hugging Face Buckets veya Repos. Her hacim, type ("bucket", "model", "dataset" veya "space"), source (ör. "username/my-bucket") ve mount_path (ör. "/data") içeren bir Volume'dur.
  • expose (list[int], isteğe bağlı) — İşler vekili (jobs proxy) üzerinden açılacak konteyner portları. Listelenen her port, herkese açık işler alan adında (ör. https://<job_id>--8000.hf.jobs) erişilebilir olur. Erişim her zaman, işin ad alanına (namespace) okuma erişimi olan bir HF token gerektirir. Kimlik doğrulamasız erişim için expose_public kullanın.
  • expose_public (list[int], isteğe bağlı) — Kimlik doğrulama olmadan Jobs vekili üzerinden açılacak portlar. Bunların expose içinde listelenmesine gerek yoktur.
  • resource_group_id (str, isteğe bağlı) — Zamanlanmış Job'ın oluşturulacağı kaynak grubunun kimliği. Bir organizasyon içindeki kaynaklara erişimi kontrol etmek ve maliyet atama/harcama limiti özellikleri için kullanılır. Sağlanmazsa, zamanlanmış Job herhangi bir kaynak grubunun dışında oluşturulur.
  • namespace (str, isteğe bağlı) — Job'ün oluşturulacağı namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında zamanlanmış hesaplama İşleri oluşturun.

Örnek:

İlk zamanlanmış Job'unuzu oluşturun:

>>> from huggingface_hub import create_scheduled_job
>>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly")

Bir CRON zamanlama ifadesi kullanın:

>>> from huggingface_hub import create_scheduled_job
>>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('this runs every 5min')"], schedule="*/5 * * * *")

Zamanlanmış bir GPU İşlemi oluşturun:

>>> from huggingface_hub import create_scheduled_job
>>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"
>>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"]
>>> create_scheduled_job(image=image, command=command, flavor="a10g-small", schedule="@hourly")

create_scheduled_uv_job

< >

( script: strscript_args: list[str] | None = Noneschedule: strsuspend: bool | None = Noneconcurrency: bool | None = Nonedependencies: list[str] | None = Nonepython: str | None = Noneimage: str | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • script (str) — UV betiğinin yolu veya URL'si, ya da bir komut.
  • script_args (list[str], isteğe bağlı) — Betik veya komuta iletilecek argümanlar.
  • schedule (str) — “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly” değerlerinden biri veya bir CRON zamanlama ifadesi (ör. her Pazartesi saat 9:00 için ‘0 9 * * 1’).
  • suspend (bool, isteğe bağlı) — True ise, planlanan Job askıya alınır (durdurulur). Varsayılan olarak False'dur.
  • concurrency (bool, isteğe bağlı) — True ise, bu Job'un birden fazla örneği eşzamanlı olarak çalıştırılabilir. Varsayılan değeri False'dur.
  • dependencies (list[str], isteğe bağlı) — UV betiğini çalıştırmak için kullanılacak bağımlılıklar.
  • python (str, isteğe bağlı) — Belirli bir Python sürümünü kullanın. Varsayılan 3.12'dir.
  • image (str, isteğe bağlı, varsayılan “ghcr.io/astral-sh/uv —python3.12-bookworm”): uv yüklü özel bir Docker görüntüsü kullanın.
  • env (dict[str, Any], isteğe bağlı) — Job için ortam değişkenlerini tanımlar.
  • secrets (dict[str, Any], isteğe bağlı) — Job için gizli ortam değişkenlerini tanımlar.
  • flavor (str, isteğe bağlı) — Donanım için tad. Olası değerler için JobHardware’a bakın. Varsayılan değer "cpu-basic"’tür.
  • timeout (Union[int, float, str], isteğe bağlı) — Job için maksimum süre: int, s (saniye, varsayılan), m (dakika), h (saat) veya d (gün) birimiyle. Örnek: 5 dakika için 300 veya "5m".
  • attempts (int, isteğe bağlı) — Her çalıştırma için, ilk deneme dahil olmak üzere, maksimum deneme sayısı. Varsayılan değer 1'dir.
  • name (str, isteğe bağlı) — Planlanan Job için bir ad. name etiketi olarak saklanır. labels içindeki name anahtarıyla birlikte geçirilemez. Adların benzersiz olması gerekmez. Varsayılan olarak, betikten ve argümanlarından türetilen bir ad (kısa bir hash sonekiyle) kullanılır.
  • labels (dict[str, str], isteğe bağlı) — İşin eklenmesi gereken etiketler (anahtar-değer çiftleri).
  • volumes (list[Volume], isteğe bağlı) — İş konteynerinde hacim olarak bağlanacak Hugging Face Buckets veya Repos. Her hacim, type ("bucket", "model", "dataset" veya "space"), source (ör. "username/my-bucket") ve mount_path (ör. "/data") içeren bir Volume'dur.
  • expose (list[int], isteğe bağlı) — İşler vekili (jobs proxy) üzerinden açılacak konteyner portları. Listelenen her port, herkese açık işler alan adında (ör. https://<job_id>--8000.hf.jobs) erişilebilir olur. Erişim her zaman, işin ad alanına (namespace) okuma erişimi olan bir HF token gerektirir. Kimlik doğrulamasız erişim için expose_public kullanın.
  • expose_public (list[int], isteğe bağlı) — Kimlik doğrulama olmadan Jobs vekili üzerinden açılacak portlar. Bunların expose içinde listelenmesine gerek yoktur.
  • resource_group_id (str, isteğe bağlı) — Zamanlanmış Job'ın oluşturulacağı kaynak grubunun kimliği. Bir organizasyon içindeki kaynaklara erişimi kontrol etmek ve maliyet atama/harcama limiti özellikleri için kullanılır. Sağlanmazsa, zamanlanmış Job herhangi bir kaynak grubunun dışında oluşturulur.
  • namespace (str, isteğe bağlı) — Job'ün oluşturulacağı namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında bir UV script Job çalıştırın.

hf jobs uv run'un aksine, bu yöntem, bir UV betiğinin PEP 723 başlığında taşıyabileceği isteğe bağlı [tool.hf-jobs] tablosunu görmezden gelir (Jobs kılavuzu bkz.): başlatma yapılandırmasının burada açıkça iletilmesi gerekir.

Örnek:

Bir URL'den betik zamanla:

>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")

Yerel bir betik zamanla:

>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")

Komut zamanla:

>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "lighteval"
>>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small", schedule="@weekly")

create_tag

< >

( repo_id: strtag: strtag_message: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonerepo_type: str | None = Noneexist_ok: bool = False )

Parametreler

  • repo_id (str) — Bir commit'in etiketleneceği depo. Örnek: "user/my-cool-model".
  • tag (str) — Oluşturulacak etiketin adı.
  • tag_message (str, isteğe bağlı) — Oluşturulacak etiketin açıklaması.
  • revision (str, isteğe bağlı) — Etiketlenecek git revizyonu. Bir dal adı veya bir commit'in OID/SHA'sı olarak, onaltılık bir dize olabilir. Kısaltmalar (ilk 7 karakter) de desteklenir. Varsayılan olarak "main" dalının başıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri seti veya space etiketliyorsanız "dataset" veya "space", bir model etiketliyorsanız None veya "model" olarak ayarlayın. Varsayılan değer None'dir.
  • exist_ok (bool, isteğe bağlı, varsayılan False) — True ise, etiket zaten varsa hata yükseltilmez.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError veya HfHubHTTPError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.
  • RevisionNotFoundError — Revizyon depoda bulunamazsa (404 hatası).
  • HfHubHTTPError — Dal, depoda zaten varsa (hata 409) ve exist_ok False olarak ayarlanmışsa.

Hub'daki bir repoyu verilen bir commit ile etiketleyin.

create_webhook

< >

( url: str | None = Nonejob_id: str | None = Nonewatched: list[dict | WebhookWatchedItem]domains: list[constants.WEBHOOK_DOMAIN_T] | None = Nonesecret: str | None = Nonesecrets: dict[str, str] | None = Nonetoken: bool | str | None = None ) → WebhookInfo

Parametreler

  • url (str) — Yükün gönderileceği URL.
  • job_id (str) — WEBHOOK_PAYLOAD ortam değişkenindeki webhook yüküyle tetiklenecek kaynak Job'un kimliği. Kolaylık sağlamak için ek ortam değişkenleri mevcuttur: WEBHOOK_REPO_ID, WEBHOOK_REPO_TYPE ve WEBHOOK_SECRET.
  • watched (list[WebhookWatchedItem]) — Webhook tarafından izlenecek WebhookWatchedItem listesi. Kullanıcılar, kuruluşlar, modeller, veri kümeleri, uzaylar veya depolar olabilir. İzlenen öğeler düz sözlükler olarak da sağlanabilir.
  • domains (list[Literal["repo", "discussion"]], opsiyonel) — İzlenecek alanların listesi. “repo”, “discussion” veya her ikisi olabilir. Varsayılan olarak her ikisi de kullanılır.
  • secret (str, isteğe bağlı) — Yükü imzalamak için kullanılacak gizli anahtar.
  • secrets (dict[str, str], optional) — Webhook tarafından tetiklenen Job için gizli ortam değişkenleri (ör. {"HF_TOKEN": "hf_***"}). Yalnızca job_id ile geçerlidir. Kaynak Job’un gizli bilgileri webhoook’a kopyalanmaz, bu nedenle bunları buradan iletin.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

WebhookInfo

Yeni oluşturulan webhook hakkında bilgi.

Yeni bir webhook oluşturun.

Webhook, bir URL'ye yük (payload) gönderebilir veya Hugging Face altyapısında bir Job'un çalıştırılmasını tetikleyebilir. Bu fonksiyon, url veya job_id parametrelerinden yalnızca biriyle çağrılmalıdır, ikisi birlikte kullanılmamalıdır.

Örnek:

Bir URL'ye bir yük (payload) gönderen bir webhook oluşturun

>>> from huggingface_hub import create_webhook
>>> payload = create_webhook(
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
...     domains=["repo", "discussion"],
...     secret="my-secret",
... )
>>> print(payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    job=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

Bir İş çalıştırın ve ardından bu İş'i tetikleyen bir webhook oluşturun

>>> from huggingface_hub import create_webhook, run_job
>>> job = run_job(
...     image="ubuntu",
...     command=["bash", "-c", r"echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD"],
... )
>>> payload = create_webhook(
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     job_id=job.id,
...     domains=["repo", "discussion"],
...     secret="my-secret",
... )
>>> print(payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url=None,
    job=JobSpec(
        docker_image='ubuntu',
        space_id=None,
        command=['bash', '-c', 'echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD'],
        arguments=[],
        environment={},
        secrets=[],
        flavor='cpu-basic',
        timeout=None,
        tags=None,
        arch=None
    ),
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

dataset_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandDatasetProperty_T] | None = Nonetoken: bool | str | None = None ) → hf_api.DatasetInfo

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • revision (str, isteğe bağlı) — Bilgilerin alınacağı veri seti deposunun revizyonu.
  • timeout (float, isteğe bağlı) — Hub'a yapılan istek için bir zaman aşımı ayarlanıp ayarlanmayacağı.
  • files_metadata (bool, isteğe bağlı) — Depodaki dosyalar için (boyut, LFS meta verisi vb.) meta verilerin alınıp alınmayacağı. Varsayılan değer False.
  • expand (list[ExpandDatasetProperty_T], isteğe bağlı) — Yanıtta döndürülecek özelliklerin listesi. Kullanıldığında, yalnızca listedeki özellikler döndürülür. files_metadata geçirildiğinde bu parametre kullanılamaz. Olası değerler "author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "lastModified", "likes", "mainSize", "paperswithcode_id", "private", "siblings", "sha", "tags", "trendingScore", "usedStorage" ve "resourceGroup"'dür.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

hf_api.DatasetInfo

Veri seti deposu bilgileri.

huggingface.co'daki belirli bir veri seti hakkında bilgi alın.

Geçerli bir token iletirseniz Dataset özel olabilir.

Aşağıdaki hataları oluşturur:

  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.
  • RevisionNotFoundError İndirilecek revizyon bulunamadığında.

delete_branch

< >

( repo_id: strbranch: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Parametreler

  • repo_id (str) — Bir dalın silineceği depo. Örnek: "user/my-cool-model".
  • branch (str) — Silinecek dalın adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri seti veya space üzerinde dal oluşturuyorsanız "dataset" veya "space", bir modele etiket atıyorsanız None veya "model" olarak ayarlayın. Varsayılan değer None'dir.

Yükseltilen

RepositoryNotFoundError veya HfHubHTTPError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.
  • HfHubHTTPError — Korumalı bir dalı silmeye çalışırken. Ör: main silinemez.
  • HfHubHTTPError — Eğer silmeye çalıştığınız dal mevcut değilse.

Hub'daki bir depodan bir dalı silin.

delete_bucket

< >

( bucket_id: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Parametreler

  • bucket_id (str) — Kovanın kimliği (ör. "username/my-bucket").
  • missing_ok (bool, isteğe bağlı, varsayılan False) — True ise, varlık yoksa hata yükseltilmez.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

BucketNotFoundError

  • BucketNotFoundError — Bucket bulunamazsa ve missing_ok False olarak ayarlanmışsa (varsayılan).

Hub'dan bir varlık silin.

Örnek:

>>> from huggingface_hub import delete_bucket
>>> delete_bucket(bucket_id="Wauplin/first-bucket")
>>> delete_bucket(bucket_id="Wauplin/first-bucket", missing_ok=True)

delete_collection

< >

( collection_slug: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Parametreler

  • collection_slug (str) — Silinecek koleksiyonun slug'ı. Örnek: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • missing_ok (bool, isteğe bağlı) — True ise, koleksiyon yoksa hata yükseltilmez.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Hub'da bir koleksiyonu silin.

Örnek:

>>> from huggingface_hub import delete_collection
>>> collection = delete_collection("username/useless-collection-64f9a55bb3115b4f513ec026", missing_ok=True)

Bu geri alınamaz bir eylemdir. Silinen bir koleksiyon geri yüklenemez.

delete_collection_item

< >

( collection_slug: stritem_object_id: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Parametreler

  • collection_slug (str) — Güncellenecek koleksiyonun slug'ı. Örnek: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_object_id (str) — Koleksiyondaki öğenin kimliği. Bu, öğenin Hub'daki kimliği (repo_id veya makale kimliği) değildir. Bir CollectionItem nesnesinden alınmalıdır. Örnek: collection.items[0].item_object_id.
  • missing_ok (bool, isteğe bağlı) — True ise, öğe yoksa hata yükseltilmez.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir koleksiyondan bir öğe silin.

Örnek:

>>> from huggingface_hub import get_collection, delete_collection_item

# Get collection first
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")

# Delete item based on its ID
>>> delete_collection_item(
...     collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",
...     item_object_id=collection.items[-1].item_object_id,
... )

delete_file

< >

( path_in_repo: strrepo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Parametreler

  • path_in_repo (str) — Depodaki göreli dosya yolu, örneğin: "checkpoints/1fec34a/weights.bin"
  • repo_id (str) — Dosyanın silineceği depo, örneğin: "username/custom_transformers"
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Dosya bir veri setinde veya uzayda (space) ise "dataset" veya "space" olarak ayarlayın, bir modelde ise None veya "model". Varsayılan değer None'dir.
  • revision (str, isteğe bağlı) — Taahhüt edilecek git revizyonu. Varsayılan olarak "main" dalının başıdır.
  • commit_message (str, isteğe bağlı) — Oluşturulan commit'in özeti / başlığı / ilk satırı. Varsayılan değer f"Delete {path_in_repo} with huggingface_hub".
  • commit_description (str, isteğe bağlı) — Oluşturulan commit'in açıklaması
  • create_pr (boolean, isteğe bağlı) — Bu commit ile bir Pull Request oluşturulup oluşturulmayacağı. Varsayılan olarak False. revision ayarlanmadıysa, PR "main" dalına karşı açılır. revision ayarlandıysa ve bir dal ise, PR bu dala karşı açılır. revision ayarlandıysa ve bir dal adı değilse (örneğin: bir commit oid), sunucu tarafından RevisionNotFoundError döndürülür.
  • parent_commit (str, isteğe bağlı) — Ebeveyn commit'in OID / SHA'sı, onaltılık bir dize olarak. Kısaltmalar (ilk 7 karakter) de desteklenir. Belirtilirse ve create_pr False ise, revision parent_commit'e işaret etmiyorsa commit başarısız olur. Belirtilirse ve create_pr True ise, pull request parent_commit'ten oluşturulur. parent_commit'in belirtilmesi, değişiklikler commit edilmeden önce repoyun değişmediğinden emin olunmasını sağlar ve repoyun eşzamanlı olarak güncellendiği / commit edildiği durumlarda özellikle faydalı olabilir.

Verilen depodaki bir dosyayı siler.

Aşağıdaki hataları oluşturur:

delete_files

< >

( repo_id: strdelete_patterns: list[str]token: bool | str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Parametreler

  • repo_id (str) — Klasörün silineceği depo, örneğin: "username/custom_transformers"
  • delete_patterns (list[str]) — Silinecek dosya veya klasörlerin listesi. Her dize bir dosya yolu, bir klasör yolu veya bir joker deseni olabilir. Desenler burada belgelenen Standart Jokerler (globbing desenleri)dir. Desen eşleştirme fnmatch üzerine kuruludur. Not: fnmatch, geleneksel Unix kabuk globbing'inden farklı olarak * ile yol sınırları boyunca eşleştirme yapar. Örn. ["file.txt", "folder/", "data/*.parquet"]
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False değerini kaydedilmiş belirtece iletin.
  • repo_type (str, isteğe bağlı) — Dosyaların silineceği repoyu türü. "model", "dataset" veya "space" olabilir. Varsayılan değer "model"'dir.
  • revision (str, isteğe bağlı) — Taahhüt edilecek git revizyonu. Varsayılan olarak "main" dalının başıdır.
  • commit_message (str, isteğe bağlı) — Oluşturulan commit'in özeti (ilk satırı). Varsayılan değer f"Delete files using huggingface_hub".
  • commit_description (str, isteğe bağlı) — Oluşturulan commit'in açıklaması.
  • create_pr (boolean, isteğe bağlı) — Bu commit ile bir Pull Request oluşturulup oluşturulmayacağı. Varsayılan olarak False. revision ayarlanmadıysa, PR "main" dalına karşı açılır. revision ayarlandıysa ve bir dal ise, PR bu dala karşı açılır. revision ayarlandıysa ve bir dal adı değilse (örneğin: bir commit oid), sunucu tarafından RevisionNotFoundError döndürülür.
  • parent_commit (str, isteğe bağlı) — Ebeveyn commit'in OID / SHA'sı, onaltılık bir dize olarak. Kısaltmalar (ilk 7 karakter) de desteklenir. Belirtilirse ve create_pr False ise, revision parent_commit'e işaret etmiyorsa commit başarısız olur. Belirtilirse ve create_pr True ise, pull request parent_commit'ten oluşturulur. parent_commit'in belirtilmesi, değişiklikler commit edilmeden önce repoyun değişmediğinden emin olunmasını sağlar ve repoyun eşzamanlı olarak güncellendiği / commit edildiği durumlarda özellikle faydalı olabilir.

Hub'daki bir depodan dosyaları silin.

Bir klasör yolu sağlanırsa, klasörün kendisi ve içindeki tüm dosyalar da silinir.

delete_folder

< >

( path_in_repo: strrepo_id: strtoken: bool | str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Parametreler

  • path_in_repo (str) — Depodaki göreli klasör yolu, örneğin: "checkpoints/1fec34a".
  • repo_id (str) — Klasörün silineceği depo, örneğin: "username/custom_transformers"
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False değerini kaydedilmiş belirtece iletin.
  • repo_type (str, isteğe bağlı) — Klasör bir veri setinde veya uzayda ise "dataset" veya "space" olarak ayarlayın, bir modelde ise None veya "model". Varsayılan değer None'dir.
  • revision (str, isteğe bağlı) — Taahhüt edilecek git revizyonu. Varsayılan olarak "main" dalının başıdır.
  • commit_message (str, isteğe bağlı) — Oluşturulan commit'in özeti / başlığı / ilk satırı. Varsayılan değer f"Delete folder {path_in_repo} with huggingface_hub".
  • commit_description (str, isteğe bağlı) — Oluşturulan commit'in açıklaması.
  • create_pr (boolean, isteğe bağlı) — Bu commit ile bir Pull Request oluşturulup oluşturulmayacağı. Varsayılan olarak False. revision ayarlanmadıysa, PR "main" dalına karşı açılır. revision ayarlandıysa ve bir dal ise, PR bu dala karşı açılır. revision ayarlandıysa ve bir dal adı değilse (örneğin: bir commit oid), sunucu tarafından RevisionNotFoundError döndürülür.
  • parent_commit (str, isteğe bağlı) — Ebeveyn commit'in OID / SHA'sı, onaltılık bir dize olarak. Kısaltmalar (ilk 7 karakter) de desteklenir. Belirtilirse ve create_pr False ise, revision parent_commit'e işaret etmiyorsa commit başarısız olur. Belirtilirse ve create_pr True ise, pull request parent_commit'ten oluşturulur. parent_commit'in belirtilmesi, değişiklikler commit edilmeden önce repoyun değişmediğinden emin olunmasını sağlar ve repoyun eşzamanlı olarak güncellendiği / commit edildiği durumlarda özellikle faydalı olabilir.

Verilen depodaki bir klasörü siler.

create_commit() yönteminin basit bir sarmalayıcısı.

delete_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • name (str) — Silinecek Inference Endpoint'in adı.
  • namespace (str, isteğe bağlı) — Inference Endpoint'in bulunduğu namespace. Varsayılan olarak mevcut kullanıcıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir Inference Endpoint silin.

Bu işlem geri alınamaz. Bir Inference Endpoint için ücretlendirilmek istemiyorsanız, onu pause_inference_endpoint() ile duraklatmak veya scale_to_zero_inference_endpoint() ile sıfıra ölçeklendirmek tercih edilir.

Kolaylık olması için bir Inference Endpoint'i InferenceEndpoint.delete() kullanarak da silebilirsiniz.

delete_repo

< >

( repo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonemissing_ok: bool = False )

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya space'e yükleniyorsa "dataset" veya "space" olarak, bir modele yükleniyorsa None veya "model" olarak ayarlayın.
  • missing_ok (bool, isteğe bağlı, varsayılan False) — True ise, depo yoksa hata yükseltilmez.

Yükseltilen

RepositoryNotFoundError

  • RepositoryNotFoundError — Silinmesi gereken depo bulunamadığında ve missing_ok False olarak ayarlanmışsa (varsayılan).

HuggingFace Hub'dan bir repoyu silin. DİKKAT: bu işlem geri alınamaz.

delete_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • scheduled_job_id (str) — Planlanan Job'un kimliği.
  • namespace (str, isteğe bağlı) — Planlanan Job'un bulunduğu namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında zamanlanmış bir hesaplama İşini siler.

delete_space_secret

< >

( repo_id: strkey: strtoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Güncellenecek depoyun kimliği. Örnek: "bigcode/in-the-stack".
  • key (str) — Gizli anahtar. Örnek: "GITHUB_API_KEY".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir Uzay'dan bir gizli değeri siler.

Secrets, bir Space'e gizli anahtarlar veya jetonları bunları kodun içine gömmeden ayarlamayı sağlar. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

delete_space_variable

< >

( repo_id: strkey: strtoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Güncellenecek depoyun kimliği. Örnek: "bigcode/in-the-stack".
  • key (str) — Değişken anahtarı. Örnek: "MODEL_REPO_ID"
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir Uzay'dan bir değişkeni siler.

Değişkenler, bir Space'e ortam değişkenlerini sabit kodlamadan ayarlamayı sağlar. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

delete_space_volumes

< >

( repo_id: strtoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Güncellenecek Space'in kimliği. Örnek: "username/my-space".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

BadRequestError

  • BadRequestError — Space'e bağlı birimler yoksa.

Bir Uzay'dan tüm hacimleri kaldırın.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.delete_space_volumes("username/my-space")

delete_tag

< >

( repo_id: strtag: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Parametreler

  • repo_id (str) — Bir etiketin silineceği depo. Örnek: "user/my-cool-model".
  • tag (str) — Silinecek etiketin adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri seti veya space etiketleniyorsa "dataset" veya "space", bir model etiketleniyorsa None veya "model" olarak ayarlanır. Varsayılan değer None'dir.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError

Hub'daki bir depodan etiketi siler.

delete_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → None

Parametreler

  • webhook_id (str) — Silinecek webhook'un benzersiz tanımlayıcısı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

None

Bir webhook silinir.

Örnek:

>>> from huggingface_hub import delete_webhook
>>> delete_webhook("654bbbc16f2ec14d77f109cc")

disable_space_dev_mode

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Parametreler

  • repo_id (str) — Dev modunun devre dışı bırakılacağı Space'in kimliği. Örnek: "Salesforce/BLIP2".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

SpaceRuntime

Space'inizin çalışma zamanı bilgileri.

Yükseltilen

RepositoryNotFoundError veya HfHubHTTPError veya BadRequestError

  • RepositoryNotFoundError — Space'iniz bulunamadıysa (404 hatası). Büyük olasılıkla repo_id yanlış ya da Space'iniz özel ancak kimlik doğrulamanız yapılmamış.
  • HfHubHTTPError — 403 Yasak: Bir Space'in dev modunu yalnızca sahibi ayarlayabilir. Sahibi olmadığınız bir Space ile ilgilenmek istiyorsanız, bir Discussion açarak sahibinden rica edin veya Space'i kopyalayın.
  • BadRequestError — Space'ınız statik bir Space ise. Statik Spaces her zaman çalışır durumda olur ve asla faturalandırılmaz. Statik bir Space'i gizlemek istiyorsanız, onu özel olarak ayarlayabilirsiniz.

Bir Space'te dev modunu devre dışı bırakın.

Spaces Dev Mode, uygulama hata ayıklamanızı kolaylaştırır ve Space konteynerinin kendisini durdurmadan uygulamanızı yeniden başlatmanıza izin vererek Spaces üzerinde iterasyon yapmayı hızlandırır. Dev mode'u etkinleştirmek için PRO veya Team & Enterprise planı gereklidir, ancak devre dışı bırakmak her zaman izin verilir (ör. bir abonelik süresi dolduktan sonra). Daha fazla ayrıntı için https://huggingface.co/docs/hub/spaces-dev-mode adresine bakın.

disable_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Parametreler

  • webhook_id (str) — Devre dışı bırakılacak webhook'un benzersiz tanımlayıcısı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

WebhookInfo

Devre dışı bırakılan webhook hakkında bilgi.

Bir webhook'ü devre dışı bırakın (durumu “devre dışı” olur).

Örnek:

>>> from huggingface_hub import disable_webhook
>>> disabled_webhook = disable_webhook("654bbbc16f2ec14d77f109cc")
>>> disabled_webhook
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    jon=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=True,
)

download_bucket_files

< >

( bucket_id: strfiles: list[tuple[str | BucketFile, str | Path]]raise_on_missing_files: bool = Falsetoken: str | bool | None = None )

Parametreler

  • bucket_id (str) — Kovanın kimliği (ör. "username/my-bucket").
  • files (list[tuple[Union[str, BucketFile], Union[str, Path]]]) — Kaynak ve hedef olarak indirilecek dosyaların bir tuple listesi. Biçim ayrıntıları için yukarıdaki açıklamaya bakın.
  • raise_on_missing_files (bool, isteğe bağlı) — True ise, istenen dosya bucket'ta yoksa bir EntryNotFoundError fırlatılır. False ise (varsayılan), eksik dosyalar bir uyarıyla atlanır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir kovadan dosyaları indirin.

Files girdisi, remote file'in bucket'taki dosyanın yolu veya bir BucketFile nesnesi, local file'ün ise yerel dosya sistemindeki hedef yolu olduğu (remote file, local file) demetlerinin bir listesidir. Bir BucketFile nesnesi (list_bucket_tree() ile elde edilen) geçirildiğinde, yöntem meta verileri alma adımını atlar ve dosyaları doğrudan indirir.

Örnek:

>>> from huggingface_hub import download_bucket_files

>>> download_bucket_files(
...     bucket_id="username/my-bucket",
...     files=[
...         ("models/model.safetensors", "./local/model.safetensors"),
...         ("config.json", "./local/config.json"),
...     ],
... )
>>> from huggingface_hub import download_bucket_files

>>> parquet_files = [file for file in list_bucket_tree(bucket_id="username/my-bucket") if file.path.endswith(".parquet")]
>>> download_bucket_files(
...     bucket_id="username/my-bucket",
...     files=[(file, f"./local/{file.path}") for file in parquet_files],
... )

duplicate_repo

< >

( from_id: strto_id: str | None = Nonerepo_type: str | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonetoken: bool | str | None = Noneexist_ok: bool = Falseresource_group_id: str | None = Nonespace_hardware: SpaceHardware | None = Nonespace_sleep_time: int | None = Nonespace_secrets: list[dict[str, str]] | None = Nonespace_variables: list[dict[str, str]] | None = Nonespace_volumes: list[Volume] | None = None ) → DuplicatedRepoUrl

Parametreler

  • from_id (str) — Kopyalanacak repozituarın kimliği. Örnek: "openai/gdpval".
  • to_id (str, isteğe bağlı) — Yeni repozituarın kimliği. Örnek: "myorg/my-gdpval". Belirtilmezse, yeni repo orijinal repo ile aynı adı taşır, ancak hesabınızda oluşturulur.
  • repo_type (str, isteğe bağlı) — Bir veri seti veya Space kopyalanıyorsa "dataset" veya "space" olarak ayarlayın, bir model kopyalanıyorsa None veya "model". Varsayılan değer None'dir.
  • private (bool, isteğe bağlı) — Yeni deponun özel olup olmayacağı. Varsayılan olarak, orijinal depoyla aynı gizliliğe sahiptir. visibility parametresiyle birlikte geçirilemez.
  • visibility (Literal["public", "private", "protected"], isteğe bağlı) — Yeni repozituarın görünürlüğü. "public" veya "private" olabilir, Spaces için "protected" olabilir. Varsayılan olarak, orijinal repozituarla aynı görünürlüğe sahiptir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • exist_ok (bool, isteğe bağlı, varsayılan False) — True ise, depo zaten varsa hata yükseltilmez.
  • resource_group_id (str, isteğe bağlı) — Yeni repoyu oluşturulacak kaynak grubu. Kaynak grupları yalnızca Enterprise Hub kuruluşları için kullanılabilir ve kuruluşun hangi üyelerinin kaynağa erişebileceğini tanımlamaya olanak tanır. Bir kaynak grubunun kimliği, Hub'daki kaynağın sayfasındaki URL'de bulunabilir (ör. "66670e5163145ca562cb1988"). Kaynak grupları hakkında daha fazla bilgi için https://huggingface.co/docs/hub/en/security-resource-groups adresine bakın.
  • space_hardware (SpaceHardware veya str, isteğe bağlı) — repo_type “space” ise donanım seçimi. Örnek: "t4-medium". Tam liste için bkz. SpaceHardware.
  • space_sleep_time (int, isteğe bağlı) — Bir Space'in uyku moduna alınmadan önce beklenen hareketsizlik süresi (saniye cinsinden). Space'inizin uyumasını istemiyorsanız -1 olarak ayarlayın (yükseltilmiş donanımlar için varsayılan davranış). Ücretsiz donanımlarda uyku süresi yapılandırılamaz (değer 48 saat hareketsizlik olarak sabittir). Yalnızca repo_type "space" ise geçerlidir. Daha fazla ayrıntı için https://huggingface.co/docs/hub/spaces-gpus#sleep-time adresine bakın.
  • space_secrets (list[dict[str, str]], isteğe bağlı) — Space'inizde ayarlanacak gizli anahtarların listesi. Her öğe {"key": ..., "value": ..., "description": ...} biçimindedir ve description isteğe bağlıdır. Yalnızca repo_type “space” ise geçerlidir. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets.
  • space_variables (list[dict[str, str]], isteğe bağlı) — Space'inizde ayarlanacak herkese açık ortam değişkenlerinin listesi. Her öğe {"key": ..., "value": ..., "description": ...} biçimindedir ve description isteğe bağlıdır. Yalnızca repo_type “space” ise geçerlidir. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables.
  • space_volumes (list[Volume], isteğe bağlı) — Kopyalama sırasında Space'e bağlanacak Volume nesnelerinin listesi. Her hacmin bir type ("bucket", "model", "dataset" veya "space"), bir source (repo veya bucket kimliği), bir mount_path (kapsayıcı içindeki yol) ve isteğe bağlı revision, read_only ile path alanları vardır. Yalnızca repo_type “space” ise geçerlidir.

Dönüş değeri

DuplicatedRepoUrl

Yeni oluşturulan depoya ait URL. Değer, endpoint, repo_type, repo_id ve files_copy_pending gibi öznitelikleri içeren RepoUrl'nin (ve str'nin) bir alt sınıfıdır.

Yükseltilen

RepositoryNotFoundError veya HfHubHTTPError

  • RepositoryNotFoundError — from_id veya to_id bulunamazsa. Bunun nedeni, var olmaması veya private olarak ayarlanmış olması ve erişiminizin olmaması olabilir.
  • HfHubHTTPError — HuggingFace API bir hata döndürdüyse

Hub'da bir repoyu (model, veri seti veya Space) kopyalayın.

Bu işlem, tam git geçmişini ve LFS nesnelerini koruyan, yerel bir indirme/yükleme turu gerektirmeyen sunucu tarafında bir kopyalama gerçekleştirir.

Git geçmişi hemen kopyalanır, ancak bu yöntem döndüğünde LFS/Xet dosyaları arka planda kopyalanmaya devam edebilir. Bu durumda, döndürülen değer üzerinde files_copy_pending True olur ve kopyalama tamamlanana kadar bu dosyaların yeni depodan indirilmesi başarısız olabilir.

Örnek:

>>> from huggingface_hub import duplicate_repo

# Duplicate a model to your account
>>> repo_url = duplicate_repo("google/gemma-7b")
>>> repo_url
RepoUrl('https://huggingface.co/nateraw/gemma-7b',...)
>>> repo_url.files_copy_pending
True

# Duplicate a dataset with a custom name
>>> duplicate_repo("openai/gdpval", to_id="myorg/my-gdpval", repo_type="dataset")
RepoUrl('https://huggingface.co/datasets/myorg/my-gdpval',...)

# Duplicate a Space with custom hardware
>>> duplicate_repo("multimodalart/dreambooth-training", repo_type="space", space_hardware="t4-medium")
RepoUrl('https://huggingface.co/spaces/nateraw/dreambooth-training',...)

edit_discussion_comment

< >

( repo_id: strdiscussion_num: intcomment_id: strnew_content: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • discussion_num (int) — Discussion veya Pull Request numarası. Kesinlikle pozitif bir tam sayı olmalıdır.
  • comment_id (str) — Düzenlenecek yorumun kimliği.
  • new_content (str) — Yorumun yeni içeriği. Yorumlar markdown biçimlendirmesini destekler.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

TartışmaYorumu

düzenlenmiş yorum

Bir Tartışma / Çekme İsteği'ndeki yorumu düzenler.

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

enable_space_dev_mode

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Parametreler

  • repo_id (str) — Geliştirici modunun etkinleştirileceği Space'in kimliği. Örnek: "Salesforce/BLIP2".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

SpaceRuntime

Space'inizin çalışma zamanı bilgileri.

Yükseltilen

RepositoryNotFoundError veya HfHubHTTPError veya BadRequestError

  • RepositoryNotFoundError — Space'iniz bulunamadıysa (404 hatası). Büyük olasılıkla repo_id yanlış ya da Space'iniz özel ancak kimlik doğrulamanız yapılmamış.
  • HfHubHTTPError — 403 Yasak: Bir Space'in dev modunu yalnızca sahibi ayarlayabilir. Sahibi olmadığınız bir Space ile ilgilenmek istiyorsanız, bir Discussion açarak sahibinden rica edin veya Space'i kopyalayın.
  • BadRequestError — Space'ınız statik bir Space ise. Statik Spaces her zaman çalışır durumda olur ve asla faturalandırılmaz. Statik bir Space'i gizlemek istiyorsanız, onu özel olarak ayarlayabilirsiniz.

Bir Space'te geliştirici modunu etkinleştirin.

Spaces Dev Mode, Space konteynerinin kendisini durdurmadan uygulamanızı yeniden başlatmanıza olanak tanıyarak uygulamanızın hata ayıklamasını kolaylaştırır ve Spaces üzerinde iterasyon yapmayı hızlandırır. Bu özellik, PRO veya Team & Enterprise planının bir parçası olarak kullanılabilir. Daha fazla ayrıntı için https://huggingface.co/docs/hub/spaces-dev-mode adresine bakın.

enable_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Parametreler

  • webhook_id (str) — Etkinleştirilecek webhook'un benzersiz tanımlayıcısı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

WebhookInfo

Etkinleştirilen webhook hakkında bilgi.

Bir webhook etkinleştirin (bunu “aktif” hale getirir).

Örnek:

>>> from huggingface_hub import enable_webhook
>>> enabled_webhook = enable_webhook("654bbbc16f2ec14d77f109cc")
>>> enabled_webhook
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

fetch_job_logs

< >

( job_id: strnamespace: str | None = Nonefollow: bool = Falsetail: int | None = Nonetoken: bool | str | None = None )

Parametreler

  • job_id (str) — Job'un kimliği.
  • namespace (str, isteğe bağlı) — Job'un çalıştığı namespace. Varsayılan olarak kullanıcının mevcut namespace'i kullanılır.
  • follow (bool, isteğe bağlı) — True ise, iş tamamlanana kadar günlükleri gerçek zamanlı olarak akışa alır (engelleyici). False ise (varsayılan), yalnızca o anda mevcut olan günlükleri getirir ve hemen döner (engelleyici olmayan).
  • tail (int, isteğe bağlı) — Günlüklerden döndürülecek maksimum satır sayısı. follow=True ile birleştirildiğinde, son N satırdan başlar ve yeni günlükleri akış olarak devam ettirir. follow=False olduğunda, yalnızca mevcut günlüklerden son N satırı döndürür.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısındaki bir hesaplama Job'undan tüm günlükleri getirir.

Örnek:

>>> from huggingface_hub import fetch_job_logs, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
>>> for log in fetch_job_logs(job_id=job.id):
...     print(log)
Hello from HF compute!

>>> # Non-blocking: fetch only currently available logs
>>> for log in fetch_job_logs(job_id=job.id, follow=False):
...     print(log)

>>> # Stream logs starting from the last 100 lines
>>> for log in fetch_job_logs(job_id=job.id, follow=True, tail=100):
...     print(log)

fetch_job_metrics

< >

( job_id: strnamespace: str | None = Nonefollow: bool = Falsetoken: bool | str | None = None )

Parametreler

  • job_id (str) — Job'un kimliği.
  • namespace (str, isteğe bağlı) — Job'un çalıştığı namespace. Varsayılan olarak kullanıcının mevcut namespace'i kullanılır.
  • follow (bool, isteğe bağlı) — True ise, iş tamamlanana kadar metrikleri gerçek zamanlı olarak akışa alır (engelleyici). False ise (varsayılan), yalnızca güncel metrikleri getirir ve döner (engelleyici olmayan).
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısındaki bir hesaplama Job'undan canlı metrikleri getirin.

Örnek:

>>> from huggingface_hub import fetch_job_metrics, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], flavor="a10g-small")
>>> for metrics in fetch_job_metrics(job_id=job.id):
...     print(metrics)
{
    "cpu_usage_pct": 0,
    "cpu_millicores": 3500,
    "memory_used_bytes": 1306624,
    "memory_total_bytes": 15032385536,
    "rx_bps": 0,
    "tx_bps": 0,
    "gpus": {
        "882fa930": {
            "utilization": 0,
            "memory_used_bytes": 0,
            "memory_total_bytes": 22836000000
        }
    },
    "replica": "57vr7"
}

>>> # Stream metrics until the job completes
>>> for metrics in fetch_job_metrics(job_id=job.id, follow=True):
...     print(metrics)

fetch_space_logs

< >

( repo_id: strbuild: bool = Falsefollow: bool = Falsetoken: bool | str | None = None ) → Iterable[str]

Parametreler

  • repo_id (str) — Space'in kimliği. Örnek: "bigcode/in-the-stack".
  • build (bool, isteğe bağlı, varsayılan False) — True ise, konteyner derleme günlüklerini getirir (bir Space BUILD_ERROR durumunda takılı kaldığında faydalıdır). False ise (varsayılan), çalışma günlüklerini, yani çalışan uygulamanın stdout/stderr çıktısını getirir.
  • follow (bool, isteğe bağlı, varsayılan False) — True ise, sunucu akışı kapatana veya KeyboardInterrupt fırlatılana kadar günlükleri gerçek zamanlı olarak (engelleyici) akış olarak alır. False (varsayılan) ise, yalnızca o anda tamponlanan günlükleri alır ve hemen döner (engelleyici değil, docker logs gibi).
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Varsayılan olarak, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

Iterable[str]

Müsait oldukça log satırları üreten bir üreteç.

Hub'daki bir Space'in çalışma veya derleme günlüklerini getirin.

Derleme sırasında hata veren veya çalışma zamanında çöken bir Space'i hata ayıklamak için faydalıdır, özellikle de tarayıcıda günlükleri okumanın mümkün olmadığı bir betik veya ajan tabanlı iş akışından kaynaklanan durumlarda.

Örnek:

>>> from huggingface_hub import fetch_space_logs
>>> # Non-blocking: print currently available run logs and exit.
>>> for line in fetch_space_logs("username/my-space"):
...     print(line, end="")

>>> # Debug a build failure:
>>> for line in fetch_space_logs("username/my-space", build=True):
...     print(line, end="")

>>> # Stream run logs until the server closes the stream.
>>> for line in fetch_space_logs("username/my-space", follow=True):
...     print(line, end="")

file_exists

< >

( repo_id: strfilename: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: str | bool | None = None )

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • filename (str) — Kontrol edilecek dosyanın adı, örneğin: "config.json"
  • repo_type (str, isteğe bağlı) — Bir veri setinden veya bir space'ten depo bilgisi alınıyorsa "dataset" veya "space" olarak ayarlayın, bir modelden depo bilgisi alınıyorsa None veya "model". Varsayılan değer None'dir.
  • revision (str, isteğe bağlı) — Bilgilerin alınacağı depoyun revizyonu. Varsayılan olarak "main" dalıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Hugging Face Hub'daki bir depoda bir dosyanın var olup olmadığını kontrol eder.

Örnekler:

>>> from huggingface_hub import file_exists
>>> file_exists("bigcode/starcoder", "config.json")
True
>>> file_exists("bigcode/starcoder", "not-a-file")
False
>>> file_exists("bigcode/not-a-repo", "config.json")
False

get_bucket_file_metadata

< >

( bucket_id: strremote_path: strtoken: str | bool | None = None ) → BucketFileMetadata

Parametreler

  • bucket_id (str) — Kovanın kimliği (ör. "username/my-bucket").
  • remote_path (str) — Dosyanın kovadaki yolu.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

BucketFileMetadata

Boyut ve xet bilgilerini içeren dosya meta verisi.

Bir kovadaki bir dosyanın meta verilerini getirir.

Örnek:

>>> from huggingface_hub import get_bucket_file_metadata
>>> metadata = get_bucket_file_metadata(
...     bucket_id="username/my-bucket",
...     remote_path="models/model.safetensors",
... )
>>> metadata.size
42000

get_bucket_paths_info

< >

( bucket_id: strpaths: Iterable[str]token: str | bool | None = None ) → Iterable[BucketFile]

Parametreler

  • bucket_id (str) — Kovanın kimliği (ör. "username/my-bucket").
  • paths (Iterable[str]) — Bilgi alınacak yollar. Bir yol mevcut değilse, bir istisna fırlatılmadan yoksayılır. Yalnızca dosya yolları desteklenir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[BucketFile]

BucketFile nesnelerinin bir iterable'i olarak yollar hakkında bilgi.

Bir varlığın yolları hakkında bilgi alın.

Çağrılar 1000 yolluk partiler halinde yapılır. Sonuçlar, geldikçe verilir.

Örnek:

>>> from huggingface_hub import get_bucket_paths_info
>>> paths_info = get_bucket_paths_info("username/my-bucket", ["file.txt", "checkpoints/model.safetensors"])
>>> for info in paths_info:
...     print(info)
BucketFile(type='file', path='file.txt', size=2379, xet_hash='96e637d9665bd35477b1908a23f2e254edfba0618dbd2d62f90a6baee7d139cf', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc))
BucketFile(type='file', path='checkpoints/model.safetensors', size=2408828, xet_hash='3ed0e9fefe788ddd61d1e26eba67057e9740a064b009256fbafadf6bb95785ca', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc))

get_collection

< >

( collection_slug: strtoken: bool | str | None = None )

Parametreler

  • collection_slug (str) — Hub koleksiyonunun slug'ı. Örnek: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Hub'daki bir Koleksiyon hakkında bilgi alır.

Dönüş: Collection

Örnek:

>>> from huggingface_hub import get_collection
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")
>>> collection.title
'Recent models'
>>> len(collection.items)
37
>>> collection.items[0]
CollectionItem(
    item_object_id='651446103cd773a050bf64c2',
    item_id='TheBloke/U-Amethyst-20B-AWQ',
    item_type='model',
    position=88,
    note=None
)

get_dataset_leaderboard

< >

( repo_id: strbase_model_only: bool | None = Nonetoken: bool | str | None = Nonetimeout: float | None = None ) → list[DatasetLeaderboardEntry]

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı. Örneğin: "allenai/olmOCR-bench".
  • base_model_only (bool veya None, isteğe bağlı) — Varsayılan olarak, lider tablosu yalnızca beyan edilmiş bir base_model ilişkisi olmayan modelleri (yani kanonik/kök depoları) içerir; bu, Hub’ın varsayılan lider tablosu görünümüyle eşleşir. Ebeveyn model beyan eden ince ayarlanmış veya türev depolar hariç tutulur. Bu filtreyi devre dışı bırakmak ve modelin bir taban model ilişkisi beyan edip etmediğinden bağımsız olarak gönderilen tüm sonuçları dahil etmek için base_model_only=False değerini iletin.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • timeout (float, isteğe bağlı) — Hub'a yapılan istek için bir zaman aşımı ayarlanıp ayarlanmayacağı.

Dönüş değeri

list[DatasetLeaderboardEntry]

Sıralamaya göre sıralanmış, liderlik tablosu girdilerini temsil eden DatasetLeaderboardEntry nesnelerinin listesi.

Hub'daki bir veri setinin lider tablosunu alın.

Sıralama tablosu, modelleri verilen benchmark veri setindeki değerlendirme puanlarına göre sıralar. Tüm veri setlerinin sıralama tabloları yoktur — yalnızca kendilerine değerlendirme sonuçları gönderilen benchmark veri setleri bu özelliğe sahiptir. Bu, puanların veri seti odaklı bir görünümünü sunar; model odaklı bir görünüm için model_info() fonksiyonunu expand=["evalResults"] parametresiyle kullanın.

Aşağıdaki hataları oluşturur:

  • RepositoryNotFoundError Depo bulunamadığında. Bunun nedeni, depoyu oluşturulmamış olması veya private olarak ayarlanmış olması ve erişiminizin olmaması olabilir.
  • HfHubHTTPError Veri setinin bir liderlik tablosu yoksa.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench")
>>> leaderboard[0].model_id
'datalab-to/chandra-ocr-2'
>>> leaderboard[0].rank
1

# Include fine-tuned / derivative models too
>>> full_leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench", base_model_only=False)

get_dataset_tags

< >

( )

Tüm geçerli veri seti etiketlerini iç içe geçmiş bir ad alanı nesnesi olarak listeler.

get_discussion_details

< >

( repo_id: strdiscussion_num: intrepo_type: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • discussion_num (int) — Discussion veya Pull Request numarası. Kesinlikle pozitif bir tam sayı olmalıdır.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Hub'dan bir Tartışma'nın / Birleştirme İsteği'nin ayrıntılarını getirir.

Dönüş: DiscussionWithDetails

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

get_full_repo_name

< >

( model_id: strorganization: str | None = Nonetoken: bool | str | None = None ) → str

Parametreler

  • model_id (str) — Modelin adı.
  • organization (str, isteğe bağlı) — Geçirildiğinde, depo adı kullanıcı ad alanı yerine organizasyon ad alanında olacaktır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

str

Bir organizasyon geçirilmediyse kullanıcının ad alanındaki depo adı ({username}/{model_id}), aksi halde organizasyon ad alanındaki ({organization}/{model_id}).

Belirtilen model kimliği ve isteğe bağlı kuruluş için depo adını döndürür.

get_hf_file_metadata

< >

( url: strtoken: bool | str | None = Nonetimeout: float | None = 10 )

Parametreler

  • url (str) — Dosya url'si, örneğin hf_hub_url() tarafından döndürülen.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • timeout (float, isteğe bağlı, varsayılan 10) — Sunucunun metadata göndermesi için kaç saniye beklenir.

Belirtilen bir URL için Hub'da sürüm kontrolü yapılan bir dosyanın meta verilerini getirir.

get_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parametreler

  • name (str) — Bilgilerinin alınacağı Inference Endpoint'in adı.
  • namespace (str, isteğe bağlı) — Inference Endpoint'in bulunduğu namespace. Varsayılan olarak mevcut kullanıcıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

InferenceEndpoint

istenen Inference Endpoint hakkında bilgi.

Bir Inference Endpoint hakkında bilgi alın.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.get_inference_endpoint("my-text-to-image")
>>> endpoint
InferenceEndpoint(name='my-text-to-image', ...)

# Get status
>>> endpoint.status
'running'
>>> endpoint.url
'https://my-text-to-image.region.vendor.endpoints.huggingface.cloud'

# Run inference
>>> endpoint.client.text_to_image(...)

get_model_tags

< >

( )

Geçerli tüm model etiketlerini iç içe geçmiş bir ad alanı nesnesi olarak listele

get_organization_overview

< >

( organization: strtoken: bool | str | None = None ) → Organization

Parametreler

  • organization (str) — Genel bakış alınacak kuruluşun adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Organization

Kuruluşun genel bakışını içeren bir Organization nesnesi.

Yükseltilen

HTTPError

  • HTTPError — Hub'da organizasyon yoksa HTTP 404.

Hub'da bir kuruluşun genel bakışını alın.

get_paths_info

< >

( repo_id: strpaths: list[str] | strexpand: bool = Falserevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → list[Union[RepoFile, RepoFolder]]

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı.
  • paths (Union[list[str], str], isteğe bağlı) — Bilgi alınacak yollar. Bir yol mevcut değilse, bir istisna fırlatılmadan yok sayılır.
  • expand (bool, isteğe bağlı, varsayılan False) — Yollar hakkında daha fazla bilgi alıp alınmayacağını belirtir (ör. son commit ve dosyaların güvenlik tarama sonuçları). Bu işlem sunucu için daha maliyetli olduğundan sayfa başına yalnızca 50 sonuç döndürülür (1000 yerine). Sayfalama huggingface_hub içinde uygulandığından, sonuçları alma süresi dışında bu durum sizin için şeffaftır.
  • revision (str, isteğe bağlı) — Bilgilerin alınacağı depoyun revizyonu. Varsayılan olarak "main" dalıdır.
  • repo_type (str, isteğe bağlı) — Bilgilerin alınacağı depoyun türü ("model", "dataset" veya "space". Varsayılan değer "model".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

list[Union[RepoFile, RepoFolder]]

Yollar hakkında bilgi, RepoFile ve RepoFolder nesnelerinin bir listesi olarak.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.
  • RevisionNotFoundError — Revizyon depoda bulunamazsa (404 hatası).

Bir depodaki yollar hakkında bilgi alın.

Örnek:

>>> from huggingface_hub import get_paths_info
>>> paths_info = get_paths_info("allenai/c4", ["README.md", "en"], repo_type="dataset")
>>> paths_info
[
    RepoFile(path='README.md', size=2379, blob_id='f84cb4c97182890fc1dbdeaf1a6a468fd27b4fff', lfs=None, last_commit=None, security=None),
    RepoFolder(path='en', tree_id='dc943c4c40f53d02b31ced1defa7e5f438d5862e', last_commit=None)
]

get_repo_discussions

< >

( repo_id: strauthor: str | None = Nonediscussion_type: constants.DiscussionTypeFilter | None = Nonediscussion_status: constants.DiscussionStatusFilter | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterator[Discussion]

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • author (str, isteğe bağlı) — Tartışma yazarına göre filtrelemek için bir değer geçirin. None filtre uygulanmadığı anlamına gelir. Varsayılan değer None'dir.
  • discussion_type (str, isteğe bağlı) — Yalnızca pull request'leri almak için "pull_request", yalnızca tartışmaları almak için "discussion" olarak ayarlayın. İkisini de almak için "all" veya None olarak ayarlayın. Varsayılan değer None'dir.
  • discussion_status (str, isteğe bağlı) — Yalnızca açık (sırasıyla kapalı) tartışmaları almak için "open" (sırasıyla "closed") olarak ayarlayın. Her ikisini de almak için "all" veya None olarak ayarlayın. Varsayılan değer None'dir.
  • repo_type (str, isteğe bağlı) — Bir veri setinden veya uzaydan (space) alınıyorsa "dataset" veya "space" olarak ayarlayın, bir modelden alınıyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterator[Discussion]

Discussion nesnelerinin bir iteratörü.

Verilen depo için Tartışmaları ve Birleştirme İsteklerini getirir.

Örnek:

Bir depodaki tüm tartışmaları bir listede toplama:

>>> from huggingface_hub import get_repo_discussions
>>> discussions_list = list(get_repo_discussions(repo_id="bert-base-uncased"))

Bir repodaki tartışmaları döngüye alma:

>>> from huggingface_hub import get_repo_discussions
>>> for discussion in get_repo_discussions(repo_id="bert-base-uncased"):
...     print(discussion.num, discussion.title)

get_safetensors_metadata

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsRepoMetadata

Parametreler

  • repo_id (str) — Bir kullanıcı veya kuruluş adı ile / ile ayrılmış bir depo adı.
  • repo_type (str, isteğe bağlı) — Dosya bir veri setinde veya uzaydaysa "dataset" veya "space" olarak ayarlayın, bir modeldeyse None veya "model". Varsayılan değer None'dir.
  • revision (str, isteğe bağlı) — Dosyanın alınacağı git revizyonu. Bir dal adı, etiket veya commit hash'i olabilir. Varsayılan olarak "main" dalının başıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • timeout (float, isteğe bağlı, varsayılan 10) — Bir safetensors dosyası başlığı getiren her isteğe aktarılan, sunucunun veri göndermesini bekleme süresi (saniye). Zaman aşımını devre dışı bırakmak için None olarak ayarlayın (önerilmez, çünkü takılan bir bağlantı çağrıyı süresiz olarak asabilir).

Dönüş değeri

SafetensorsRepoMetadata

safetensors deposuyla ilgili bilgiler.

Yükseltilen

NotASafetensorsRepoError veya SafetensorsParsingError

  • NotASafetensorsRepoError — Depo bir safetensors deposu değilse, yani ne model.safetensors ne de model.safetensors.index.json dosyası içeriyorsa.
  • SafetensorsParsingError — Bir safetensors dosyasının başlığı doğru şekilde ayrıştırılamadığında.

Hub'daki bir safetensors deposu için meta verileri ayrıştırın.

Önce repoda tek bir safetensors dosyası olup olmadığına yoksa parçalı (sharded) bir safetensors deposu olup olmadığına bakarız. Tek bir safetensors dosyasıysa, bu dosyadan metadata'yi ayrıştırırız. Parçalı bir safetensors deposuysa, önce index dosyasından metadata'yi, ardından her shard'dan metadata'yi ayrıştırırız.

Tek bir safetensors dosyasından meta verileri ayrıştırmak için parse_safetensors_file_metadata() kullanın. Parçalı bir modelin tüm parça başlıklarını main üzerinde tek bir istekle almak için get_sharded_safetensors_metadata() kullanın.

safetensors formatı hakkında daha fazla ayrıntı için https://huggingface.co/docs/safetensors/index#format adresine göz atın.

Örnek:

# Parse repo with single weights file
>>> metadata = get_safetensors_metadata("bigscience/bloomz-560m")
>>> metadata
SafetensorsRepoMetadata(
    metadata=None,
    sharded=False,
    weight_map={'h.0.input_layernorm.bias': 'model.safetensors', ...},
    files_metadata={'model.safetensors': SafetensorsFileMetadata(...)}
)
>>> metadata.files_metadata["model.safetensors"].metadata
{'format': 'pt'}

# Parse repo with sharded model
>>> metadata = get_safetensors_metadata("bigscience/bloom")
Parse safetensors files: 100%|██████████████████████████████████████████| 72/72 [00:12<00:00,  5.78it/s]
>>> metadata
SafetensorsRepoMetadata(metadata={'total_size': 352494542848}, sharded=True, weight_map={...}, files_metadata={...})
>>> len(metadata.files_metadata)
72  # All safetensors files have been fetched

# Parse repo with sharded model
>>> get_safetensors_metadata("runwayml/stable-diffusion-v1-5")
NotASafetensorsRepoError: 'runwayml/stable-diffusion-v1-5' is not a safetensors repo. Couldn't find 'model.safetensors.index.json' or 'model.safetensors' files.

get_sharded_safetensors_metadata

< >

( repo_id: strfilename: str = 'model.safetensors.index.json'token: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsRepoMetadata

Parametreler

  • repo_id (str) — Bir kullanıcı veya kuruluş adı ile / ile ayrılmış bir depo adı.
  • filename (str, isteğe bağlı) — Depodaki safetensors dizin dosyasının yolu. Varsayılan olarak "model.safetensors.index.json".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • timeout (float, isteğe bağlı, varsayılan 10) — Sunucunun veri göndermesini bekleme süresi (saniye). Veri gelmezse bu süre sonunda denemeden vazgeçilir. Zaman aşımını devre dışı bırakmak için None olarak ayarlayın (önerilmez; takılan bir bağlantı çağrıyı süresiz olarak bekletebilir).

Dönüş değeri

SafetensorsRepoMetadata

get_safetensors_metadata() ile aynı meta veriler.

Hub'daki main dalındaki parçalı safetensors modelinin tüm parçalarının meta verilerini, get_safetensors_metadata()'in her parça başlığını ayrıştırması yerine tek bir istekle alın. Yalnızca Hugging Face Hub.

Örnek:

>>> metadata = get_sharded_safetensors_metadata("HuggingFaceH4/zephyr-7b-beta")
>>> len(metadata.files_metadata)
8

get_space_runtime

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Parametreler

  • repo_id (str) — Güncellenecek depoyun kimliği. Örnek: "bigcode/in-the-stack".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

SpaceRuntime

Bir Space hakkında çalışma zamanı bilgileri, Space aşaması ve donanımı dahil.

Bir Space hakkında çalışma zamanı bilgilerini alır.

get_space_secrets

< >

( repo_id: strtoken: bool | str | None = None ) → dict[str, SpaceSecret]

Parametreler

  • repo_id (str) — Sorgulanacak repozituarın kimliği. Örnek: "bigcode/in-the-stack".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

dict[str, SpaceSecret]

Gizli ad ile anahtarlanan SpaceSecret nesnelerinin sözlüğü.

Bir Uzay'daki tüm gizli bilgileri alır.

Secret değerler yalnızca yazılabilir ve geri okunamaz. Yalnızca anahtar, açıklama ve son güncelleme zamanı döndürülür.

Secrets, bir Space'e gizli anahtarlar veya jetonları bunları kodun içine gömmeden ayarlamayı sağlar. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.get_space_secrets("username/my-space")
{'HF_TOKEN': SpaceSecret(key='HF_TOKEN', description='...', updated_at=datetime.datetime(...))}

get_space_variables

< >

( repo_id: strtoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Sorgulanacak repozituarın kimliği. Örnek: "bigcode/in-the-stack".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir Uzay'daki tüm değişkenleri alır.

Değişkenler, bir Space'e ortam değişkenlerini sabit kodlamadan ayarlamayı sağlar. Daha fazla ayrıntı için bkz. https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

get_user_overview

< >

( username: strtoken: bool | str | None = None ) → User

Parametreler

  • username (str) — Genel bakış alınacak kullanıcının kullanıcı adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

User

Kullanıcının genel bakışını içeren bir User nesnesi.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Kullanıcı Hub'da yoksa HTTP 404.

Hub'da bir kullanıcının genel bakışını alın.

get_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Parametreler

  • webhook_id (str) — Alınacak webhook'un benzersiz tanımlayıcısı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

WebhookInfo

Webhook hakkında bilgi.

Kimliğiyle bir webhook alın.

Örnek:

>>> from huggingface_hub import get_webhook
>>> webhook = get_webhook("654bbbc16f2ec14d77f109cc")
>>> print(webhook)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    secret="my-secret",
    domains=["repo", "discussion"],
    disabled=False,
)

get_zero_gpu_quota

< >

( token: bool | str | None = None ) → ZeroGpuQuota

Parametreler

  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteci kullanır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). İnce taneli bir belirtecin “Billing > Read billing usage and payment method status” izinine sahip olması ve bir OAuth belirtecinin read-billing kapsamına sahip olması gerekir.

Dönüş değeri

ZeroGpuQuota

Kimlik doğrulaması yapılmış kullanıcının ZeroGPU kotası.

Kimlik doğrulaması yapılmış kullanıcının ZeroGPU kota değerini getirir.

Bir uygulamadan, bir ajandan veya bir MCP sunucusundan programatik olarak ZeroGPU Spaces çağrılırken ZeroGPU kullanımını izlemek için faydalıdır. Daha fazla ayrıntı için https://huggingface.co/docs/hub/spaces-zerogpu adresine bakın.

Örnek:

>>> from huggingface_hub import get_zero_gpu_quota
>>> quota = get_zero_gpu_quota()
>>> quota
ZeroGpuQuota(base=2400, remaining=1810, resets_at=datetime.datetime(2026, 9, 30, 9, 12, 3, tzinfo=datetime.timezone.utc), overquota_used=0)
>>> print(f"{quota.remaining / 60:.1f} minutes left")
30.2 minutes left

grant_access

< >

( repo_id: struser: strrepo_type: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Erişim izni verilecek depoyun kimliği.
  • user (str) — Erişim izni verilecek kullanıcının kullanıcı adı.
  • repo_type (str, isteğe bağlı) — Erişim izni verilecek depoyun türü. model, dataset veya space değerlerinden biri olmalıdır. Varsayılan değer model'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Depo gated değilse HTTP 400.
  • HfHubHTTPError — Kullanıcının zaten repoya erişimi varsa HTTP 400.
  • HfHubHTTPError — Depoya yalnızca salt okunur erişiminiz varsa HTTP 403. Deponun ait olduğu organizasyonda write veya admin rolünüz yoksa ya da read belirteci geçirdiyseniz bu durumla karşılaşabilirsiniz.
  • HfHubHTTPError — Kullanıcı Hub'da yoksa HTTP 404.

Belirli bir gated repo için bir kullanıcıya erişim izni verin.

Erişim yetkisi verilmesi, kullanıcının kendi başına bir erişim isteği göndermesini gerektirmez. Kullanıcı, dosyaları indirebileceği kabul edilenler listesine otomatik olarak eklenir. Verilen erişim yetkisini cancel_access_request() veya reject_access_request() kullanarak istediğiniz zaman iptal edebilirsiniz.

Kapalı depolar hakkında daha fazla bilgi için https://huggingface.co/docs/hub/models-gated adresine bakın.

hf_hub_download

< >

( repo_id: strfilename: strsubfolder: str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_dir: str | Path | None = Noneforce_download: bool = Falseetag_timeout: float = 10token: bool | str | None = Nonelocal_files_only: bool = Falsetqdm_class: type[base_tqdm] | None = Nonedry_run: bool = False ) → str or DryRunFileInfo

Parametreler

  • repo_id (str) — Bir kullanıcı veya kuruluş adı ile / ile ayrılmış bir depo adı.
  • filename (str) — Depodaki dosyanın adı.
  • subfolder (str, isteğe bağlı) — Deponun içindeki bir klasöre karşılık gelen isteğe bağlı bir değer.
  • repo_type (str, isteğe bağlı) — Bir veri setinden veya uzaydan indiriliyorsa "dataset" veya "space" olarak ayarlayın, bir modelden indiriliyorsa None veya "model". Varsayılan değer None'dir.
  • revision (str, isteğe bağlı) — Bir dal adı, etiket veya commit hash olabilecek isteğe bağlı bir Git revizyon kimliği.
  • cache_dir (str, Path, isteğe bağlı) — Önbelleğe alınan dosyaların saklandığı klasörün yolu.
  • local_dir (str veya Path, isteğe bağlı) — Verilirse, indirilen dosya bu dizinin altına yerleştirilir.
  • force_download (bool, isteğe bağlı, varsayılan False) — Dosya, yerel önbellekte zaten mevcut olsa bile indirilip indirilmeyeceği.
  • etag_timeout (float, isteğe bağlı, varsayılan 10) — ETAG alınırken, httpx2.request'e iletilen, sunucunun veri göndermesini bekleme süresi (saniye).
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • local_files_only (bool, isteğe bağlı, varsayılan False) — True ise, dosyanın indirilmesini engeller ve varsa yerel önbellekteki dosyanın yolunu döndürür.
  • tqdm_class (tqdm, isteğe bağlı) — Verilirse, ilerleme çubuğu için varsayılan davranışı yazar. Geçirilen argüman tqdm.auto.tqdm sınıfından türetmeli veya en azından davranışını taklit etmelidir. Varsayılan olarak, HF_HUB_DISABLE_PROGRESS_BARS ortam değişkenini ayarlayarak devre dışı bırakılabilen özel HF ilerleme çubuğu kullanılır.
  • dry_run (bool, isteğe bağlı, varsayılan False) — True ise, dosyayı gerçekten indirmeden kuru bir çalışma (dry run) gerçekleştirir. İndirilecek olanlarla ilgili bilgileri içeren bir DryRunFileInfo nesnesi döndürür.

Dönüş değeri

str veya DryRunFileInfo

  • dry_run=False ise: Dosyanın yerel yolu veya ağ kapalıysa, diskte önbelleğe alınmış dosyanın son sürümü.
  • dry_run=True ise: İndirme bilgilerini içeren bir DryRunFileInfo nesnesi.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError veya ~utils.RemoteEntryNotFoundError veya LocalEntryNotFoundError veya EnvironmentError veya OSError veya ValueError

  • RepositoryNotFoundError — İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.
  • RevisionNotFoundError — İndirilecek revizyon bulunamadığında.
  • ~utils.RemoteEntryNotFoundError — İndirilecek dosya bulunamadığında.
  • LocalEntryNotFoundError — Ağ devre dışı bırakıldı veya kullanılamıyor ve dosya önbellekte bulunamıyorsa.
  • EnvironmentError — token=True ise ancak token bulunamazsa.
  • OSError — ETTag belirlenemezse.
  • ValueError — Bazı parametre değeri geçersizse.

Yerel önbellekte henüz yoksa verilen dosyayı indirir.

Yeni önbellek dosya düzeni şu şekildedir:

  • Önbellek dizini, repo_id başına bir alt klasör içerir (repo türüne göre ad alanılandırılmıştır)
  • her depo klasörünün içinde:
    • refs, bilinen en son revizyon => commit_hash çiftlerinin bir listesidir
    • blobs, LFS dosyaları olup olmadığına bağlı olarak git-sha veya sha256 ile tanımlanan) gerçek dosya bloblarını içerir
    • snapshots, her commit için bir alt klasör içerir; her “commit”, o belirli commit’te çözümlenmiş dosyaların alt kümesini barındırır. Her dosya adı, o belirli commit’teki blob’a giden bir sembolik bağlantıdır.
[  96]  .
└── [ 160]  models--julien-c--EsperBERTo-small
    ├── [ 160]  blobs
    │   ├── [321M]  403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
    │   ├── [ 398]  7cb18dc9bafbfcf74629a4b760af1b160957a83e
    │   └── [1.4K]  d7edf6bd2a681fb0175f7735299831ee1b22b812
    ├── [  96]  refs
    │   └── [  40]  main
    └── [ 128]  snapshots
        ├── [ 128]  2439f60ef33a0d46d85da5001d52aeda5b00ce9f
        │   ├── [  52]  README.md -> ../../blobs/d7edf6bd2a681fb0175f7735299831ee1b22b812
        │   └── [  76]  pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
        └── [ 128]  bbc77c8132af1cc5cf678da3f1ddf2de43606d48
            ├── [  52]  README.md -> ../../blobs/7cb18dc9bafbfcf74629a4b760af1b160957a83e
            └── [  76]  pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd

local_dir sağlanırsa, depodaki dosya yapısı bu konumda yeniden oluşturulur. Bu seçeneği kullanırken cache_dir kullanılmaz ve indirilen dosyalarla ilgili bazı meta verileri depolamak için local_dir kökünde bir .cache/huggingface/ klasörü oluşturulur. Bu mekanizma ana önbellek sistemi kadar sağlam olmasa da, bir deponun en son sürümünü düzenli olarak çekmek için optimize edilmiştir.

gizle_yorum

< >

( repo_id: strdiscussion_num: intcomment_id: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • discussion_num (int) — Discussion veya Pull Request numarası. Kesinlikle pozitif bir tam sayı olmalıdır.
  • comment_id (str) — Düzenlenecek yorumun kimliği.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

TartışmaYorumu

gizli yorum

Bir Tartışma / Çekme İsteği'ndeki yorumu gizler.

Gizli yorumların içeriği artık alınamaz. Bir yorumu gizlemek geri alınamaz.

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

inspect_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • job_id (str) — Job'un kimliği.
  • namespace (str, isteğe bağlı) — Job'un çalıştığı namespace. Varsayılan olarak kullanıcının mevcut namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında bir hesaplama işini inceleyin.

Örnek:

>>> from huggingface_hub import inspect_job, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
>>> inspect_job(job_id=job.id)
JobInfo(
    id='68780d00bbe36d38803f645f',
    created_at=datetime.datetime(2025, 7, 16, 20, 35, 12, 808000, tzinfo=datetime.timezone.utc),
    docker_image='python:3.12',
    space_id=None,
    command=['python', '-c', "print('Hello from HF compute!')"],
    arguments=[],
    environment={},
    secrets={},
    flavor='cpu-basic',
    status=JobStatus(stage='RUNNING', message=None)
)

inspect_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • scheduled_job_id (str) — Planlanan Job'un kimliği.
  • namespace (str, isteğe bağlı) — Planlanan Job'un bulunduğu namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında planlanmış bir hesaplama İşini denetleyin.

Örnek:

>>> from huggingface_hub import inspect_scheduled_job, create_scheduled_job
>>> scheduled_job = create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly")
>>> inspect_scheduled_job(scheduled_job_id=scheduled_job.id)

kernel_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonetoken: bool | str | None = None ) → ModelInfo

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı.
  • revision (str, isteğe bağlı) — Bilgilerin alınacağı çekirdek deposunun revizyonu.
  • timeout (float, isteğe bağlı) — Hub'a yapılan istek için bir zaman aşımı ayarlanıp ayarlanmayacağı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

ModelInfo

Çekirdek deposu bilgileri.

huggingface.co'daki belirli bir çekirdeğin bilgilerini alın.

list_accepted_access_requests

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Parametreler

  • repo_id (str) — Erişim isteklerinin alınacağı repozituarın kimliği.
  • repo_type (str, isteğe bağlı) — Erişim isteklerinin alınacağı repoyu türü. model, dataset veya space değerlerinden biri olmalıdır. Varsayılan değer model'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[AccessRequest]

AccessRequest nesnelerinden oluşan bir iterable. Her öğe bir username, request_id, email, status ve timestamp özniteliği içerir. Gated repo özel bir form içeriyorsa, fields özniteliği kullanıcının yanıtlarıyla doldurulur.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Depo gated değilse HTTP 400.
  • HfHubHTTPError — Depoya yalnızca salt okunur erişiminiz varsa HTTP 403. Deponun ait olduğu organizasyonda write veya admin rolünüz yoksa ya da read belirteci geçirdiyseniz bu durumla karşılaşabilirsiniz.

Belirli bir gated repo için kabul edilen erişim isteklerini alın.

Kabul edilen bir istek, kullanıcının repoya erişim talep ettiğini ve bu talebin kabul edildiğini ifade eder. Kullanıcı, repodaki herhangi bir dosyayı indirebilir. Onay modu otomatikse, bu liste varsayılan olarak tüm istekleri içermelidir. Kabul edilen istekler, cancel_access_request() ve reject_access_request() kullanılarak herhangi bir zamanda iptal edilebilir veya reddedilebilir. İptal edilen bir istek bekleyen listeye geri dönerken, reddedilen bir istek reddedilen listeye geçer. Her iki durumda da kullanıcının repoya erişimi sona erer.

Kapalı depolar hakkında daha fazla bilgi için https://huggingface.co/docs/hub/models-gated adresine bakın.

Örnek:

>>> from huggingface_hub import list_accepted_access_requests

>>> requests = list(list_accepted_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='accepted',
        fields=None,
    ),
    ...
]

list_bucket_tree

< >

( bucket_id: strprefix: str | None = Nonerecursive: bool | None = Nonetoken: str | bool | None = None ) → Iterable[Union[BucketFile, BucketFolder]]

Parametreler

  • bucket_id (str) — Kovanın kimliği (ör. "username/my-bucket").
  • prefix (str, isteğe bağlı) — Sonuçları, yolu bu önekle başlayan dosyalara daraltır.
  • recursive (bool, isteğe bağlı) — True ise, dosyaları özyinelemeli olarak listeler. False ise (varsayılan), yalnızca kök dizindeki dosyaları ve dizinleri listeler.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[Union[BucketFile, BucketFolder]]

Dosya ve dizin bilgilerini (yol vb.) içeren BucketFile ve BucketFolder nesnelerinden oluşan bir iterable

Bir kovadaki dosyaları listele.

Örnek:

>>> from huggingface_hub import list_bucket_tree
>>> for file_info in list_bucket_tree(bucket_id="username/my-bucket"):
...     print(file_info.path)

>>> # Filter by prefix
>>> for file_info in list_bucket_tree(bucket_id="username/my-bucket", prefix="models/"):
...     print(file_info.path)

list_buckets

< >

( namespace: str | None = Nonesearch: str | None = Nonetoken: bool | str | None = None ) → Iterable[BucketInfo]

Parametreler

  • namespace (str, isteğe bağlı) — Bu ad alanı (kullanıcı veya kuruluş) altındaki varlık gruplarını listeler. Varsayılan olarak kullanıcının varlık gruplarını listeler.
  • search (str, isteğe bağlı) — Kova adlarını filtrelemek için bir arama dizesi.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[BucketInfo]

BucketInfo nesnelerinden oluşan bir iterable.

Belirli bir ad alanı altında Hub'daki varlıkları listeler.

Örnek:

>>> from huggingface_hub import list_buckets
>>> for bucket in list_buckets(): # lists buckets in the user's namespace
...     print(bucket)

>>> for bucket in list_buckets(namespace="huggingface"): # lists buckets in the "huggingface" organization
...     print(bucket)

>>> for bucket in list_buckets(search="my-prefix"): # filter buckets by name
...     print(bucket)

list_collections

< >

( owner: list[str] | str | None = Noneitem: list[str] | str | None = Nonesort: CollectionSort_T | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → Iterable[Collection]

Parametreler

  • owner (list[str] veya str, isteğe bağlı) — Sahibin kullanıcı adına göre filtrele.
  • item (list[str] veya str, isteğe bağlı) — Belirli öğeler içeren koleksiyonları filtreler. Örnek: "models/teknium/OpenHermes-2.5-Mistral-7B", "datasets/squad" veya "papers/2311.12983".
  • sort (Literal["lastModified", "trending", "upvotes"], isteğe bağlı) — Koleksiyonları son değiştirilme zamanına, trende olanlara veya oy sayısına göre sıralar.
  • limit (int, isteğe bağlı) — Dönülecek koleksiyonların maksimum sayısı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[Collection]

Collection nesnelerinden oluşan bir iterable.

Bazı filtreler verildiğinde Huggingface Hub'daki koleksiyonları listeler.

Koleksiyonları listelerken, koleksiyon başına öğe listesi en fazla 4 öğeyle sınırlıdır. Bir koleksiyondaki tüm öğeleri almak için get_collection() kullanmanız gerekir.

list_daily_papers

< >

( date: str | None = Nonetoken: bool | str | None = Noneweek: str | None = Nonemonth: str | None = Nonesubmitter: str | None = Nonesort: DailyPapersSort_T | None = Nonep: int | None = Nonelimit: int | None = None ) → Iterable[PaperInfo]

Parametreler

  • date (str, isteğe bağlı) — Günlük makalelerin getirileceği ISO biçiminde (YYYY-AA-GG) tarih. Varsayılan olarak en güncelleri getirilir.
  • token (Union[bool, str, None], isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • week (str, isteğe bağlı) — Günlük makalelerin alınacağı ISO biçimindeki hafta (YYYY-Www). Örnek: 2025-W09.
  • month (str, isteğe bağlı) — Günlük makalelerin getirileceği ay, ISO biçiminde (YYYY-MM). Örnek: 2025-02.
  • submitter (str, isteğe bağlı) — Günlük makaleleri filtrelemek için göndericinin kullanıcı adı.
  • sort (Literal["publishedAt", "trending"], isteğe bağlı) — Günlük makaleler için sıralama düzeni. publishedAt veya trending olarak ayarlanabilir. Varsayılan değer "publishedAt"
  • p (int, isteğe bağlı) — Sayfalama için sayfa numarası. Varsayılan değeri 0'dır.
  • limit (int, isteğe bağlı) — Alınacak makalelerin sınırı. Varsayılan değer 50'dir.

Dönüş değeri

Iterable[PaperInfo]

huggingface_hub.hf_api.PaperInfo nesnelerinden oluşan bir iterable.

Hugging Face Hub'da belirli bir tarihte yayımlanan günlük makaleleri listeler.

Örnek:

>>> from huggingface_hub import HfApi

>>> api = HfApi()
>>> list(api.list_daily_papers(date="2025-10-29"))

list_dataset_parquet_files

< >

( repo_id: strconfig: str | None = Nonetoken: bool | str | None = None ) → list[DatasetParquetEntry]

Parametreler

  • repo_id (str) — Veri seti deposu kimliği (ör. "username/dataset-name").
  • config (str, isteğe bağlı) — Belirli bir yapılandırma/alt küme adına göre filtrele. Verildiğinde, yalnızca o yapılandırma için parquet dosyaları döndürülür.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

list[DatasetParquetEntry]

her parquet dosyası için yapılandırma, bölme, URL ve boyut içeren DatasetParquetEntry nesnelerinin listesi

Hub'daki bir veri seti için kullanılabilir parquet dosyalarını listeler.

Hub'da barındırılan tüm veri setleri Dataset Viewer tarafından otomatik olarak Parquet'e dönüştürülür. Bu yöntem, parquet dosyalarının URL'lerini, yapılandırmalarını, bölümlerini ve boyutlarını içeren listeyi döndürür.

Örnek:

>>> from huggingface_hub import list_dataset_parquet_files
>>> list_dataset_parquet_files("lhoestq/demo1")
>>> entries[0]
DatasetParquetEntry(config='default', split='train', url='https://huggingface.co/...', size=5038)

list_datasets

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Nonebenchmark: Literal[True] | Literal['official'] | str | None = Nonedataset_name: str | None = Nonegated: bool | None = Nonelanguage_creators: str | list[str] | None = Nonelanguage: str | list[str] | None = Nonemultilinguality: str | list[str] | None = Nonesize_categories: str | list[str] | None = Nonetask_categories: str | list[str] | None = Nonetask_ids: str | list[str] | None = Nonesearch: str | None = Nonesort: DatasetSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandDatasetProperty_T] | None = Nonefull: bool | None = Nonetoken: bool | str | None = None ) → Iterable[DatasetInfo]

Parametreler

  • filter (str veya Iterable[str], isteğe bağlı) — Hub'daki veri setlerini filtrelemek için bir dize veya dize listesi.
  • author (str, isteğe bağlı) — Dönen veri setlerinin yazarını tanımlayan bir dize.
  • benchmark (True, "official", str, isteğe bağlı) — Veri setlerini benchmark'a göre filtreler. Resmi benchmark veri setlerini döndürmek için True veya "official" olabilir. Gelecekteki uyumluluk için, benchmark adını temsil eden bir dize de olabilir (şu anda yalnızca “official” desteklenmektedir).
  • dataset_name (str, isteğe bağlı) — Hub'da adıyla veri setlerini tanımlamak için kullanılabilen bir dize veya dize listesi, örneğin SQAC veya wikineural
  • gated (bool, isteğe bağlı) — Hub'daki veri setlerini kapılı veya kapısız olarak filtrelemek için bir boole değeri. Varsayılan olarak tüm veri setleri döndürülür. gated=True geçirilirse, yalnızca kapılı veri setleri döndürülür. gated=False geçirilirse, yalnızca kapısız veri setleri döndürülür.
  • language_creators (str veya List, isteğe bağlı) — Hub'daki veri setlerini, verilerin nasıl derlendiğini belirten crowdsourced veya machine_generated gibi etiketlerle tanımlamak için kullanılan bir dize veya dize listesi.
  • language (str veya List, isteğe bağlı) — Hub'da veri setlerini filtrelemek için iki karakterli bir dili temsil eden bir dize veya dize listesi.
  • multilinguality (str veya List, isteğe bağlı) — Birden fazla dil içeren veri setleri için bir filtre temsil eden bir dize veya dize listesi.
  • size_categories (str veya List, isteğe bağlı) — Hub'da veri kümelerini, veri kümesinin boyutuna göre tanımlamak için kullanılabilen bir dize veya dize listesi; örneğin 100K<n<1M veya 1M<n<10M.
  • task_categories (str veya List, isteğe bağlı) — Hub'da veri setlerini tasarlanmış görevle tanımlamak için kullanılabilen bir dize veya dize listesi, örneğin audio_classification veya named_entity_recognition.
  • task_ids (str veya List, isteğe bağlı) — Hub'da veri setlerini speech_emotion_recognition veya paraphrase gibi belirli bir görevle tanımlamak için kullanılabilen bir dize veya dize listesi.
  • search (str, isteğe bağlı) — Dönütlenen veri setlerinde yer alacak bir dize.
  • sort (DatasetSort_T, opsiyonel) — Sonuç veri kümelerini sıralamak için kullanılan anahtar. Olası değerler “created_at”, “downloads”, “last_modified”, “likes” ve “trending_score” şeklindedir.
  • limit (int, isteğe bağlı) — Alınacak veri setlerinin sayısına uygulanan sınır. Bu seçeneği None olarak bırakmak, tüm veri setlerinin alınmasını sağlar.
  • expand (list[ExpandDatasetProperty_T], isteğe bağlı) — Yanıtta döndürülecek özelliklerin listesi. Kullanıldığında, yalnızca listedeki özellikler döndürülür. full parametresi geçirildiğinde bu parametre kullanılamaz. Olası değerler "author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "lastModified", "likes", "mainSize", "paperswithcode_id", "private", "siblings", "sha", "tags", "trendingScore", "usedStorage" ve "resourceGroup"'dür.
  • full (bool, isteğe bağlı) — Son düzenleme zamanı olan last_modified, card_data ve dosyalar dahil olmak üzere veri setinin tüm verilerinin getirilip getirilmeyeceğini belirtir. PapersWithCode kimliği gibi faydalı bilgiler içerebilir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[DatasetInfo]

huggingface_hub.hf_api.DatasetInfo nesnelerinden oluşan bir yineleyici.

Bazı filtreler verildiğinde, Huggingface Hub'da barındırılan veri setlerini listeler.

filter argümanı ile kullanım örneği:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all datasets
>>> api.list_datasets()


# List only the text classification datasets
>>> api.list_datasets(filter="task_categories:text-classification")


# List only the datasets in russian for language modeling
>>> api.list_datasets(
...     filter=("language:ru", "task_ids:language-modeling")
... )

# List FiftyOne datasets (identified by the tag "fiftyone" in dataset card)
>>> api.list_datasets(filter="fiftyone")

search argümanı ile kullanım örneği:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all datasets with "text" in their name
>>> api.list_datasets(search="text")

# List all datasets with "text" in their name made by google
>>> api.list_datasets(search="text", author="google")

list_inference_catalog

< >

( accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = Noneengine: Literal['llamacpp', 'sglang', 'tei', 'vllm'] | str | None = Nonelicense: str | None = Nonetask: str | None = Nonesearch: str | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → list[InferenceCatalogModel]

Parametreler

  • accelerator (str, isteğe bağlı) — Yalnızca bu hızlandırıcı için ("cpu", "gpu" veya "neuron") bir tarifi olan modelleri döndürür.
  • engine (str, isteğe bağlı) — Yalnızca bu çıkarım motoru için bir tarifi olan modelleri döndürür (ör. "vllm", "llamacpp", "tei", "sglang").
  • license (str, isteğe bağlı) — Yalnızca bu lisansa sahip modelleri döndür (ör. "Apache 2.0").
  • task (str, isteğe bağlı) — Yalnızca bu görev için modelleri döndür (ör. "text-generation").
  • search (str, isteğe bağlı) — Yalnızca bu arama sorgusuyla eşleşen modelleri döndürür.
  • limit (int, isteğe bağlı) — Dönülecek en fazla model sayısı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication).

Dönüş değeri

list[InferenceCatalogModel]

Katalogda mevcut modeller, her biri test edilmiş tarifleriyle birlikte.

Hugging Face Inference Catalog'da kullanılabilir modelleri listeler.

Inference Catalog'un amacı, çıkarım için optimize edilmiş ve varsayılan yapılandırmaları test edilmiş modellerin küratörlü bir listesini sağlamaktır. Katalogdaki mevcut modellerin listesini https://huggingface.co/static-proxy/endpoints.huggingface.co/catalog adresinde bulabilirsiniz.

Katalogdan bir model veya tarif dağıtmak için create_inference_endpoint_from_catalog() kullanın.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> catalog = api.list_inference_catalog(task="text-generation", accelerator="neuron")
>>> [(model.repo_id, [recipe.id for recipe in model.recipes]) for model in catalog]
[('meta-llama/Llama-3.1-8B-Instruct', ['sizzling-biryani-g4xsi1ac', 'artisanal-quinoa-yz9ynamx']), ...]

list_inference_catalog deneyseldir. API'si gelecekte değişiklik gösterebilir. Öneri veya talepleriniz varsa lütfen geri bildirimde bulunun.

list_inference_endpoints

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → listInferenceEndpoint

Parametreler

  • namespace (str, isteğe bağlı) — Listelenecek uç noktalar için namespace. Varsayılan olarak mevcut kullanıcıdır. Kullanıcının ait olduğu tüm namespace'lerden (yani kişisel namespace ve tüm organizasyonlar) tüm uç noktaları listelemek için "*" olarak ayarlayın.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

listInferenceEndpoint

Belirtilen ad alanı için tüm çıkarım uç noktalarının listesi.

Belirtilen ad alanı için tüm çıkarım uç noktalarını listeler.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.list_inference_endpoints()
[InferenceEndpoint(name='my-endpoint', ...), ...]

list_inference_endpoints_hardware

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → list[InferenceEndpointHardware]

Parametreler

  • namespace (str, isteğe bağlı) — Listelenecek kullanılabilir donanım ve hızlandırıcı kotasına sahip namespace. Varsayılan olarak mevcut kullanıcıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication).

Dönüş değeri

list[InferenceEndpointHardware]

Her satıcı ve bölgede mevcut olan donanımlar, şu anda kullanılamayan veya kullanımdan kaldırılmış donanımlar dahil.

Bir Inference Endpoint'ü dağıtmak için kullanılabilir donanımları listeler.

Her kayıt, create_inference_endpoint() tarafından beklenen tam vendor, region, accelerator, instance_type ve instance_size değerlerini, ayrıca ad alanının fiyatını ve hızlandırıcı kota değerini içerir.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> hardware = api.list_inference_endpoints_hardware()
>>> [hw.id for hw in hardware if hw.accelerator == "gpu" and hw.status == "available"]
['aws-us-east-1-nvidia-l4-x1', 'aws-us-east-1-nvidia-l4-x4', ...]

list_jobs

< >

( status: list[JobStage | str] | JobStage | str | None = Nonelabels: dict[str, str] | None = Nonetimeout: int | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → Iterable[JobInfo]

Parametreler

  • status (JobStage, str veya list, isteğe bağlı) — Yalnızca verilen durum(lar)a sahip İşleri döndürür, örn. "RUNNING" veya [JobStage.RUNNING, JobStage.SCHEDULING]. Olası değerler için JobStage bölümüne bakın.
  • labels (dict[str, str], isteğe bağlı) — Yalnızca verilen tüm key=value etiketlerine sahip İşleri döndürür, örneğin {"env": "prod", "team": "ml"}.
  • timeout (float, isteğe bağlı) — Hub'a yapılan istek için bir zaman aşımı ayarlanıp ayarlanmayacağı.
  • namespace (str, isteğe bağlı) — İşlerin listelendiği namespace. Varsayılan olarak kullanıcının mevcut namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

Iterable[JobInfo]

JobInfo nesnelerinden oluşan bir iterable.

Hugging Face altyapısında hesaplamalı işleri listele.

list_jobs_hardware

< >

( token: bool | str | None = None ) → list[JobHardwareInfo]

Dönüş değeri

list[JobHardwareInfo]

Kullanılabilir donanım yapılandırmalarının listesi.

Hugging Face altyapısındaki İşler için kullanılabilir donanım seçeneklerini listeler.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> hardware_list = api.list_jobs_hardware()
>>> hardware_list[0]
JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ephemeral_storage='20 GB', accelerator=None, unit_cost_micro_usd=167, unit_cost_usd=0.000167, unit_label='minute')
>>> hardware_list[0].name
'cpu-basic'

# Filter GPU options
>>> gpu_hardware = [hw for hw in hardware_list if hw.accelerator is not None]
>>> gpu_hardware[0].accelerator.model
'T4'

list_lfs_files

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[LFSFileInfo]

Parametreler

  • repo_id (str) — LFS dosyalarını listelediğiniz depo.
  • repo_type (str, isteğe bağlı) — Depo türü. Bir veri setinden veya uzaydan listeleniyorsa "dataset" veya "space" olarak ayarlayın, bir modelden listeleniyorsa None veya "model" olarak ayarlayın. Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[LFSFileInfo]

LFSFileInfo nesnelerinin bir iteratörü.

Hub'daki bir depodaki tüm LFS dosyalarını listeler.

Bu, bir reponun ne kadar depolama alanı kullandığını saymak ve büyük dosyaları permanently_delete_lfs_files() ile temizlemek için başlıca olarak faydalıdır. Dikkat edin, bu kalıcı bir eylemdir; silinen dosyalara atıfta bulunan tüm commit'leri etkileyecek ve geri alınamayacaktır.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)

list_liked_repos

< >

( user: str | None = Nonetoken: bool | str | None = None ) → UserLikes

Parametreler

  • user (str, isteğe bağlı) — Beğenileri almak istediğiniz kullanıcının adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

UserLikes

kullanıcı adını ve 3 depo kimliği listesini (1'i modeller için, 1'i veri kümeleri için ve 1'i Spaces için) içeren nesne.

Yükseltilen

ValueError

  • ValueError — user geçirilmediyse ve hiçbir token bulunamazsa (argümandan veya makineden).

huggingface.co'da bir kullanıcının beğendiği tüm herkese açık depoları listeler.

Bu liste herkese açıktır, bu nedenle token isteğe bağlıdır. user geçirilmezse, oturum açmış kullanıcı varsayılan olarak kullanılır.

Ayrıca unlike() bkz.

Örnek:

>>> from huggingface_hub import list_liked_repos

>>> likes = list_liked_repos("julien-c")

>>> likes.user
"julien-c"

>>> likes.models
["osanseviero/streamlit_1.15", "Xhaheen/ChatGPT_HF", ...]

list_models

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Noneapps: str | list[str] | None = Nonegated: bool | None = Noneinference: Literal['warm'] | None = Noneinference_provider: Literal['all'] | PROVIDER_T | list[PROVIDER_T] | None = Nonetrained_dataset: str | list[str] | None = Nonesearch: str | None = Nonepipeline_tag: str | None = Nonenum_parameters: str | None = Noneemissions_thresholds: tuple[float, float] | None = Nonesort: ModelSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandModelProperty_T] | None = Nonefull: bool | None = NonecardData: bool = Falsefetch_config: bool = Falsetoken: bool | str | None = None ) → Iterable[ModelInfo]

Parametreler

  • filter (str veya Iterable[str], isteğe bağlı) — Hub'daki modelleri filtrelemek için bir dize veya dize listesi. Modeller; kütüphane, dil, görev, etiketler ve daha fazlasına göre filtrelenebilir.
  • author (str, isteğe bağlı) — Dönen modellerin yazarını (kullanıcı veya kuruluşu) tanımlayan bir dize.
  • apps (str veya List, isteğe bağlı) — Hub'daki modelleri, belirtilen uygulamaları destekleyenler arasında filtrelemek için bir dize veya dize listesi. Örnek değerler arasında "ollama" veya ["ollama", "vllm"] bulunur.
  • gated (bool, isteğe bağlı) — Hub'daki modellerin gated olup olmadığına göre filtrelemek için bir boolean. Varsayılan olarak tüm modeller döndürülür. gated=True geçirilirse, yalnızca gated modeller döndürülür. gated=False geçirilirse, yalnızca gated olmayan modeller döndürülür.
  • inference (Literal["warm"], isteğe bağlı) — “warm” ise, Hub'da şu anda en az bir sağlayıcı tarafından sunulan modelleri filtreler.
  • inference_provider (Literal["all"] veya str, isteğe bağlı) — Hub'daki belirli bir sağlayıcı tarafından sunulan modelleri filtrelemek için bir dize. En az bir sağlayıcı tarafından sunulan tüm modelleri almak için "all" değerini iletin.
  • trained_dataset (str veya List, isteğe bağlı) — Hub'daki bir modelin eğitim verisi için bir dize etiketi veya dize etiketleri listesi.
  • search (str, isteğe bağlı) — Dönen model kimliklerinde yer alacak bir dize.
  • pipeline_tag (str, isteğe bağlı) — Hub'daki modelleri filtrelemek için kullanılacak bir dize pipeline etiketi, örneğin summarization.
  • num_parameters (str, isteğe bağlı) — Modelleri parametre sayısına göre filtreler. Hub arayüzü ve API'siyle aynı aralık sözdizimini kabul eder, örneğin "min:6B,max:128B", "min:6B" veya "max:128B".
  • emissions_thresholds (Tuple, isteğe bağlı) — Sonuç olarak elde edilen modelleri gram cinsinden filtrelemek için minimum ve maksimum karbon ayak izini temsil eden iki tam sayıdan veya ondalık sayıdan oluşan bir demet.
  • sort (ModelSort_T, isteğe bağlı) — Sonuç modelleriyle sıralamak için kullanılan anahtar. Olası değerler “created_at”, “downloads”, “last_modified”, “likes” ve “trending_score” şeklindedir.
  • limit (int, isteğe bağlı) — Alınacak model sayısına uygulanan sınır. Bu seçeneği None olarak bırakmak tüm modelleri alır.
  • expand (list[ExpandModelProperty_T], isteğe bağlı) — Yanıtta döndürülecek özelliklerin listesi. Kullanıldığında, yalnızca listedeki özellikler döndürülür. Bu parametre, full, cardData veya fetch_config geçirildiğinde kullanılamaz. Olası değerler "author", "cardData", "config", "createdAt", "disabled", "downloads", "downloadsAllTime", "evalResults", "gated", "gguf", "inference", "inferenceProviderMapping", "lastModified", "library_name", "likes", "mask_token", "model-index", "pipeline_tag", "private", "safetensors", "sha", "siblings", "spaces", "tags", "transformersInfo", "trendingScore", "widgetData" ve "resourceGroup"'tür.
  • full (bool, isteğe bağlı) — last_modified, sha, dosyalar ve tags dahil olmak üzere tüm model verilerinin getirilip getirilmeyeceğini belirtir. Filtre kullanıldığında bu değer varsayılan olarak True olarak ayarlanır.
  • cardData (bool, isteğe bağlı) — Modelin meta verilerinin de alınmasını belirtir. Karbon emisyonları, metrikler ve eğitimde kullanılan veri setleri gibi faydalı bilgiler içerebilir.
  • fetch_config (bool, isteğe bağlı) — Model yapılandırmalarının da getirilip getirilmeyeceğini belirtir. Bu, boyutu nedeniyle full içinde yer almaz.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[ModelInfo]

huggingface_hub.hf_api.ModelInfo nesnelerinden oluşan bir yineleyici.

Bazı filtreler verildiğinde, Huggingface Hub üzerinde barındırılan modelleri listeler.

Örnek:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all models
>>> api.list_models()

# List text classification models
>>> api.list_models(filter="text-classification")

# List models from the KerasHub library
>>> api.list_models(filter="keras-hub")

# List models served by Cohere
>>> api.list_models(inference_provider="cohere")

# List models with "bert" in their name
>>> api.list_models(search="bert")

# List models with "bert" in their name and pushed by google
>>> api.list_models(search="bert", author="google")

# List models with 6B to 128B parameters
>>> api.list_models(num_parameters="min:6B,max:128B", sort="likes")

list_organization_followers

< >

( organization: strtoken: bool | str | None = None ) → Iterable[User]

Parametreler

  • organization (str) — Takipçilerinin alınacağı organizasyonun adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[User]

Organizasyonun takipçilerini içeren User nesnelerinin listesi.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Hub'da organizasyon yoksa HTTP 404.

Hub'da bir kuruluşun takipçilerini listele.

list_organization_members

< >

( organization: strtoken: bool | str | None = None ) → Iterable[User]

Parametreler

  • organization (str) — Üyelerinin alınacağı organizasyonun adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[User]

Organizasyonun üyelerini içeren User nesnelerinin listesi.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Hub'da organizasyon yoksa HTTP 404.

Hub'daki bir organizasyonun üyelerinin listesi.

list_papers

< >

( query: str | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → Iterable[PaperInfo]

Parametreler

  • query (str, isteğe bağlı) — Makaleleri bulmak için bir arama sorgu dizesi. Sağlanırsa, sorguyla eşleşen makaleleri döndürür.
  • limit (int, isteğe bağlı) — Dönülecek makalelerin maksimum sayısı.
  • token (Union[bool, str, None], isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[PaperInfo]

huggingface_hub.hf_api.PaperInfo nesnelerinden oluşan bir iterable.

Bir arama sorgusu verildiğinde Hugging Face Hub'daki günlük makaleleri listeler.

Örnek:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all papers with "attention" in their title
>>> api.list_papers(query="attention")

list_pending_access_requests

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Parametreler

  • repo_id (str) — Erişim isteklerinin alınacağı repozituarın kimliği.
  • repo_type (str, isteğe bağlı) — Erişim isteklerinin alınacağı repoyu türü. model, dataset veya space değerlerinden biri olmalıdır. Varsayılan değer model'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[AccessRequest]

AccessRequest nesnelerinden oluşan bir iterable. Her öğe bir username, request_id, email, status ve timestamp özniteliği içerir. Gated repo özel bir form içeriyorsa, fields özniteliği kullanıcının yanıtlarıyla doldurulur.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Depo gated değilse HTTP 400.
  • HfHubHTTPError — Depoya yalnızca salt okunur erişiminiz varsa HTTP 403. Deponun ait olduğu organizasyonda write veya admin rolünüz yoksa ya da read belirteci geçirdiyseniz bu durumla karşılaşabilirsiniz.

Belirli bir gated repo için bekleyen erişim isteklerini alın.

Bekleyen bir istek, kullanıcının repoya erişim istediğini ancak isteğin henüz işlenmediğini ifade eder. Onay modu otomatikse, bu liste boş olmalıdır. Bekleyen istekler accept_access_request() ve reject_access_request() kullanılarak kabul edilebilir veya reddedilebilir.

Kapalı depolar hakkında daha fazla bilgi için https://huggingface.co/docs/hub/models-gated adresine bakın.

Örnek:

>>> from huggingface_hub import list_pending_access_requests, accept_access_request

# List pending requests
>>> requests = list(list_pending_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='pending',
        fields=None,
    ),
    ...
]

# Accept Clem's request
>>> accept_access_request("meta-llama/Llama-2-7b", "clem")

list_rejected_access_requests

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Parametreler

  • repo_id (str) — Erişim isteklerinin alınacağı repozituarın kimliği.
  • repo_type (str, isteğe bağlı) — Erişim isteklerinin alınacağı repoyu türü. model, dataset veya space değerlerinden biri olmalıdır. Varsayılan değer model'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[AccessRequest]

AccessRequest nesnelerinden oluşan bir iterable. Her öğe bir username, request_id, email, status ve timestamp özniteliği içerir. Gated repo özel bir form içeriyorsa, fields özniteliği kullanıcının yanıtlarıyla doldurulur.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Depo gated değilse HTTP 400.
  • HfHubHTTPError — Depoya yalnızca salt okunur erişiminiz varsa HTTP 403. Deponun ait olduğu organizasyonda write veya admin rolünüz yoksa ya da read belirteci geçirdiyseniz bu durumla karşılaşabilirsiniz.

Belirli bir gated repo için reddedilen erişim isteklerini alın.

Reddedilen bir istek, kullanıcının depoya erişim istediğini ve bu isteğin bir depo sahibi (sizin veya organizasyonunuzdaki başka bir kullanıcı) tarafından açıkça reddedildiğini belirtir. Kullanıcı, depodaki hiçbir dosyayı indiremez. Reddedilen istekler, accept_access_request() ve cancel_access_request() kullanılarak herhangi bir zamanda kabul edilebilir veya iptal edilebilir. İptal edilen bir istek bekleyenler listesine geri dönerken, kabul edilen bir istek kabul edilenler listesine geçer.

Kapalı depolar hakkında daha fazla bilgi için https://huggingface.co/docs/hub/models-gated adresine bakın.

Örnek:

>>> from huggingface_hub import list_rejected_access_requests

>>> requests = list(list_rejected_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='rejected',
        fields=None,
    ),
    ...
]

list_repo_commits

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = Nonerevision: str | None = Noneformatted: bool = False ) → list[GitCommitInfo]

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı.
  • repo_type (str, isteğe bağlı) — Bir veri seti veya Space'ten commit listesi alınıyorsa "dataset" veya "space", modelden listeleniyorsa None veya "model" olarak ayarlayın. Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • revision (str, isteğe bağlı) — Taahhüt edilecek git revizyonu. Varsayılan olarak "main" dalının başıdır.
  • formatted (bool) — Commit'lerin HTML biçimlendirilmiş başlık ve açıklamalarının döndürülüp döndürülmeyeceğini belirtir. Varsayılan olarak False.

Dönüş değeri

list[GitCommitInfo]

Hub'daki bir repoya ait commit'ler hakkında bilgi içeren nesnelerin listesi.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.
  • RevisionNotFoundError — Revizyon depoda bulunamazsa (404 hatası).

Hub'daki bir depoyun belirli bir revizyonuna ait commit listesini alın.

Commitler tarihe göre sıralanır (son commit en üstte).

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Commits are sorted by date (last commit first)
>>> initial_commit = api.list_repo_commits("gpt2")[-1]

# Initial commit is always a system commit containing the `.gitattributes` file.
>>> initial_commit
GitCommitInfo(
    commit_id='9b865efde13a30c13e0a33e536cf3e4a5a9d71d8',
    authors=['system'],
    created_at=datetime.datetime(2019, 2, 18, 10, 36, 15, tzinfo=datetime.timezone.utc),
    title='initial commit',
    message='',
    formatted_title=None,
    formatted_message=None
)

# Create an empty branch by deriving from initial commit
>>> api.create_branch("gpt2", branch="new_empty_branch", revision=initial_commit.commit_id)

list_repo_files

< >

( repo_id: strrevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → list[str]

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı.
  • revision (str, isteğe bağlı) — Bilgilerin alınacağı depoyun revizyonu.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya space'e yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model" olarak ayarlayın. Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

list[str]

belirtilen bir depodaki dosya listesi.

Belirtilen depodaki dosya listesini alın.

list_repo_likers

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[User]

Parametreler

  • repo_id (str) — Alınacak depo. Örnek: "user/my-cool-model".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.

Dönüş değeri

Iterable[User]

huggingface_hub.hf_api.User nesnelerinden oluşan bir iterable.

Hugging Face Hub'da belirli bir repoyu beğenen tüm kullanıcıları listeler.

Ayrıca list_liked_repos() bkz.

list_repo_refs

< >

( repo_id: strrepo_type: str | None = Noneinclude_pull_requests: bool = Falsetoken: str | bool | None = None ) → GitRefs

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • repo_type (str, isteğe bağlı) — Bir veri seti, Space veya Kernel'den referansları listeliyorsanız "dataset", "space" veya "kernel" olarak ayarlayın, bir modelden listeliyorsanız None veya "model". Varsayılan değer None'dir.
  • include_pull_requests (bool, isteğe bağlı) — Listeye pull request'lerden gelen referansların dahil edilip edilmeyeceğini belirtir. Varsayılan değeri False'tur.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

GitRefs

Hub'daki bir depoya ilişkin dallar ve etiketler hakkında tüm bilgileri içeren nesne.

Belirtilen bir repoda bulunan referansların (hem etiketler hem de dallar) listesini alın.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.list_repo_refs("gpt2")
GitRefs(branches=[GitRefInfo(name='main', ref='refs/heads/main', target_commit='e7da7f221d5bf496a48136c0cd264e630fe9fcc8')], converts=[], tags=[])

>>> api.list_repo_refs("bigcode/the-stack", repo_type='dataset')
GitRefs(
    branches=[
        GitRefInfo(name='main', ref='refs/heads/main', target_commit='18edc1591d9ce72aa82f56c4431b3c969b210ae3'),
        GitRefInfo(name='v1.1.a1', ref='refs/heads/v1.1.a1', target_commit='f9826b862d1567f3822d3d25649b0d6d22ace714')
    ],
    converts=[],
    tags=[
        GitRefInfo(name='v1.0', ref='refs/tags/v1.0', target_commit='c37a8cd1e382064d8aced5e05543c5f7753834da')
    ]
)

list_repo_tree

< >

( repo_id: strpath_in_repo: str | None = Nonerecursive: bool = Falseexpand: bool = Falserevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → Iterable[Union[RepoFile, RepoFolder]]

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı.
  • path_in_repo (str, isteğe bağlı) — Depodaki ağacın (klasörün) göreli yolu, örneğin: "checkpoints/1fec34a/results". Varsayılan olarak deponun kök ağacına (klasörüne) ayarlanır.
  • recursive (bool, isteğe bağlı, varsayılan False) — Ağacın dosyalarının ve klasörlerinin özyinelemeli olarak listelenip listelenmeyeceğini belirtir.
  • expand (bool, isteğe bağlı, varsayılan False) — Ağacın dosyaları ve klasörleri hakkında daha fazla bilgi alınıp alınmayacağını belirtir (ör. son commit ve dosyaların güvenlik tarama sonuçları). Bu işlem sunucu için daha maliyetli olduğundan sayfa başına yalnızca 50 sonuç döndürülür (1000 yerine). Sayfalama huggingface_hub içinde uygulandığından, sonuçları alma süresi dışında bu durum sizin için şeffaftır.
  • revision (str, isteğe bağlı) — Ağacın alınacağı depoyun revizyonu. Varsayılan olarak "main" dalıdır.
  • repo_type (str, isteğe bağlı) — Ağacın alınacağı depoyun türü ("model", "dataset", "space" veya "kernel"). Varsayılan değer "model"'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[Union[RepoFile, RepoFolder]]

Ağaçtaki dosyalar ve klasörler hakkında bilgi, RepoFile ve RepoFolder nesnelerinden oluşan bir iterable olarak. Dosyaların ve klasörlerin sırası garanti edilmez.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError veya ~utils.RemoteEntryNotFoundError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.
  • RevisionNotFoundError — Revizyon depoda bulunamazsa (404 hatası).
  • ~utils.RemoteEntryNotFoundError — Depoda ağacın (klasörün) var olmaması durumunda (404 hatası).

Bir depo ağacının dosyalarını ve klasörlerini listele ve bunlar hakkında bilgi al.

Örnekler:

Bir repozituarın ağacı hakkında bilgi alın.

>>> from huggingface_hub import list_repo_tree
>>> repo_tree = list_repo_tree("lysandre/arxiv-nlp")
>>> repo_tree
<generator object HfApi.list_repo_tree at 0x7fa4088e1ac0>
>>> list(repo_tree)
[
    RepoFile(path='.gitattributes', size=391, blob_id='ae8c63daedbd4206d7d40126955d4e6ab1c80f8f', lfs=None, last_commit=None, security=None),
    RepoFile(path='README.md', size=391, blob_id='43bd404b159de6fba7c2f4d3264347668d43af25', lfs=None, last_commit=None, security=None),
    RepoFile(path='config.json', size=554, blob_id='2f9618c3a19b9a61add74f70bfb121335aeef666', lfs=None, last_commit=None, security=None),
    RepoFile(
        path='flax_model.msgpack', size=497764107, blob_id='8095a62ccb4d806da7666fcda07467e2d150218e',
        lfs={'size': 497764107, 'sha256': 'd88b0d6a6ff9c3f8151f9d3228f57092aaea997f09af009eefd7373a77b5abb9', 'pointer_size': 134}, last_commit=None, security=None
    ),
    RepoFile(path='merges.txt', size=456318, blob_id='226b0752cac7789c48f0cb3ec53eda48b7be36cc', lfs=None, last_commit=None, security=None),
    RepoFile(
        path='pytorch_model.bin', size=548123560, blob_id='64eaa9c526867e404b68f2c5d66fd78e27026523',
        lfs={'size': 548123560, 'sha256': '9be78edb5b928eba33aa88f431551348f7466ba9f5ef3daf1d552398722a5436', 'pointer_size': 134}, last_commit=None, security=None
    ),
    RepoFile(path='vocab.json', size=898669, blob_id='b00361fece0387ca34b4b8b8539ed830d644dbeb', lfs=None, last_commit=None, security=None)]
]

Bir depodaki ağaç hakkında daha fazla bilgi alın (son commit ve dosyaların güvenlik taraması sonuçları)

>>> from huggingface_hub import list_repo_tree
>>> repo_tree = list_repo_tree("prompthero/openjourney-v4", expand=True)
>>> list(repo_tree)
[
    RepoFolder(
        path='feature_extractor',
        tree_id='aa536c4ea18073388b5b0bc791057a7296a00398',
        last_commit={
            'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190',
            'title': 'Upload diffusers weights (#48)',
            'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc)
        }
    ),
    RepoFolder(
        path='safety_checker',
        tree_id='65aef9d787e5557373fdf714d6c34d4fcdd70440',
        last_commit={
            'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190',
            'title': 'Upload diffusers weights (#48)',
            'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc)
        }
    ),
    RepoFile(
        path='model_index.json',
        size=582,
        blob_id='d3d7c1e8c3e78eeb1640b8e2041ee256e24c9ee1',
        lfs=None,
        last_commit={
            'oid': 'b195ed2d503f3eb29637050a886d77bd81d35f0e',
            'title': 'Fix deprecation warning by changing `CLIPFeatureExtractor` to `CLIPImageProcessor`. (#54)',
            'date': datetime.datetime(2023, 5, 15, 21, 41, 59, tzinfo=datetime.timezone.utc)
        },
        security={
            'safe': True,
            'av_scan': {'virusFound': False, 'virusNames': None},
            'pickle_import_scan': None
        }
    )
    ...
]

list_scheduled_jobs

< >

( labels: dict[str, str] | None = Nonetimeout: int | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → list[ScheduledJobInfo]

Parametreler

  • labels (dict[str, str], isteğe bağlı) — Yalnızca verilen tüm key=value etiketlerine sahip planlanmış Job'ları döndürür, örn. {"env": "prod", "team": "ml"}.
  • timeout (float, isteğe bağlı) — Hub'a yapılan istek için bir zaman aşımı ayarlanıp ayarlanmayacağı.
  • namespace (str, isteğe bağlı) — İşlerin listelendiği namespace. Varsayılan olarak kullanıcının mevcut namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

list[ScheduledJobInfo]

ScheduledJobInfo nesnelerinin listesi.

Hugging Face altyapısında zamanlanmış hesaplamalı İşleri listeler.

list_space_templates

< >

( token: str | bool | None = None ) → list[SpaceTemplate]

Parametreler

Dönüş değeri

list[SpaceTemplate]

Kullanılabilir Space şablonlarının listesi.

Hub'da kullanılabilir resmi Space şablonlarını listeler.

Dönen bir şablonun repo_id'si (veya kısa name'i), bu şablondan yeni bir Space oluşturmak için HfApi.create_repo() fonksiyonuna space_template olarak geçirilebilir.

Örnek:

>>> from huggingface_hub import list_space_templates
>>> templates = list_space_templates()
>>> templates[0]
SpaceTemplate(name='Streamlit', repo_id='streamlit/streamlit-template-space', sdk='docker', preferred_private=False)

list_spaces

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Nonesearch: str | None = Nonedatasets: str | Iterable[str] | None = Nonemodels: str | Iterable[str] | None = Nonelinked: bool = Falsesort: SpaceSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandSpaceProperty_T] | None = Nonefull: bool | None = Nonetoken: bool | str | None = None ) → Iterable[SpaceInfo]

Parametreler

  • filter (str veya Iterable, isteğe bağlı) — Hub'daki Spaces'leri tanımlamak için kullanılabilen bir dize etiketi veya etiket listesi.
  • author (str, isteğe bağlı) — Dönen Spaces'lerin yazarını tanımlayan bir dize.
  • search (str, isteğe bağlı) — Dönen Spaces içinde yer alacak bir dize.
  • datasets (str veya Iterable, isteğe bağlı) — Bir veri seti kullanan Spaces'lerin döndürülüp döndürülmeyeceğini belirtir. Belirli bir veri setinin adı bir dize olarak geçirilebilir.
  • models (str veya Iterable, isteğe bağlı) — Bir model kullanan Spaces'lerin döndürülüp döndürülmeyeceğini belirtir. Belirli bir modelin adı, bir dize olarak geçirilebilir.
  • linked (bool, isteğe bağlı) — Bir model veya veri seti kullanan Spaces'lerin döndürülüp döndürülmeyeceği.
  • sort (SpaceSort_T, isteğe bağlı) — Sonuç olarak elde edilen space'leri sıralamak için kullanılan anahtar. Olası değerler “created_at”, “last_modified”, “likes” ve “trending_score” şeklindedir.
  • limit (int, isteğe bağlı) — Alınacak Spaces sayısının sınırı. Bu seçeneği None olarak bırakmak tüm Spaces'leri alır.
  • expand (list[ExpandSpaceProperty_T], isteğe bağlı) — Yanıtta döndürülecek özelliklerin listesi. Kullanıldığında, yalnızca listedeki özellikler döndürülür. full parametresi geçiriliyorsa bu parametre kullanılamaz. Olası değerler "author", "cardData", "datasets", "disabled", "lastModified", "createdAt", "likes", "models", "private", "region", "runtime", "sdk", "siblings", "sha", "subdomain", "tags", "trendingScore", "usedStorage" ve "resourceGroup"'dir.
  • full (bool, isteğe bağlı) — last_modified, siblings ve card_data alanlarını da içeren tüm Spaces verilerinin getirilip getirilmeyeceğini belirtir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[SpaceInfo]

huggingface_hub.hf_api.SpaceInfo nesnelerinden oluşan bir yineleyici.

Bazı filtreler verildiğinde, Huggingface Hub üzerinde barındırılan boşlukları listeler.

list_spaces_hardware

< >

( token: bool | str | None = None ) → list[JobHardwareInfo]

Dönüş değeri

list[JobHardwareInfo]

Kullanılabilir donanım yapılandırmalarının listesi.

Spaces için kullanılabilir donanım seçeneklerini listeler.

Örnek:

>>> from huggingface_hub import list_spaces_hardware
>>> hardware_list = list_spaces_hardware()
>>> hardware_list[0]
JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ...)
>>> hardware_list[0].name
'cpu-basic'

list_user_followers

< >

( username: strtoken: bool | str | None = None ) → Iterable[User]

Parametreler

  • username (str) — Takipçilerinin alınacağı kullanıcının kullanıcı adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[User]

Kullanıcının takipçilerini içeren User nesnelerinin listesi.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Kullanıcı Hub'da yoksa HTTP 404.

Hub'da bir kullanıcının takipçi listesini alın.

list_user_following

< >

( username: strtoken: bool | str | None = None ) → Iterable[User]

Parametreler

  • username (str) — Takip edilen kullanıcıların alınacağı kullanıcının kullanıcı adı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[User]

Kullanıcının takip ettiği kullanıcıların User nesnelerinden oluşan bir liste.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Kullanıcı Hub'da yoksa HTTP 404.

Hub'da bir kullanıcının takip ettiği kullanıcıların listesini alın.

list_user_repos

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → Iterable[RepoStorageInfo]

Parametreler

  • namespace (str, isteğe bağlı) — Kuruluş adı. Verilmezse, kimliği doğrulanmış kullanıcının depolarını listeler.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Varsayılan olarak yerel olarak kaydedilmiş belirteç kullanılır.

Dönüş değeri

Iterable[RepoStorageInfo]

RepoStorageInfo nesnelerinden oluşan bir iterable.

Depolama bilgileriyle birlikte bir kullanıcı veya kuruluşun tüm depolarını (modeller, veri kümeleri, uzaylar, variller) listeler.

Kimlik doğrulaması yapılmış kullanıcı için /api/settings/repositories uç noktasını veya bir kuruluş için /api/organizations/{namespace}/settings/repositories uç noktasını kullanır.

Örnek:

>>> from huggingface_hub import list_user_repos

>>> repos = list(list_user_repos())
>>> repos[0]
RepoStorageInfo(id='username/my-model', type='model', ...)

>>> # List repos from an organization
>>> repos = list(list_user_repos(namespace="my-org"))

list_webhooks

< >

( token: bool | str | None = None ) → list[WebhookInfo]

Parametreler

Dönüş değeri

list[WebhookInfo]

Webhook bilgi nesneleri listesi.

Yapılandırılmış tüm webhook'ları listeler.

Örnek:

>>> from huggingface_hub import list_webhooks
>>> webhooks = list_webhooks()
>>> len(webhooks)
2
>>> webhooks[0]
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    secret="my-secret",
    domains=["repo", "discussion"],
    disabled=False,
)

merge_pull_request

< >

( repo_id: strdiscussion_num: inttoken: bool | str | None = Nonecomment: str | None = Nonerepo_type: str | None = None ) → DiscussionStatusChange

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • discussion_num (int) — Discussion veya Pull Request numarası. Kesinlikle pozitif bir tam sayı olmalıdır.
  • comment (str, isteğe bağlı) — Durum değişikliğiyle birlikte gönderilecek isteğe bağlı bir yorum.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

DiscussionStatusChange

durum değişikliği olayı

Bir Birleştirme İsteğini (Pull Request) birleştirir.

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

model_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = NonesecurityStatus: bool | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandModelProperty_T] | None = Nonetoken: bool | str | None = None ) → huggingface_hub.hf_api.ModelInfo

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • revision (str, isteğe bağlı) — Bilgilerin alınacağı model deposunun revizyonu.
  • timeout (float, isteğe bağlı) — Hub'a yapılan istek için bir zaman aşımı ayarlanıp ayarlanmayacağı.
  • securityStatus (bool, isteğe bağlı) — Güvenlik durumunun model deposundan da alınıp alınmayacağını belirtir. Güvenlik durumu, security_repo_status alanında döndürülür.
  • files_metadata (bool, isteğe bağlı) — Depodaki dosyalar için (boyut, LFS meta verisi vb.) meta verilerin alınıp alınmayacağı. Varsayılan değer False.
  • expand (list[ExpandModelProperty_T], isteğe bağlı) — Yanıtta döndürülecek özelliklerin listesi. Kullanıldığında, yalnızca listedeki özellikler döndürülür. securityStatus veya files_metadata geçirildiğinde bu parametre kullanılamaz. Olası değerler "author", "baseModels", "cardData", "childrenModelCount", "config", "createdAt", "disabled", "downloads", "downloadsAllTime", "evalResults", "gated", "gguf", "inference", "inferenceProviderMapping", "lastModified", "library_name", "likes", "mask_token", "model-index", "pipeline_tag", "private", "safetensors", "sha", "siblings", "spaces", "tags", "transformersInfo", "trendingScore", "widgetData", "usedStorage" ve "resourceGroup"'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

huggingface_hub.hf_api.ModelInfo

Model deposu bilgileri.

huggingface.co'daki belirli bir model hakkında bilgi alın

Geçerli bir token iletirseniz veya oturum açmışsanız model özel olabilir.

Aşağıdaki hataları oluşturur:

  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.
  • RevisionNotFoundError İndirilecek revizyon bulunamadığında.

move_bucket

< >

( from_id: strto_id: strtoken: bool | str | None = None )

Parametreler

  • from_id (str) — / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir varlık adı. Orijinal varlık tanımlayıcısı (ör. "username/my-bucket").
  • to_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir varlık adı. Son varlık tanımlayıcısı (ör. "username/new-bucket-name" veya "organization/my-bucket").
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

BucketNotFoundError

  • BucketNotFoundError — Kaynak bucket bulunamadığında. Bunun nedeni, bucket'ın var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

Bir kovayı “namespace1/repo_name1” konumundan “namespace2/repo_name2” konumuna taşıyın

Belirli kısıtlamalar bulunduğunu unutmayın. Depoları taşıma hakkında daha fazla bilgi için https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo adresine bakın.

Örnek:

>>> from huggingface_hub import move_bucket

>>> # Rename a bucket within the same namespace
>>> move_bucket(from_id="username/old-name", to_id="username/new-name")

>>> # Transfer a bucket to an organization
>>> move_bucket(from_id="username/my-bucket", to_id="my-org/my-bucket")

move_repo

< >

( from_id: strto_id: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Parametreler

  • from_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı. Orijinal depo tanımlayıcısı.
  • to_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı. Son depo tanımlayıcısı.
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

namespace1/repo_name1 adlı bir depoyu namespace2/repo_name2 olarak taşıma

Belirli kısıtlamalar bulunduğunu unutmayın. Depoları taşıma hakkında daha fazla bilgi için https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo adresine bakın.

Aşağıdaki hataları oluşturur:

  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

paper_info

< >

( id: str ) → PaperInfo

Parametreler

  • id (str, isteğe bağlı) — Makalenin ArXiv kimliği.

Dönüş değeri

PaperInfo

Bir PaperInfo nesnesi.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Kağıt Hub'da yoksa HTTP 404.

Hub'daki bir makale için bilgi alın.

parse_safetensors_file_metadata

< >

( repo_id: strfilename: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsFileMetadata

Parametreler

  • repo_id (str) — Bir kullanıcı veya kuruluş adı ile / ile ayrılmış bir depo adı.
  • filename (str) — Depodaki dosyanın adı.
  • repo_type (str, isteğe bağlı) — Dosya bir veri setinde veya uzaydaysa "dataset" veya "space" olarak ayarlayın, bir modeldeyse None veya "model". Varsayılan değer None'dir.
  • revision (str, isteğe bağlı) — Dosyanın alınacağı git revizyonu. Bir dal adı, etiket veya commit hash'i olabilir. Varsayılan olarak "main" dalının başıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • timeout (float, isteğe bağlı, varsayılan 10) — Sunucunun veri göndermesini bekleme süresi (saniye). Veri gelmezse bu süre sonunda denemeden vazgeçilir. Zaman aşımını devre dışı bırakmak için None olarak ayarlayın (önerilmez; takılan bir bağlantı çağrıyı süresiz olarak bekletebilir).

Dönüş değeri

SafetensorsFileMetadata

safetensors dosyasıyla ilgili bilgiler.

Yükseltilen

NotASafetensorsRepoError veya SafetensorsParsingError

  • NotASafetensorsRepoError — Depo bir safetensors deposu değilse, yani ne model.safetensors ne de model.safetensors.index.json dosyası içeriyorsa.
  • SafetensorsParsingError — Bir safetensors dosyasının başlığı doğru şekilde ayrıştırılamadığında.

Hub'daki bir safetensors dosyasından meta verileri ayrıştırın.

Bir depodaki tüm safetensors dosyalarından meta verileri aynı anda ayrıştırmak için get_safetensors_metadata() kullanın.

safetensors formatı hakkında daha fazla ayrıntı için https://huggingface.co/docs/safetensors/index#format adresine göz atın.

pause_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parametreler

  • name (str) — Duraklatılacak Inference Endpoint'in adı.
  • namespace (str, isteğe bağlı) — Inference Endpoint'in bulunduğu namespace. Varsayılan olarak mevcut kullanıcıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

InferenceEndpoint

Duraklatılmış Inference Endpoint hakkında bilgi.

Bir Çıkarım Uç noktasını Durdurun.

Duraklatılmış bir Inference Endpoint için ücretlendirme yapılmaz. resume_inference_endpoint() kullanılarak istenilen her an yeniden başlatılabilir. Bu, scale_to_zero_inference_endpoint() ile Inference Endpoint'in sıfıra ölçeklendirilmesinden farklıdır; bu durumda, endpoint'e bir istek yapıldığında otomatik olarak yeniden başlatılır.

Kolaylık olması için, bir Inference Endpoint'i pause_inference_endpoint() kullanarak da duraklatabilirsiniz.

pause_space

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Parametreler

  • repo_id (str) — Duraklatılacak Space'in kimliği. Örnek: "Salesforce/BLIP2".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

SpaceRuntime

stage=PAUSED ve istenen donanım dahil olmak üzere Space'inizin çalışma zamanı bilgileri.

Yükseltilen

RepositoryNotFoundError veya HfHubHTTPError veya BadRequestError

  • RepositoryNotFoundError — Space'iniz bulunamadıysa (404 hatası). Büyük olasılıkla repo_id yanlış ya da Space'iniz özel ancak kimlik doğrulamanız yapılmamış.
  • HfHubHTTPError — 403 Yasak: Bir Space'i yalnızca sahibi duraklatabilir. Sahibi olmadığınız bir Space'i yönetmek istiyorsanız, bir Discussion açarak sahibinden rica edin veya Space'i kopyalayın.
  • BadRequestError — Space'ınız statik bir Space ise. Statik Spaces her zaman çalışır durumda olur ve asla faturalandırılmaz. Statik bir Space'i gizlemek istiyorsanız, onu özel olarak ayarlayabilirsiniz.

Space'inizi duraklatın.

Duraklatılmış bir Space, sahibi tarafından manuel olarak yeniden başlatılana kadar çalışmayı durdurur. Bu, ücretsiz Spaces'in 48 saatlik hareketsizlikten sonra girdiği uyku durumundan farklıdır. Seçtiğiniz donanım ne olursa olsun, duraklatma süresi hesabınıza faturalandırılmaz. Space'inizi yeniden başlatmak için restart_space() kullanın ve Space ayarlar sayfanıza gidin.

Daha fazla ayrıntı için lütfen belgelere göz atın.

permanently_delete_lfs_files

< >

( repo_id: strlfs_files: Iterable[LFSFileInfo]rewrite_history: bool = Truerepo_type: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • repo_id (str) — LFS dosyalarını listelediğiniz depo.
  • lfs_files (Iterable[LFSFileInfo]) — Depodan kalıcı olarak silinecek LFSFileInfo öğelerinden oluşan bir iterable. Depodaki tüm LFS dosyalarını listelemek için list_lfs_files() kullanın.
  • rewrite_history (bool, isteğe bağlı, varsayılan True) — Silinen LFS dosyalarına atıfta bulunan dosya işaretçilerini kaldırmak için depo geçmişinin yeniden yazılıp yazılmayacağı (önerilir).
  • repo_type (str, isteğe bağlı) — Depo türü. Bir veri setinden veya uzaydan listeleniyorsa "dataset" veya "space" olarak ayarlayın, bir modelden listeleniyorsa None veya "model" olarak ayarlayın. Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Hub'daki bir depodan LFS dosyalarını kalıcı olarak silin.

Bu, silinen dosyaları referans veren tüm commit'leri etkileyecek kalıcı bir eylemdir ve depoyu bozabilir. Bu işlem geri alınamaz. Ne yaptığınızı biliyorsanız kullanın.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)

preupload_lfs_files

< >

( repo_id: stradditions: Iterable[CommitOperationAdd]token: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Nonenum_threads: int = 5free_memory: bool = Truegitignore_content: str | None = None )

Parametreler

  • repo_id (str) — Dosyaları commit edeceğiniz depo, örneğin: "username/custom_transformers".
  • additions (Iterable of CommitOperationAdd) — Yüklenmesi gereken dosyaların listesi. Uyarı: Bu listedeki nesneler, yüklemeyle ilgili bilgileri içerecek şekilde değiştirilecektir. Aynı nesneleri birden fazla commit için yeniden kullanmayın.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Yüklenmesi gereken depoyun türü (ör. "model" -varsayılan-, "dataset", "space" veya "kernel").
  • revision (str, isteğe bağlı) — Taahhüt edilecek git revizyonu. Varsayılan olarak "main" dalının başıdır.
  • create_pr (boolean, isteğe bağlı) — Bu commit ile bir Pull Request oluşturmayı planlayıp planlamadığınız. Varsayılan olarak False.
  • num_threads (int, isteğe bağlı) — Dosyaları yüklemek için eşzamanlı iş parçacığı sayısı. Varsayılan değer 5'tir. 2 olarak ayarlanması, en fazla 2 dosyanın eşzamanlı yükleneceği anlamına gelir.
  • free_memory (bool, isteğe bağlı, varsayılan True) — True ise, bellek tasarrufu sağlamak için yükleme sonrasında her CommitOperationAdd nesnesinin path_or_fileobj özniteliği boş bir bytes nesnesiyle değiştirilir. İşlem nesnelerini, sonraki bir create_commit() çağrısı dışında yeniden kullanmanız gerekiyorsa False olarak ayarlayın.
  • gitignore_content (str, isteğe bağlı) — Yoksayılması gereken dosyaları belirlemek için .gitignore dosyasının içeriği. Öncelik sırası, önce gitignore_content'in iletildiğini kontrol etmek, ardından .gitignore dosyasının iletilecek dosyalar listesinde olup olmadığını kontrol etmek ve son olarak Hub'da zaten barındırılan .gitignore dosyasına (varsa) varsayılan olarak başvurmak şeklindedir.

Gelecekteki bir commit'e hazırlık olarak LFS dosyalarını S3'e önceden yükleyin.

Bu yöntem, yüklemek üzere dosyaları anlık olarak oluşturuyorsanız ve hepsini tek seferde yüklemekten önce bellekte saklamak istemiyorsanız faydalıdır.

Bu, gelişmiş kullanıcılar için bir yöntemdir. Normal bir commit yapmak için bunu doğrudan çağırmanıza gerek yoktur. Bunun yerine create_commit() fonksiyonunu doğrudan kullanın.

Commit işlemleri süreç sırasında değiştirilecektir. Özellikle, yüklemeye eklenmiş path_or_fileobj, belleği tasarruflu kullanmak için yükleme sonrasında kaldırılacaktır (ve boş bir bytes nesnesiyle değiştirilecektir). Aynı nesneleri, create_commit() fonksiyonuna geçirmek dışında yeniden kullanmayın. Commit işlemi nesnesinden eklenmiş içeriği kaldırmak istemiyorsanız, free_memory=False parametresini geçirin.

Örnek:

>>> from huggingface_hub import CommitOperationAdd, preupload_lfs_files, create_commit, create_repo

>>> repo_id = create_repo("test_preupload").repo_id

# Generate and preupload LFS files one by one
>>> operations = [] # List of all `CommitOperationAdd` objects that will be generated
>>> for i in range(5):
...     content = ... # generate binary content
...     addition = CommitOperationAdd(path_in_repo=f"shard_{i}_of_5.bin", path_or_fileobj=content)
...     preupload_lfs_files(repo_id, additions=[addition]) # upload + free memory
...     operations.append(addition)

# Create commit
>>> create_commit(repo_id, operations=operations, commit_message="Commit all shards")

read_paper

< >

( id: str ) → str

Parametreler

  • id (str) — Makalenin ArXiv kimliği.

Dönüş değeri

str

Makale sayfası içeriği markdown olarak.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Kağıt Hub'da yoksa HTTP 404.

Hub'daki bir makale sayfasının markdown içeriğini alın.

reject_access_request

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonerejection_reason: str | Nonetoken: bool | str | None = None )

Parametreler

  • repo_id (str) — Erişim isteğinin reddedileceği repozituarın kimliği.
  • user (str, isteğe bağlı) — Erişim isteğinin reddedileceği kullanıcının kullanıcı adı. user veya request_id parametrelerinden tam olarak biri sağlanmalıdır.
  • request_id (str, isteğe bağlı) — Reddedilecek erişim isteğinin kimliği (bkz. AccessRequest). Depo, istek sahiplerinin kullanıcı adlarını paylaşmayacak şekilde yapılandırıldığında zorunludur. user veya request_id parametrelerinden tam olarak biri sağlanmalıdır.
  • repo_type (str, isteğe bağlı) — Erişim isteğinin reddedileceği repoyu türü. model, dataset veya space değerlerinden biri olmalıdır. Varsayılan değer model'dir.
  • rejection_reason (str, isteğe bağlı) — Kullanıcıya görünecek isteğe bağlı reddetme nedeni (en fazla 200 karakter).
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Depo gated değilse HTTP 400.
  • HfHubHTTPError — Depoya yalnızca salt okunur erişiminiz varsa HTTP 403. Deponun ait olduğu organizasyonda write veya admin rolünüz yoksa ya da read belirteci geçirdiyseniz bu durumla karşılaşabilirsiniz.
  • HfHubHTTPError — Kullanıcı Hub'da yoksa HTTP 404.
  • HfHubHTTPError — Kullanıcı erişim isteği bulunamazsa HTTP 404.
  • HfHubHTTPError — Kullanıcı erişim isteği zaten reddedilenler listesindeyse HTTP 404.

Belirli bir gated repo için bir kullanıcının erişim isteğini reddet.

Reddedilen bir istek, reddedilenler listesine gider. Kullanıcı, repodaki hiçbir dosyayı indiremez. Reddedilen istekler, accept_access_request() ve cancel_access_request() kullanılarak herhangi bir zamanda kabul edilebilir veya iptal edilebilir. İptal edilen bir istek bekleyenler listesine geri dönerken, kabul edilen bir istek kabul edilenler listesine gider.

Kapalı depolar hakkında daha fazla bilgi için https://huggingface.co/docs/hub/models-gated adresine bakın.

rename_discussion

< >

( repo_id: strdiscussion_num: intnew_title: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionTitleChange

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • discussion_num (int) — Discussion veya Pull Request numarası. Kesinlikle pozitif bir tam sayı olmalıdır.
  • new_title (str) — Tartışma için yeni başlık
  • repo_type (str, isteğe bağlı) — Bir veri setine veya alanına yükleniyorsa "dataset" veya "space" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

TartışmaBaşlığıDeğişikliği

başlık değiştirme olayı

Bir Tartışmayı Yeniden Adlandırır.

Örnekler:

>>> new_title = "New title, fixing a typo"
>>> HfApi().rename_discussion(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     new_title=new_title
... )
# DiscussionTitleChange(id='deadbeef0000000', type='title-change', ...)

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

repo_exists

< >

( repo_id: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • repo_type (str, isteğe bağlı) — Bir veri setinden veya bir space'ten depo bilgisi alınıyorsa "dataset" veya "space" olarak ayarlayın, bir modelden depo bilgisi alınıyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir deponun Hugging Face Hub üzerinde var olup olmadığını kontrol eder.

Örnekler:

>>> from huggingface_hub import repo_exists
>>> repo_exists("google/gemma-7b")
True
>>> repo_exists("google/not-a-repo")
False

repo_info

< >

( repo_id: strrevision: str | None = Nonerepo_type: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: ExpandModelProperty_T | ExpandDatasetProperty_T | ExpandSpaceProperty_T | None = Nonetoken: bool | str | None = None ) → Union[SpaceInfo, DatasetInfo, ModelInfo]

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • revision (str, isteğe bağlı) — Bilgilerin alınacağı depoyun revizyonu.
  • repo_type (str, isteğe bağlı) — Bir veri setinden veya bir space'ten depo bilgisi alınıyorsa "dataset" veya "space" olarak ayarlayın, bir modelden depo bilgisi alınıyorsa None veya "model". Varsayılan değer None'dir.
  • timeout (float, isteğe bağlı) — Hub'a yapılan istek için bir zaman aşımı ayarlanıp ayarlanmayacağı.
  • expand (ExpandModelProperty_T veya ExpandDatasetProperty_T veya ExpandSpaceProperty_T, isteğe bağlı) — Yanıtta döndürülecek özelliklerin listesi. Kullanıldığında, yalnızca listedeki özellikler döndürülür. files_metadata geçirildiğinde bu parametre kullanılamaz. Kullanılabilir özelliklerin kapsamlı listesi için model_info(), dataset_info() veya space_info() işlevlerine göz atın.
  • files_metadata (bool, isteğe bağlı) — Depodaki dosyalar için (boyut, LFS meta verisi vb.) meta verilerin alınıp alınmayacağı. Varsayılan değer False.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Union[SpaceInfo, DatasetInfo, ModelInfo]

Depo bilgisi, bir huggingface_hub.hf_api.DatasetInfo, huggingface_hub.hf_api.ModelInfo veya huggingface_hub.hf_api.SpaceInfo nesnesi olarak.

Belirli bir türdeki belirli bir depo için bilgi nesnesini alın.

Aşağıdaki hataları oluşturur:

  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.
  • RevisionNotFoundError İndirilecek revizyon bulunamadığında.

request_space_hardware

< >

( repo_id: strhardware: SpaceHardwaretoken: bool | str | None = Nonesleep_time: int | None = None ) → SpaceRuntime

Parametreler

  • repo_id (str) — Güncellenecek depoyun kimliği. Örnek: "bigcode/in-the-stack".
  • hardware (str veya SpaceHardware) — Space'in çalıştırılacağı donanım. Örnek: "t4-medium".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • sleep_time (int, isteğe bağlı) — Bir Space'in uyku moduna alınmadan önce beklenen hareketsizlik süresi (saniye cinsinden). Space'inizin uyumasını istemiyorsanız -1 olarak ayarlayın (yükseltilmiş donanımlar için varsayılan davranış). Ücretsiz donanımlarda uyku süresi yapılandırılamaz (değer 48 saat hareketsizlik olarak sabittir). Daha fazla ayrıntı için https://huggingface.co/docs/hub/spaces-gpus#sleep-time adresine bakın.

Dönüş değeri

SpaceRuntime

Bir Space hakkında çalışma zamanı bilgileri, Space aşaması ve donanımı dahil.

Bir Space için yeni donanım talep edin.

Space deposu oluşturulurken donanımın doğrudan istenmesi de mümkündür! Ayrıntılar için create_repo() işlevine bakın.

rerun_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Parametreler

  • job_id (str) — Yeniden çalıştırılacak Job'un kimliği.
  • namespace (str, isteğe bağlı) — Görevin ad alanı. Varsayılan olarak kullanıcının mevcut ad alanı kullanılır.
  • token (bool veya str, isteğe bağlı) — Kullanıcı erişim belirteci. Varsayılan olarak yerel olarak kaydedilmiş belirteç kullanılır.

Dönüş değeri

JobInfo

Yeni başlatılan İş.

Mevcut İş'in yeniden deneme ve kaynak ayarlarını da içeren spesifikasyonunu kullanarak yeni bir İş çalıştırın.

resolve_revision

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_files_only: bool = Falsetoken: bool | str | None = None ) → ResolvedRevision

Parametreler

  • repo_id (str) — Bir kullanıcı veya kuruluş adı ile / ile ayrılmış bir depo adı.
  • repo_type (str, isteğe bağlı) — Depo bir veri seti, space veya kernel deposuysa "dataset", "space" veya "kernel" olarak ayarlayın, model ise None veya "model" olarak ayarlayın. Varsayılan değer None'dir.
  • revision (str, isteğe bağlı) — Çözümlenecek revizyon. Bir dal adı, etiket, PR referansı veya commit hash'i olabilir. Varsayılan olarak varsayılan dal kullanılır. Bir ResolvedRevision geçirilirse, olduğu gibi döndürülür - başka bir depoya karşı çözümlenmişse, başlangıçta istenen revizyon yeniden çözümlenir.
  • cache_dir (str, Path, isteğe bağlı) — Önbelleğe alınan dosyaların saklandığı klasörün yolu. Varsayılan olarak HF_HUB_CACHE değerini kullanır.
  • local_files_only (bool, isteğe bağlı, varsayılan False) — True ise, Hub ile iletişim kurmadan revizyonu yalnızca yerel önbellekten çözer.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

ResolvedRevision

Hem istenen revizyonu hem de çözümlendiği commit hash'ini tutan bir str alt sınıfı.

Yükseltilen

RevisionResolutionError veya RevisionNotFoundError veya RepositoryNotFoundError

  • RevisionResolutionError — Revizyon çözümlenemezse: Hub'a ulaşılamadı ve yerel olarak hiçbir şey önbelleğe alınmadı.
  • RevisionNotFoundError — Revizyon Hub'da mevcut değilse.
  • RepositoryNotFoundError — Depo bulunamadığında. Bunun nedeni, depoyun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

Bir revizyonu (dal, etiket, PR referansı) bir commit hash'ine çözümler.

Bu, bir repodaki birkaç bileşeni (config, weights, tokenizer, …) ayrı ayrı indirip yükleyen kütüphaneler içindir. Revizyonu bir kez çözüp döndürülen ResolvedRevision nesnesini her yerde kullanmak, repo bu arada güncellense bile her sonraki çağrının tam olarak aynı commit'i hedeflediğini garanti eder. Ayrıca HTTP çağrılarını da azaltır; çünkü commit hash'i ile yapılan indirmeler, Hub'a bağlanmadan yerel önbellekten sunulabilir.

revision -> commit hash eşlemesi, diskte (önbelleğin refs/ klasöründe) en iyi çaba (best-effort) esasına göre önbelleğe alınır. Hub daha sonra erişilemezse (çevrimdışı mod, bağlantı hatası, zaman aşımı, Hub kesintisi, …), önbelleğe alınan değer yedek olarak kullanılır.

Sadece tam bir depo anlık görüntüsü indirmeniz gerekiyorsa, tek bir snapshot_download() çağrısı yeterlidir ve zaten doğru işi yapar. resolve_revision yalnızca dosyaları ayrı ayrı indirirken kullanışlıdır.

Örnek:

>>> from huggingface_hub import hf_hub_download, resolve_revision
>>> revision = resolve_revision("openai-community/gpt2")
>>> revision
ResolvedRevision(initial=None, resolved='607a30d783dfa663caf39e06633721c8d4cfcd7e')

# Pass it around: every download is pinned to the same commit
>>> config = hf_hub_download("openai-community/gpt2", "config.json", revision=revision)
>>> weights = hf_hub_download("openai-community/gpt2", "model.safetensors", revision=revision)

restart_space

< >

( repo_id: strtoken: bool | str | None = Nonefactory_reboot: bool = False ) → SpaceRuntime

Parametreler

  • repo_id (str) — Yeniden başlatılacak Space'in kimliği. Örnek: "Salesforce/BLIP2".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • factory_reboot (bool, isteğe bağlı) — True ise, Space hiçbir gereksinim önbelleğe almadan sıfırdan yeniden oluşturulur.

Dönüş değeri

SpaceRuntime

Space'inizin çalışma zamanı bilgileri.

Yükseltilen

RepositoryNotFoundError veya HfHubHTTPError veya BadRequestError

  • RepositoryNotFoundError — Space'iniz bulunamadıysa (404 hatası). Büyük olasılıkla repo_id yanlış ya da Space'iniz özel ancak kimlik doğrulamanız yapılmamış.
  • HfHubHTTPError — 403 Forbidden: bir Space'i yalnızca sahibi yeniden başlatabilir. Sahibi olmadığınız bir Space'i yeniden başlatmak istiyorsanız, bir Discussion açarak sahibinden isteyebilir veya Space'i kopyalayabilirsiniz.
  • BadRequestError — Space'ınız statik bir Space ise. Statik Spaces her zaman çalışır durumda olur ve asla faturalandırılmaz. Statik bir Space'i gizlemek istiyorsanız, onu özel olarak ayarlayabilirsiniz.

Space'inizi yeniden başlatın.

Bir Space'i Duraklatma durumuna aldıysanız (bkz. pause_space()), programatik olarak yeniden başlatmanın tek yolu budur. Yeniden başlatmak için Space'in sahibi olmanız gerekir. Yükseltilmiş bir donanım kullanıyorsanız, Space yeniden başlatıldığında hesabınıza fatura kesilir. Bir Space'in mevcut durumu ne olursa olsun yeniden başlatma tetikleyebilirsiniz.

Daha fazla ayrıntı için lütfen belgelere göz atın.

resume_inference_endpoint

< >

( name: strnamespace: str | None = Nonerunning_ok: bool = Truetoken: bool | str | None = None ) → InferenceEndpoint

Parametreler

  • name (str) — Devam edilecek Inference Endpoint'in adı.
  • namespace (str, isteğe bağlı) — Inference Endpoint'in bulunduğu namespace. Varsayılan olarak mevcut kullanıcıdır.
  • running_ok (bool, isteğe bağlı) — True ise, Inference Endpoint zaten çalışıyorsa yöntem hata yükseltmez. Varsayılan değer True'dur.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

InferenceEndpoint

devam ettirilen Inference Endpoint hakkında bilgi.

Bir Çıkarım Uç noktasını Devam Ettirin.

Kolaylık olması için, InferenceEndpoint.resume() kullanarak bir Inference Endpoint'i yeniden başlatabilirsiniz.

resume_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • scheduled_job_id (str) — Planlanan Job'un kimliği.
  • namespace (str, isteğe bağlı) — Planlanan Job'un bulunduğu namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında zamanlanmış bir hesaplama Job'unu yeniden başlatın (durdurmayı geri alın).

revision_exists

< >

( repo_id: strrevision: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • revision (str) — Kontrol edilecek depoyu revizyonu.
  • repo_type (str, isteğe bağlı) — Bir veri setinden veya bir space'ten depo bilgisi alınıyorsa "dataset" veya "space" olarak ayarlayın, bir modelden depo bilgisi alınıyorsa None veya "model". Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Hugging Face Hub'daki bir depoda belirli bir revizyonun var olup olmadığını kontrol eder.

Örnekler:

>>> from huggingface_hub import revision_exists
>>> revision_exists("google/gemma-7b", "float16")
True
>>> revision_exists("google/gemma-7b", "not-a-revision")
False

run_as_future

< >

( fn: Callable[..., R]*args**kwargs ) → Future

Parametreler

  • fn (Callable) — Arka planda çalıştırılacak yöntem.
  • *args, **kwargs — Metodun çağrılacağı argümanlar.

Dönüş değeri

Future

Görevin sonucunu almak için bir Future örneği.

Bir yöntemi arka planda çalıştırın ve bir Future örneği döndürün.

Ana hedef, ana iş parçacığını bloklamadan yöntemleri çalıştırmaktır (ör. eğitim sırasında veri göndermek). Arka plan işleri sırayı korumak için kuyruğa alınır ancak paralel olarak çalıştırılmaz. Betiklerinizi API'ye yapılan çok sayıda çağrıyı paralelleştirerek hızlandırmak gerekiyorsa, kendi ThreadPoolExecutor örneğinizi yapılandırıp kullanmanız gerekir.

Not: upload_file(), upload_folder() ve create_commit() gibi en çok kullanılan yöntemler, bunları doğrudan arka planda çağırmak için run_as_future: bool argümanına sahiptir. Bu, üzerlerinde api.run_as_future(...) çağrısı yapmaya eşdeğerdir ancak daha az sözdebirimseldir.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> future = api.run_as_future(api.whoami) # instant
>>> future.done()
False
>>> future.result() # wait until complete and return result
(...)
>>> future.done()
True

run_job

< >

( image: strcommand: list[str]env: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonessh: bool = Falsenetwork_group: str | None = Nonenetwork_aliases: list[str] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • image (str) — Kullanılacak Docker görüntüsü. Örnekler: "ubuntu", "python:3.12", "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel". Bir Space'ten görüntü içeren örnek: "hf.co/spaces/lhoestq/duckdb".
  • command (list[str]) — Çalıştırılacak komut. Örnek: ["echo", "hello"].
  • env (dict[str, Any], isteğe bağlı) — Job için ortam değişkenlerini tanımlar.
  • secrets (dict[str, Any], isteğe bağlı) — Job için gizli ortam değişkenlerini tanımlar.
  • flavor (str, isteğe bağlı) — Donanım için tad. Olası değerler için JobHardware’a bakın. Varsayılan değer "cpu-basic"’tür.
  • timeout (Union[int, float, str], isteğe bağlı) — Job için maksimum süre: int, s (saniye, varsayılan), m (dakika), h (saat) veya d (gün) birimiyle. Örnek: 5 dakika için 300 veya "5m".
  • attempts (int, isteğe bağlı) — Başlangıç çalışması dahil olmak üzere maksimum deneme sayısı. Varsayılan değer 1'dir. Örneğin, 3, başarısız bir Job'u en fazla 2 kez yeniden dener.
  • name (str, isteğe bağlı) — Job için bir ad. name etiketi olarak saklanır. labels içindeki name anahtarıyla birlikte geçirilemez. Adların benzersiz olması gerekmez. Varsayılan olarak, görüntüden ve komuttan türetilen (kısa bir hash sonekiyle) bir ad kullanılır.
  • labels (dict[str, str], isteğe bağlı) — İşin eklenmesi gereken etiketler (anahtar-değer çiftleri).
  • volumes (list[Volume], isteğe bağlı) — İş konteynerinde hacim olarak bağlanacak Hugging Face Buckets veya Repos. Her hacim, type ("bucket", "model", "dataset" veya "space"), source (ör. "username/my-bucket") ve mount_path (ör. "/data") içeren bir Volume'dur.
  • expose (list[int], isteğe bağlı) — İşler vekili (jobs proxy) üzerinden açılacak konteyner portları. Listelenen her port, herkese açık işler alan adında (ör. https://<job_id>--8000.hf.jobs) erişilebilir olur. Erişim her zaman, işin ad alanına (namespace) okuma erişimi olan bir HF token gerektirir. Kimlik doğrulamasız erişim için expose_public kullanın.
  • expose_public (list[int], isteğe bağlı) — Kimlik doğrulama olmadan Jobs vekili üzerinden açılacak portlar. Bunların expose içinde listelenmesine gerek yoktur.
  • ssh (bool, isteğe bağlı) — True ise, işin konteyneri job.status.ssh_url tarafından verilen URL üzerinden SSH ile erişilebilir (ör. ssh <job_id>@ssh.hf.jobs veya CLI'dan hf jobs ssh <job_id>). Bağlanmak için işin ad alanına yazma erişimi ve Hub'da kayıtlı bir SSH anahtarına (https://huggingface.co/settings/keys) ihtiyaç duyulur. Varsayılan değer False'tur.
  • network_group (str, isteğe bağlı) — Katılınacak ağ grubunun adı. Aynı namespace ve resource group içinde bir grubu paylaşan işler bir arada konumlandırılır ve her port üzerinden birbirine erişebilir. Her üyenin içinde, HF_NETWORK_GROUP_HOSTNAME grubun tüm üyelerine çözümlenir. Küçük harfli alfanümerik karakterler ve tireler, en fazla 46 karakter.
  • network_aliases (list[str], isteğe bağlı) — Bu işin ağ grubunda iddia ettiği takma adlar. Üyeler, bir takma adı iddia eden işlere ${HF_NETWORK_GROUP_PREFIX}<alias> üzerinden erişir. Birden fazla iş aynı takma adı iddia edebilir. Küçük harfli alfanümerik karakterler ve tireler, en fazla 34 karakter, iş içinde benzersiz. network_group gerektirir.
  • resource_group_id (str, isteğe bağlı) — Job'ın oluşturulacağı kaynak grubunun kimliği. Bir organizasyon içindeki kaynaklara erişimi kontrol etmek ve maliyet atama/harcama limiti özellikleri için kullanılır. Sağlanmazsa, Job herhangi bir kaynak grubunun dışında oluşturulur.
  • namespace (str, isteğe bağlı) — Job'ün oluşturulacağı namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında compute işlerini çalıştırın.

Örnek:

İlk Job'unuzu çalıştırın:

>>> from huggingface_hub import run_job
>>> run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])

GPU İşini Çalıştırın:

>>> from huggingface_hub import run_job
>>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"
>>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"]
>>> run_job(image=image, command=command, flavor="a10g-small")

Hacimlerle bir İş Çalıştırın:

>>> from huggingface_hub import Volume, run_job
>>> dataset_volume = Volume(type="dataset", source="HuggingFaceFW/fineweb", mount_path="/data")
>>> output_bucket_volume = Volume(type="bucket", source="username/my-bucket", mount_path="/output")
>>> image = "duckdb/duckdb"
>>> command = ["duckdb", "-c", "COPY (SELECT * FROM '/data/**/*.parquet' LIMIT 5) TO '/output/first-rows.parquet'"]
>>> run_job(image=image, command=command, volumes=[dataset_volume, output_bucket_volume])

run_uv_job

< >

( script: strscript_args: list[str] | None = Nonedependencies: list[str] | None = Nonepython: str | None = Noneimage: str | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonessh: bool = Falsenetwork_group: str | None = Nonenetwork_aliases: list[str] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • script (str) — UV betiğinin yolu veya URL'si, ya da bir komut.
  • script_args (list[str], isteğe bağlı) — Betik veya komuta iletilecek argümanlar.
  • dependencies (list[str], isteğe bağlı) — UV betiğini çalıştırmak için kullanılacak bağımlılıklar.
  • python (str, isteğe bağlı) — Belirli bir Python sürümünü kullanın. Varsayılan 3.12'dir.
  • image (str, isteğe bağlı, varsayılan “ghcr.io/astral-sh/uv —python3.12-bookworm”): uv yüklü özel bir Docker görüntüsü kullanın.
  • env (dict[str, Any], isteğe bağlı) — Job için ortam değişkenlerini tanımlar.
  • secrets (dict[str, Any], isteğe bağlı) — Job için gizli ortam değişkenlerini tanımlar.
  • flavor (str, isteğe bağlı) — Donanım için tad. Olası değerler için JobHardware’a bakın. Varsayılan değer "cpu-basic"’tür.
  • timeout (Union[int, float, str], isteğe bağlı) — Job için maksimum süre: int, s (saniye, varsayılan), m (dakika), h (saat) veya d (gün) birimiyle. Örnek: 5 dakika için 300 veya "5m".
  • attempts (int, isteğe bağlı) — Başlangıç çalışması dahil olmak üzere maksimum deneme sayısı. Varsayılan değer 1'dir.
  • name (str, isteğe bağlı) — Job için bir ad. name etiketi olarak saklanır. labels içindeki name anahtarıyla birlikte geçirilemez. Adların benzersiz olması gerekmez. Varsayılan olarak, betikten ve argümanlarından türetilen bir ad (kısa bir hash ekiyle) kullanılır.
  • labels (dict[str, str], isteğe bağlı) — İşin eklenmesi gereken etiketler (anahtar-değer çiftleri).
  • volumes (list[Volume], isteğe bağlı) — İş konteynerinde hacim olarak bağlanacak Hugging Face Buckets veya Repos. Her hacim, type ("bucket", "model", "dataset" veya "space"), source (ör. "username/my-bucket") ve mount_path (ör. "/data") içeren bir Volume'dur.
  • expose (list[int], isteğe bağlı) — İşler vekili (jobs proxy) üzerinden açılacak konteyner portları. Listelenen her port, herkese açık işler alan adında (ör. https://<job_id>--8000.hf.jobs) erişilebilir olur. Erişim her zaman, işin ad alanına (namespace) okuma erişimi olan bir HF token gerektirir. Kimlik doğrulamasız erişim için expose_public kullanın.
  • expose_public (list[int], isteğe bağlı) — Kimlik doğrulama olmadan Jobs vekili üzerinden açılacak portlar. Bunların expose içinde listelenmesine gerek yoktur.
  • ssh (bool, isteğe bağlı) — True ise, işin konteyneri job.status.ssh_url tarafından verilen URL üzerinden SSH ile erişilebilir (ör. ssh <job_id>@ssh.hf.jobs veya CLI'dan hf jobs ssh <job_id>). Bağlanmak için işin ad alanına yazma erişimi ve Hub'da kayıtlı bir SSH anahtarına (https://huggingface.co/settings/keys) ihtiyaç duyulur. Varsayılan değer False'tur.
  • network_group (str, isteğe bağlı) — Katılınacak ağ grubunun adı. Aynı namespace ve resource group içinde bir grubu paylaşan işler bir arada konumlandırılır ve her port üzerinden birbirine erişebilir. Her üyenin içinde, HF_NETWORK_GROUP_HOSTNAME grubun tüm üyelerine çözümlenir. Küçük harfli alfanümerik karakterler ve tireler, en fazla 46 karakter.
  • network_aliases (list[str], isteğe bağlı) — Bu işin ağ grubunda iddia ettiği takma adlar. Üyeler, bir takma adı iddia eden işlere ${HF_NETWORK_GROUP_PREFIX}<alias> üzerinden erişir. Birden fazla iş aynı takma adı iddia edebilir. Küçük harfli alfanümerik karakterler ve tireler, en fazla 34 karakter, iş içinde benzersiz. network_group gerektirir.
  • resource_group_id (str, isteğe bağlı) — Job'ın oluşturulacağı kaynak grubunun kimliği. Bir organizasyon içindeki kaynaklara erişimi kontrol etmek ve maliyet atama/harcama limiti özellikleri için kullanılır. Sağlanmazsa, Job herhangi bir kaynak grubunun dışında oluşturulur.
  • namespace (str, isteğe bağlı) — Job'ün oluşturulacağı namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında bir UV script Job çalıştırın.

hf jobs uv run'un aksine, bu yöntem, bir UV betiğinin PEP 723 başlığında taşıyabileceği isteğe bağlı [tool.hf-jobs] tablosunu görmezden gelir (Jobs kılavuzu bkz.): başlatma yapılandırmasının burada açıkça iletilmesi gerekir.

Örnek:

Bir URL'den betik çalıştırın:

>>> from huggingface_hub import run_uv_job
>>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small")

Yerel bir betik çalıştırın:

>>> from huggingface_hub import run_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small")

Komut çalıştırın:

>>> from huggingface_hub import run_uv_job
>>> script = "lighteval"
>>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"]
>>> run_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small")

Model denetim noktalarını eğitim sırasında kaydetmek için hacimler bağlayın:

>>> from huggingface_hub import Volume, run_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--output_dir", "/training-outputs/training-v3-final", ...]
>>> checkpoints_bucket = Volume(type="bucket", source="username/my-bucket", mount_path="/training-outputs")
>>> run_uv_job(script, script_args=script_args, volumes=[checkpoints_bucket])

scale_to_zero_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parametreler

  • name (str) — Sıfıra ölçeklendirilecek Inference Endpoint'in adı.
  • namespace (str, isteğe bağlı) — Inference Endpoint'in bulunduğu namespace. Varsayılan olarak mevcut kullanıcıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

InferenceEndpoint

sıfıra ölçeklendirilmiş Inference Endpoint hakkında bilgi.

Inference Endpoint'ı sıfıra ölçekleyin.

Sıfıra ölçeklendirilmiş bir Inference Endpoint için ücretlendirme yapılmaz. Bir sonraki istek geldiğinde, soğuk başlatma gecikmesiyle birlikte yeniden başlatılır. Bu, pause_inference_endpoint() ile Inference Endpoint'i duraklatmaktan farklıdır; bu durumda resume_inference_endpoint() ile manuel olarak yeniden başlatma gerektirir.

Kolaylık olması için, InferenceEndpoint.scale_to_zero() kullanarak bir Inference Endpoint'i sıfıra ölçeklendirebilirsiniz.

search_spaces

< >

( query: strfilter: str | Iterable[str] | None = Nonesdk: str | list[str] | None = Noneinclude_non_running: bool = Falsetoken: bool | str | None = None ) → Iterable[SpaceSearchResult]

Parametreler

  • query (str) — Arama sorgu dizesi.
  • filter (str veya Iterable[str], isteğe bağlı) — Filtreleme için bir dize etiket veya etiket listesi.
  • sdk (str veya list[str], isteğe bağlı) — SDK'ye göre filtrele (ör. "gradio", "docker", "static").
  • include_non_running (bool, isteğe bağlı) — Sonuçlara çalışmayan Spaces'lerin dahil edilip edilmeyeceğini belirtir. Varsayılan değeri False'tür.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

Iterable[SpaceSearchResult]

SpaceSearchResult nesnelerinden oluşan bir iterable.

Hub'da semantik arama kullanarak Arama Alanlarını arayın.

Bu uç nokta, çok kelimeli sorgular için anlamsal arama (gömme tabanlı) ve tek kelimeli sorgular için tam metin araması kullanır.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> results = list(api.search_spaces("generate image"))
>>> results[0].id
'mrfakename/Z-Image-Turbo'
>>> results[0].ai_category
'Image Generation'

set_space_sleep_time

< >

( repo_id: strsleep_time: inttoken: bool | str | None = None ) → SpaceRuntime

Parametreler

  • repo_id (str) — Güncellenecek depoyun kimliği. Örnek: "bigcode/in-the-stack".
  • sleep_time (int, isteğe bağlı) — Bir Space'in uyku moduna alınmadan önce beklenen hareketsizlik süresi (saniye cinsinden). Space'inizin duraklamasını istemiyorsanız -1 olarak ayarlayın (yükseltilmiş donanımlar için varsayılan davranış). Ücretsiz donanımlarda uyku süresi yapılandırılamaz (değer 48 saat hareketsizlik olarak sabittir). Daha fazla ayrıntı için https://huggingface.co/docs/hub/spaces-gpus#sleep-time adresine bakın.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

SpaceRuntime

Bir Space hakkında çalışma zamanı bilgileri, Space aşaması ve donanımı dahil.

Yükseltilmiş donanımda çalışan bir Space için özel bir uyku süresi ayarlayın.

X saniye boyunca hareketsizlik durumunda Space'iniz uyku moduna geçer. Space'iniz “sleep” modundayken faturalandırılmazsınız. Yeni bir ziyaretçi Space'inize ulaştığında, Space “uyandırılır”. Yalnızca yükseltilmiş donanımlarda yapılandırılabilir bir uyku süresi bulunabilir. Uyku aşaması hakkında daha fazla bilgi için https://huggingface.co/docs/hub/spaces-gpus#sleep-time adresine bakın.

Donanım istenirken request_space_hardware() ile özel bir uyku süresi ayarlamak da mümkündür.

set_space_volumes

< >

( repo_id: strvolumes: list[Volume]token: bool | str | None = None )

Parametreler

  • repo_id (str) — Güncellenecek Space'in kimliği. Örnek: "username/my-space".
  • volumes (list[Volume]) — Bağlanacak Volume nesnelerinin listesi. Her hacmin bir type ("bucket", "model", "dataset" veya "space"), bir source (repo veya bucket kimliği), bir mount_path (konteyner içindeki yol) ve isteğe bağlı revision, read_only ile path alanları vardır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

BadRequestError

  • BadRequestError — Space statik bir Space ise (statik Spaces'te volume desteklenmez).

Bir Space için ses seviyelerini ayarlayın.

Space'te bağlanan (mount) hacimlerin listesini ayarlar (veya değiştirir). Her hacim, Space'in konteynerine bir Hub kaynağına (model, veri seti veya depolama kovası) erişim sağlar.

Örnek:

>>> from huggingface_hub import HfApi, Volume
>>> api = HfApi()
>>> api.set_space_volumes(
...     "username/my-space",
...     volumes=[
...         Volume(type="model", source="username/my-model", mount_path="/models", read_only=True),
...         Volume(type="bucket", source="username/my-bucket", mount_path="/data"),
...     ],
... )

snapshot_download

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_dir: str | Path | None = Noneetag_timeout: float = 10force_download: bool = Falsetoken: bool | str | None = Nonelocal_files_only: bool = Falseallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonemax_workers: int = 8tqdm_class: type[base_tqdm] | None = Nonedry_run: bool = False ) → str or list of DryRunFileInfo

Parametreler

  • repo_id (str) — Bir kullanıcı veya kuruluş adı ile / ile ayrılmış bir depo adı.
  • repo_type (str, isteğe bağlı) — Bir veri setinden veya uzaydan indiriliyorsa "dataset" veya "space" olarak ayarlayın, bir modelden indiriliyorsa None veya "model". Varsayılan değer None'dir.
  • revision (str, isteğe bağlı) — Bir dal adı, etiket veya commit hash olabilecek isteğe bağlı bir Git revizyon kimliği.
  • cache_dir (str, Path, isteğe bağlı) — Önbelleğe alınan dosyaların saklandığı klasörün yolu.
  • local_dir (str veya Path, isteğe bağlı) — Verilirse, indirilen dosyalar bu dizinin altına yerleştirilir.
  • etag_timeout (float, isteğe bağlı, varsayılan 10) — ETAG alınırken, httpx2.request'e iletilen, sunucunun veri göndermesini bekleme süresi (saniye).
  • force_download (bool, isteğe bağlı, varsayılan False) — Dosya, yerel önbellekte zaten mevcut olsa bile indirilip indirilmeyeceğini belirtir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • local_files_only (bool, isteğe bağlı, varsayılan False) — True ise, dosyanın indirilmesini engeller ve varsa yerel önbellekteki dosyanın yolunu döndürür.
  • allow_patterns (list[str] veya str, isteğe bağlı) — Verilirse, en az bir desenle eşleşen dosyalar indirilir.
  • ignore_patterns (list[str] veya str, isteğe bağlı) — Verilirse, desenlerden herhangi biriyle eşleşen dosyalar indirilmez.
  • max_workers (int, isteğe bağlı) — Dosyaları indirmek için kullanılacak eşzamanlı iş parçacığı sayısı (1 iş parçacığı = 1 dosya indirme). Varsayılan değer 8'dir.
  • tqdm_class (tqdm, isteğe bağlı) — Verilirse, ilerleme çubuğu için varsayılan davranışı yazar. Geçirilen argüman, tqdm.auto.tqdm sınıfından türemeli veya en azından davranışını taklit etmelidir. tqdm_class'in her bireysel indirmeye geçirilmediğine dikkat edin. Varsayılan olarak, HF_HUB_DISABLE_PROGRESS_BARS ortam değişkeni ayarlanarak devre dışı bırakılabilen özel HF ilerleme çubuğudur.
  • dry_run (bool, isteğe bağlı, varsayılan False) — True ise, dosyaları gerçekten indirmeden kuru bir çalışma (dry run) gerçekleştirir. İndirilecekler hakkında bilgi içeren DryRunFileInfo nesnelerinden oluşan bir liste döndürür.

Dönüş değeri

str veya DryRunFileInfo listesi

  • dry_run=False ise: Depo anlık görüntüsünün klasör yolu.
  • dry_run=True ise: İndirme bilgilerini içeren DryRunFileInfo nesnelerinden oluşan bir liste.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError veya EnvironmentError veya OSError veya ValueError

  • RepositoryNotFoundError — İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.
  • RevisionNotFoundError — İndirilecek revizyon bulunamadığında.
  • EnvironmentError — token=True ise ve token bulunamazsa.
  • OSError — ETag belirlenemezse.
  • ValueError — bazı bir parametre değeri geçersizse.

Depo dosyalarını indirin.

Belirtilen revizyonda bir depodaki dosyaların tamamını içeren bir anlık görüntüyü indirir. Bir depodaki tüm dosyalara ihtiyacınız olduğunda, önceden hangi dosyaların gerekli olacağını bilmediğiniz durumlarda bu işe yarar. Tüm dosyalar, o klasöre göre gerçek dosya adlarını korumak amacıyla bir klasörün içine yerleştirilir. allow_patterns ve ignore_patterns kullanarak hangi dosyaların indirileceğini filtreleyebilirsiniz.

local_dir sağlanırsa, depodaki dosya yapısı bu konumda yeniden oluşturulur. Bu seçeneği kullanırken cache_dir kullanılmaz ve indirilen dosyalarla ilgili bazı meta verileri depolamak için local_dir kökünde bir .cache/huggingface/ klasörü oluşturulur. Bu mekanizma ana önbellek sistemi kadar sağlam olmasa da, bir deponun en son sürümünü düzenli olarak çekmek için optimize edilmiştir.

Alternatif olarak, depoyu klonlamak mümkündür ancak bunun için git ve git-lfs'in yüklü ve doğru şekilde yapılandırılmış olması gerekir. Ayrıca git kullanarak bir depoyu klonlarken indirilecek dosyaları filtrelemek de mümkün değildir.

space_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandSpaceProperty_T] | None = Nonetoken: bool | str | None = None ) → SpaceInfo

Parametreler

  • repo_id (str) — Bir / ile ayrılmış bir ad alanı (kullanıcı veya kuruluş) ve bir depo adı.
  • revision (str, isteğe bağlı) — Bilgilerin alınacağı space deposunun revizyonu.
  • timeout (float, isteğe bağlı) — Hub'a yapılan istek için bir zaman aşımı ayarlanıp ayarlanmayacağı.
  • files_metadata (bool, isteğe bağlı) — Depodaki dosyalar için (boyut, LFS meta verisi vb.) meta verilerin alınıp alınmayacağı. Varsayılan değer False.
  • expand (list[ExpandSpaceProperty_T], isteğe bağlı) — Yanıtta döndürülecek özelliklerin listesi. Kullanıldığında, yalnızca listedeki özellikler döndürülür. full parametresi geçirildiğinde bu parametre kullanılamaz. Olası değerler "author", "cardData", "createdAt", "datasets", "disabled", "lastModified", "likes", "models", "private", "region", "runtime", "sdk", "siblings", "sha", "subdomain", "tags", "trendingScore", "usedStorage" ve "resourceGroup"'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

SpaceInfo

Space deposu bilgileri.

huggingface.co'daki belirli bir Space hakkında bilgi alın.

Geçerli bir token iletirseniz Space özel olabilir.

Aşağıdaki hataları oluşturur:

  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.
  • RevisionNotFoundError İndirilecek revizyon bulunamadığında.

super_squash_history

< >

( repo_id: strbranch: str | None = Nonecommit_message: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None )

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı.
  • branch (str, isteğe bağlı) — Birleştirilecek dal. Varsayılan olarak "main" dalının başıdır.
  • commit_message (str, isteğe bağlı) — Birleştirilen commit için kullanılacak commit mesajı.
  • repo_type (str, isteğe bağlı) — Bir veri seti veya Space'ten commit listesi alınıyorsa "dataset" veya "space", modelden listeleniyorsa None veya "model" olarak ayarlayın. Varsayılan değer None'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError veya BadRequestError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.
  • RevisionNotFoundError — Sıkıştırılacak dal bulunamazsa.
  • BadRequestError — Geçersiz bir branch referansı belirtildiğinde. Tag'lerde geçmiş birleştirilemez (squash).

Hub'daki bir repoda bir dal için commit geçmişini birleştirin.

Depo geçmişini sıkıştırmak, yüzlerce commit yapacağınızı biliyorsanız ve geçmişi dağınık hale getirmek istemiyorsanız faydalıdır. Commit'leri sıkıştırmak yalnızca bir branch'in başından (head) yapılabilir.

Sıkıştırıldıktan sonra, commit geçmişi geri alınamaz. Bu, geri alınamaz bir işlemdir.

Bir dalın geçmişi birleştirildikten (squash) sonra, geçmişleri ayrıldığı için başka bir dala geri birleştirilemez.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Create repo
>>> repo_id = api.create_repo("test-squash").repo_id

# Make a lot of commits.
>>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"content")
>>> api.upload_file(repo_id=repo_id, path_in_repo="lfs.bin", path_or_fileobj=b"content")
>>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"another_content")

# Squash history
>>> api.super_squash_history(repo_id=repo_id)

suspend_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • scheduled_job_id (str) — Planlanan Job'un kimliği.
  • namespace (str, isteğe bağlı) — Planlanan Job'un bulunduğu namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face altyapısında zamanlanmış bir hesaplama İşini askıya alın (durdurun).

sync_bucket

< >

( source: str | None = Nonedest: str | None = Nonedelete: bool = Falseignore_times: bool = Falseignore_sizes: bool = Falseexisting: bool = Falseignore_existing: bool = Falseinclude: list[str] | None = Noneexclude: list[str] | None = Nonefilter_from: str | None = Noneplan: str | None = Noneapply: str | None = Nonedry_run: bool = Falseverbose: bool = Falsequiet: bool = Falsetoken: bool | str | None = None ) → [SyncPlan]

Parametreler

  • source (str, isteğe bağlı) — Kaynak yolu: yerel dizin veya hf://buckets/namespace/bucket_name(/prefix). apply kullanılmadığı sürece zorunludur.
  • dest (str, isteğe bağlı) — Hedef yol: yerel dizin veya hf://buckets/namespace/bucket_name(/prefix). apply kullanılmadığı sürece zorunludur.
  • delete (bool, isteğe bağlı, varsayılan False) — Kaynakta bulunmayan hedef dosyaları siler.
  • ignore_times (bool, isteğe bağlı, varsayılan False) — Dosyaları yalnızca boyuta göre atlayın, değişiklik zamanlarını yok sayın.
  • ignore_sizes (bool, isteğe bağlı, varsayılan False) — Dosyaları yalnızca değiştirilme zamanlarına göre atlayın, boyutları yok sayın.
  • existing (bool, isteğe bağlı, varsayılan False) — Alıcıda yeni dosya oluşturmaktan kaçının (yalnızca mevcut dosyaları güncelleyin).
  • ignore_existing (bool, isteğe bağlı, varsayılan False) — Alıcıda zaten var olan dosyaların güncellenmesini atlayın (yalnızca yeni dosyalar oluşturun).
  • include (list[str], opsiyonel) — Desenlerle eşleşen dosyaları dahil edin (fnmatch tarzı).
  • exclude (list[str], opsiyonel) — Desenlerle eşleşen dosyaları hariç tutar (fnmatch tarzı).
  • filter_from (str, isteğe bağlı) — Kapsama/dışlama kuralları içeren bir filtre dosyasının yolu.
  • plan (str, opsiyonel) — Senkronizasyon planını çalıştırmak yerine bu JSONL dosyasına kaydet.
  • apply (str, optional) — Daha önce kaydedilmiş bir plan dosyasını uygular. Ayarlandığında source ve dest gerekmez.
  • dry_run (bool, isteğe bağlı, varsayılan False) — Senkronizasyon planını çalıştırmadan stdout'a JSONL olarak yazdırır.
  • verbose (bool, isteğe bağlı, varsayılan False) — Dosya başına ayrıntılı işlemleri gösterir.
  • quiet (bool, isteğe bağlı, varsayılan False) — Tüm çıktıları ve ilerleme çubuklarını bastırır.
  • token (Union[bool, str, None], optional) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, yerel olarak kaydedilmiş belirteç kullanılır.

Dönüş değeri

[SyncPlan]

Hesaplanan (veya yüklenen) senkronizasyon planı.

Yerel bir dizin ile bir varlık kovası (bucket) arasındaki dosyaları senkronize edin.

Bu, hf buckets sync komut satırı komutuna eşdeğerdir. source veya dest parametrelerinden biri bir bucket yolu (hf://buckets/...) ve diğeri bir yerel dizin yolu olmalıdır.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Upload local directory to bucket
>>> api.sync_bucket("./data", "hf://buckets/username/my-bucket")

# Download bucket to local directory
>>> api.sync_bucket("hf://buckets/username/my-bucket", "./data")

# Sync with delete and filtering
>>> api.sync_bucket(
...     "./data",
...     "hf://buckets/username/my-bucket",
...     delete=True,
...     include=["*.safetensors"],
... )

# Dry run: preview what would be synced
>>> plan = api.sync_bucket("./data", "hf://buckets/username/my-bucket", dry_run=True)
>>> plan.summary()
{'uploads': 3, 'downloads': 0, 'deletes': 0, 'skips': 1, 'total_size': 4096}

# Save plan for review, then apply
>>> api.sync_bucket("./data", "hf://buckets/username/my-bucket", plan="sync-plan.jsonl")
>>> api.sync_bucket(apply="sync-plan.jsonl")

sync_job_volume

< >

( source: str | Pathmount_path: strremote_name: str | None = Noneread_only: bool = Truenamespace: str | None = Nonetoken: bool | str | None = None ) → Volume

Parametreler

  • source (str veya Path) — Senkronize edilecek yerel dizinin yolu.
  • mount_path (str) — Job konteyneri içindeki bağlama yolu, örn. "/inputs". / ile başlamalıdır.
  • remote_name (str, isteğe bağlı) — Senkronize edilecek bucket alt klasörünün adı. Varsayılan olarak, kaynak yolundan ve makinenin ana bilgisayar adından türetilen bir {dirname}-{hash} adıdır.
  • read_only (bool, isteğe bağlı, varsayılan True) — Hacimi Job'da salt okunur olarak bağlar. Job'un bucket klasörüne geri yazabilmesi için False geçirin (ör. çıktıları daha sonra sync_bucket() ile almak için).
  • namespace (str, isteğe bağlı) — jobs-artifacts varillerini (bucket) barındıran namespace. Varsayılan olarak kullanıcının mevcut namespace'i kullanılır. Hacmi (volume) bağlayacak Job ile aynı namespace'i kullanın.
  • token (Union[bool, str, None], isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

Hacim

Eşitlenmiş alt klasöre göre kapsamlandırılmış bir bucket hacmi, run_job(), run_uv_job(), create_scheduled_job() veya create_scheduled_uv_job() içindeki volumes listesine iletmek için.

Yerel bir dizini bir kovaya (bucket) eşitleyin ve bir İş (Job) içinde bağlanmaya hazır bir Volume döndürün.

Dosyalar, sync_bucket() ile aynı senkronizasyon mantığını kullanarak {namespace}/jobs-artifacts varlığının bir alt klasörüne yüklenir (otomatik olarak özel olarak oluşturulur; zaten var ve herkese açıksa bir uyarı yayılır): aynı dizinin yeniden senkronize edilmesi yalnızca yeni veya değiştirilmiş dosyaları yükler. Varsayılan olarak alt klasör adı, dizin yolundan ve makinenin ana bilgisayar adından türetilir, böylece aynı dizinden yapılan tekrarlayan çağrılar aynı uzak klasörü yeniden kullanır. Bunun yerine sabit bir ad kullanmak için remote_name parametresini iletin.

Verinin canlı olarak bağlanmadığını, kovaya kopyalandığını unutmayın: senkronizasyon sonrası yerel olarak yapılan değişiklikler Job tarafından görünmez (güncellemek için sync_job_volume komutunu yeniden çalıştırın) ve hacim varsayılan olarak salt okunur olarak bağlanır. Bir Job tarafından salt okunur-yazılır bir hacme yazılan verileri almak için kovadaki klasörü sync_bucket() ile geri senkronize edin. Kaynak dizin boşsa (ör. bir çıktı dizini), hacmin yine de bağlanabilmesi için bir yer tutucu .keep dosyası yüklenir.

Örnek:

>>> from huggingface_hub import run_uv_job, sync_job_volume

# Upload ./training-data once, then run multiple jobs against it
>>> volume = sync_job_volume("./training-data", "/data")
>>> run_uv_job("train.py", script_args=["--learning-rate", "0.01"], volumes=[volume])
>>> run_uv_job("train.py", script_args=["--learning-rate", "0.05"], volumes=[volume])

# Read-write volume to retrieve outputs after the job completes
>>> volume = sync_job_volume("./outputs", "/outputs", read_only=False)
>>> job = run_uv_job("process.py", volumes=[volume])

trigger_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Parametreler

  • scheduled_job_id (str) — Planlanan Job'un kimliği.
  • namespace (str, isteğe bağlı) — Planlanan Job'un bulunduğu namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

JobInfo

Tetiklenen çalışmaya dair bilgi.

Yükseltilen

HfHubHTTPError

  • HfHubHTTPError — Zaten başka bir örnek çalışıyorsa ve zamanlanmış işte concurrency devre dışıysa HTTP 409.

Planlanmış bir Job'ı derhal çalıştırmak için tetikleyin.

Bu, zamanlanmış işin spec'ini bir kez derhal çalıştırır. Zamanlamayı değiştirmez ve bir sonraki zamanlanmış çalışmayı etkilemez. Bir örnek zaten çalışıyorsa ve zamanlanmış iş eşzamanlı çalıştırmalara izin vermiyorsa, istek reddedilir (HTTP 409).

gibi değil

< >

( repo_id: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Parametreler

  • repo_id (str) — Beğenilmeyecek depo. Örnek: "user/my-cool-model".
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri seti veya alanın beğenisi kaldırılıyorsa "dataset" veya "space", bir modelin beğenisi kaldırılıyorsa None veya "model" olarak ayarlayın. Varsayılan değer None'dir.

Yükseltilen

RepositoryNotFoundError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.

Hub'daki belirli bir repodan farklı olarak (ör. favori listesinden kaldır).

Spam kullanımını önlemek için bir betikten bir depoya like gönderilemez.

Ayrıca list_liked_repos() bkz.

Örnek:

>>> from huggingface_hub import list_liked_repos, unlike
>>> "gpt2" in list_liked_repos().models # we assume you have already liked gpt2
True
>>> unlike("gpt2")
>>> "gpt2" in list_liked_repos().models
False

update_bucket_settings

< >

( bucket_id: strprivate: booltoken: bool | str | None = None )

Parametreler

  • bucket_id (str) — Kovanın kimliği (ör. "username/my-bucket").
  • private (bool) — Kovanın özel olarak ayarlanıp ayarlanmayacağı.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Yükseltilen

BucketNotFoundError veya or

  • BucketNotFoundError — Bucket bulunamadığında. Bunun nedeni, bucket'ın var olmaması olabilir,
  • or — çünkü private olarak ayarlanmış ve erişiminiz yok.

Hub'da bir varlığın ayarlarını güncelleyin.

Şu anda desteklenen tek ayar, varlığın görünürlüğüdür.

Örnek:

>>> from huggingface_hub import update_bucket_settings

>>> # Make a bucket public
>>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=False)

>>> # Make it private again
>>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=True)

update_collection_item

< >

( collection_slug: stritem_object_id: strnote: str | None = Noneposition: int | None = Nonetoken: bool | str | None = None )

Parametreler

  • collection_slug (str) — Güncellenecek koleksiyonun slug'ı. Örnek: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_object_id (str) — Koleksiyondaki öğenin kimliği. Bu, öğenin Hub'daki kimliği (repo_id veya makale kimliği) değildir. Bir CollectionItem nesnesinden alınmalıdır. Örnek: collection.items[0].item_object_id.
  • note (str, isteğe bağlı) — Koleksiyondaki öğeye eklenmesi gereken bir not. Bir notun maksimum boyutu 500 karakterdir.
  • position (int, isteğe bağlı) — Öğenin koleksiyondaki yeni konumu.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir koleksiyondaki öğeyi günceller.

Örnek:

>>> from huggingface_hub import get_collection, update_collection_item

# Get collection first
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")

# Update item based on its ID (add note + update position)
>>> update_collection_item(
...     collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",
...     item_object_id=collection.items[-1].item_object_id,
...     note="Newly updated model!",
...     position=0,
... )

update_collection_metadata

< >

( collection_slug: strtitle: str | None = Nonedescription: str | None = Noneposition: int | None = Noneprivate: bool | None = Nonetheme: str | None = Nonetoken: bool | str | None = None )

Parametreler

  • collection_slug (str) — Güncellenecek koleksiyonun slug'ı. Örnek: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • title (str) — Güncellenecek koleksiyonun başlığı.
  • description (str, isteğe bağlı) — Güncellenecek koleksiyonun açıklaması. Bir açıklama için maksimum boyut 150 karakterdir.
  • position (int, isteğe bağlı) — Kullanıcının koleksiyonları listesinde koleksiyonun yeni konumu.
  • private (bool, isteğe bağlı) — Koleksiyonun özel olup olmayacağı.
  • theme (str, isteğe bağlı) — Hub'daki koleksiyonun teması.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Hub'daki bir koleksiyonun meta verilerini günceller.

Tüm argümanlar isteğe bağlıdır. Yalnızca sağlanan meta veriler güncellenir.

Dönüş: Collection

Örnek:

>>> from huggingface_hub import update_collection_metadata
>>> collection = update_collection_metadata(
...     collection_slug="username/iccv-2023-64f9a55bb3115b4f513ec026",
...     title="ICCV Oct. 2023",
...     description="Portfolio of models, datasets, papers and demos I presented at ICCV Oct. 2023",
...     private=False,
...     theme="pink",
... )
>>> collection.slug
"username/iccv-oct-2023-64f9a55bb3115b4f513ec026"
# ^collection slug got updated but not the trailing ID

update_collection_resource_group

< >

( collection_slug: strresource_group_id: str | Nonetoken: bool | str | None = None )

Parametreler

  • collection_slug (str) — Güncellenecek koleksiyonun slug'ı. Örnek: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • resource_group_id (str or None) — Koleksiyonun atanacağı kaynak grubu, 24 karakterli onaltılık bir dize olarak. None ise, koleksiyon herhangi bir kaynak grubundan kaldırılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Bir koleksiyonu bir kaynak grubuna atayın veya herhangi bir kaynak grubundan kaldırın.

Yalnızca organizasyona ait koleksiyonlar için geçerlidir.

Örnek:

>>> from huggingface_hub import update_collection_resource_group
>>> update_collection_resource_group(
...     collection_slug="my-org/iccv-2023-64f9a55bb3115b4f513ec026",
...     resource_group_id="66980ecfc1e12a49c8f0e42d",
... )

update_inference_endpoint

< >

( name: straccelerator: str | None = Noneinstance_size: str | None = Noneinstance_type: str | None = Nonemin_replica: int | None = Nonemax_replica: int | None = Nonescale_to_zero_timeout: int | None = Nonescaling_metric: InferenceEndpointScalingMetric | None = Nonescaling_threshold: float | None = Nonerepository: str | None = Noneframework: str | None = Nonerevision: str | None = Nonetask: str | None = Nonecustom_image: dict | None = Nonecontainer_command: list[str] | None = Nonecontainer_args: list[str] | None = Nonetensor_parallel_size: int | None = Nonedata_parallel_size: int | None = Noneenv: dict[str, str] | None = Nonesecrets: dict[str, str] | None = Nonedomain: str | None = Nonepath: str | None = Nonecache_http_responses: bool | None = Nonetags: list[str] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parametreler

  • name (str) — Güncellenecek Inference Endpoint adını belirtir.
  • accelerator (str, isteğe bağlı) — Çıkarım için kullanılacak donanım hızlandırıcısı (ör. "cpu").
  • instance_size (str, isteğe bağlı) — Modelin barındırılmasında kullanılacak örneğin boyutu veya türü (ör. "x4").
  • instance_type (str, isteğe bağlı) — Inference Endpoint'in dağıtılacağı bulut örnek türü (ör. "intel-icl").
  • min_replica (int, isteğe bağlı) — Inference Endpoint için çalışmaya devam ettirilecek en az replika (örnek) sayısı.
  • max_replica (int, isteğe bağlı) — Inference Endpoint için ölçeklenecek maksimum replika (örnek) sayısı.
  • scale_to_zero_timeout (int, isteğe bağlı) — Pasif bir uç noktanın sıfıra ölçeklenmeden önce geçen dakika cinsinden süre.
  • scaling_metric (str veya InferenceEndpointScalingMetric , isteğe bağlı) — Ölçeklendirme için metrik referansı. Verildiğinde “pendingRequests” veya “hardwareUsage” olmalıdır. Varsayılan değeri None'dır.
  • scaling_threshold (float, isteğe bağlı) — Yukarı ölçeklemeyi tetiklemek için kullanılan ölçekleme metriği eşiği. Ölçekleme metriği sağlanmadığında yok sayılır. Varsayılan değeri None'dir.
  • repository (str, isteğe bağlı) — Inference Endpoint ile ilişkili model deposunun adı (ör. "gpt2").
  • framework (str, isteğe bağlı) — Model için kullanılan makine öğrenimi çerçevesi (ör. "custom").
  • revision (str, isteğe bağlı) — Inference Endpoint üzerinde dağıtılacak belirli model revizyonu (ör. "6c0e6080953db56375760c0471a8c5f2929baf11").
  • task (str, isteğe bağlı) — Modelin dağıtılacağı görev (ör. "text-classification").
  • custom_image (dict, isteğe bağlı) — Çalıştırılacak konteyner görüntüsü. Anahtarları görüntü varyantı olan bir sözlük (ör. {"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}‌}, ayrıca sGLang, tgi, tei, llamacpp, hfServe, …) olarak, olduğu gibi iletilebilir veya özel bir konteyneri tanımlayan düz bir sözlük (ör. {"url": ..., "port": ...}) olarak, {"custom": ...} olarak gönderilebilir.
  • container_command (list[str], isteğe bağlı) — Kapsayıcı giriş noktası komutunu geçersiz kılar (API yükünde model.command alanına eşlenir). Hem yönetilen motor görüntüleriyle (ör. vLLM, SGLang) hem de özel görüntülerle çalışır.
  • container_args (list[str], isteğe bağlı) — Kapsayıcı giriş noktasına eklenen argümanlar (API yüklemesinde model.args alanına eşlenir). Hem yönetilen motor görüntüleriyle (ör. vLLM, SGLang) hem de özel görüntülerle çalışır.
  • tensor_parallel_size (int, isteğe bağlı) — Tek bir model kopyasının dağıtılacağı hızlandırıcı sayısı (vLLM ve SGLang görüntüleri). Motor görüntü yapılandırmasının içine yazılır. API, model.image alanını bütünüyle gerektirdiğinden, custom_image verilmediğinde uç noktada (endpoint) şu anda yapılandırılmış görüntü getirilir ve yerinde güncellenir.
  • data_parallel_size (int, isteğe bağlı) — Çalıştırılacak model kopyalarının sayısı, hızlandırıcı başına bir adet (vLLM görüntüleri). tensor_parallel_size ile aynı işleme tabidir.
  • env (dict[str, str], isteğe bağlı) — Kapsayıcı ortamına enjekte edilecek gizli olmayan ortam değişkenleri
  • secrets (dict[str, str], isteğe bağlı) — Kapsayıcı ortamına enjekte edilecek gizli değerler.
  • domain (str, isteğe bağlı) — Inference Endpoint dağıtımı için özel alan adı; yapılandırılırsa inference endpoint bu alan adında kullanılabilir hale gelir (ör. "my-new-domain.cool-website.woof").
  • path (str, isteğe bağlı) — Dağıtılan modele özel yol, / ile başlamalıdır (ör. "/models/google-bert/bert-base-uncased").
  • cache_http_responses (bool, isteğe bağlı) — Inference Endpoint'ten gelen HTTP yanıtlarının önbelleğe alınıp alınmayacağı.
  • tags (list[str], isteğe bağlı) — Inference Endpoint ile ilişkilendirilecek etiketlerin listesi.
  • namespace (str, isteğe bağlı) — Inference Endpoint'in güncelleneceği namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

InferenceEndpoint

güncellenmiş Inference Endpoint hakkında bilgi.

Bir Inference Endpoint güncelleyin.

Bu yöntem, hesaplama yapılandırmasının, dağıtılan modelin, rotanın veya bunların herhangi bir kombinasyonunun güncellenmesine olanak tanır. Tüm argümanlar isteğe bağlıdır ancak en az birinin sağlanması gerekir.

Kolaylık olması için bir Inference Endpoint'i InferenceEndpoint.update() kullanarak da güncelleyebilirsiniz.

update_job_expose

< >

( job_id: strexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Parametreler

  • job_id (str) — Çalışan Job'un kimliği.
  • expose (list[int], isteğe bağlı) — Jobs proxy üzerinden açılacak portlar. Erişim, Job’un namespace’ine okuma erişimi olan bir HF token gerektirir.
  • expose_public (list[int], isteğe bağlı) — Kimlik doğrulama olmadan Jobs vekili üzerinden açılacak portlar. Bunların expose içinde listelenmesine gerek yoktur.
  • namespace (str, isteğe bağlı) — Görevin ad alanı. Varsayılan olarak kullanıcının mevcut ad alanı kullanılır.
  • token (bool veya str, isteğe bağlı) — Kullanıcı erişim belirteci. Varsayılan olarak yerel olarak kaydedilmiş belirteç kullanılır.

Dönüş değeri

JobInfo

Güncellenmiş İş.

Çalışan bir Job'ın dışa açılan portlarını yeniden çalıştırmadan değiştirin.

expose ve expose_public birlikte tam port yapılandırmasını oluşturur: her iki listede de olmayan portlar kapalıdır. Tüm açık portları kapatmak için ikisini de geçmeyin.

update_job_labels

< >

( job_id: strlabels: dict[str, str]namespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Parametreler

  • job_id (str) — Job'un kimliği.
  • labels (dict[str, str]) — İş için ayarlanacak yeni etiketler. Mevcut tüm etiketlerin yerini alır. Hem anahtarlar hem de değerler en fazla 100 karakter olmalı ve yalnızca alfanümerik karakterler, tireler ve alt çizgiler içermelidir.
  • namespace (str, isteğe bağlı) — Job'un çalıştığı namespace. Varsayılan olarak kullanıcının mevcut namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

JobInfo

Güncellenmiş İş bilgisi.

Mevcut bir Job'un etiketlerini günceller.

Tüm mevcut kullanıcı sağlanan etiketleri yeni etiketlerle değiştirir.

update_repo_settings

< >

( repo_id: strgated: Literal['auto', 'manual', False] | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = None )

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı.
  • gated (Literal["auto", "manual", False], isteğe bağlı) — Depo için gated durumu. Ayarlanırsa None (varsayılan olarak, depodaki gated ayarları güncellenmez.
    • “auto”: Depo kapalıdır ve erişim istekleri, önceden tanımlanmış kriterlere göre otomatik olarak onaylanır veya reddedilir.
    • “manual”: Depo kapalıdır ve erişim istekleri manuel onay gerektirir.
    • False : Depo kapalı değil ve herkes erişebilir.
  • private (bool, isteğe bağlı) — Deponun özel olup olmayacağı. visibility parametresiyle birlikte geçirilemez.
  • visibility (Literal["public", "private", "protected"], isteğe bağlı) — Deponun görünürlüğü. "public" veya "private" olabilir, Spaces için "protected" olabilir.
  • token (Union[str, bool, None], isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Ayarların güncelleneceği depoyun türü ("model", "dataset" veya "space"). Varsayılan değer "model"'dir.

Yükseltilen

ValueError veya HfHubHTTPError veya RepositoryNotFoundError

  • ValueError — gated, “auto”, “manual” veya False değerlerinden biri değilse.
  • ValueError — repo_type, constants.REPO_TYPES içindeki değerlerden biri değilse.
  • HfHubHTTPError — Hugging Face Hub API'ye yapılan istek başarısız olursa.
  • RepositoryNotFoundError — İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.

Gated erişim ve görünürlük dahil olmak üzere bir depoyun ayarlarını günceller.

Depoların kullanımına daha fazla kontrol sağlamak için Hub, depo yazarlarının depoları için erişim isteklerini etkinleştirmesine ve deponun görünürlüğünü değiştirmesine olanak tanır.

update_scheduled_job_labels

< >

( scheduled_job_id: strlabels: dict[str, str]namespace: str | None = Nonetoken: bool | str | None = None ) → ScheduledJobInfo

Parametreler

  • scheduled_job_id (str) — Planlanan Job'un kimliği.
  • labels (dict[str, str]) — Planlanan işe ayarlanacak yeni etiketler. Mevcut tüm etiketlerin yerini alır. Hem anahtarlar hem de değerler en fazla 100 karakter olmalı ve yalnızca alfanümerik karakterler, tireler ve alt çizgiler içermelidir.
  • namespace (str, isteğe bağlı) — Planlanan Job'un bulunduğu namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

ScheduledJobInfo

Güncellenmiş zamanlanmış İş bilgisi.

Mevcut zamanlanmış bir Job'un etiketlerini günceller.

Tüm mevcut kullanıcı sağlanan etiketleri yeni etiketlerle değiştirir.

update_scheduled_job_schedule

< >

( scheduled_job_id: strschedule: strnamespace: str | None = Nonetoken: bool | str | None = None ) → ScheduledJobInfo

Parametreler

  • scheduled_job_id (str) — Planlanan Job'un kimliği.
  • schedule (str) — “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly” değerlerinden biri veya bir CRON zamanlama ifadesi (ör. her Pazartesi saat 9:00 için ‘0 9 * * 1’).
  • namespace (str, isteğe bağlı) — Planlanan Job'un bulunduğu namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

ScheduledJobInfo

Güncellenmiş zamanlanmış İş bilgisi.

Mevcut zamanlanmış bir Job'un ne zaman çalışacağını değiştirin.

Yalnızca zamanlama güncellenir: Job spec, etiketler ve askıya alınmış durum korunur. Zamanlanmış Job'ı zamanlamasını değiştirmeden şimdi bir kez çalıştırmak için bunun yerine trigger_scheduled_job() kullanın.

Örnek:

>>> from huggingface_hub import update_scheduled_job_schedule
>>> scheduled_job = update_scheduled_job_schedule(scheduled_job_id="6abb8dc9c617607c354d45f4", schedule="@daily")
>>> scheduled_job.schedule
'@daily'

update_webhook

< >

( webhook_id: strurl: str | None = Nonejob_id: str | None = Nonewatched: list[dict | WebhookWatchedItem] | None = Nonedomains: list[constants.WEBHOOK_DOMAIN_T] | None = Nonesecret: str | None = Nonesecrets: dict[str, str] | None = Nonetoken: bool | str | None = None ) → WebhookInfo

Parametreler

  • webhook_id (str) — Güncellenecek webhook'un benzersiz tanımlayıcısı.
  • url (str, isteğe bağlı) — Yükün gönderileceği URL.
  • job_id (str, isteğe bağlı) — Webhook yüküyle tetiklenecek kaynak Job'un kimliği. secrets ayarlanırken zorunludur.
  • watched (list[WebhookWatchedItem], optional) — İzlenecek öğelerin listesi. Kullanıcılar, kuruluşlar, modeller, veri kümeleri veya uzaylar olabilir. Daha fazla ayrıntı için WebhookWatchedItem öğesine bakın. İzlenen öğeler düz sözlükler olarak da sağlanabilir.
  • domains (list[Literal["repo", "discussion"]], opsiyonel) — İzlenecek alanlar. Bu, “repo”, “discussion” veya her ikisini içerebilir.
  • secret (str, optional) — Yükü imzalamak için kullanılan ve ek bir güvenlik katmanı sağlayan gizli anahtar.
  • secrets (dict[str, str], optional) — Webhook tarafından tetiklenen Job için gizli ortam değişkenleri. Listelenen anahtarlar, depolanan değeri değiştirir; boş bir dize o gizli değeri kaldırır; atlanan anahtarlar ise depolanan değerlerini korur. job_id gerektirir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

WebhookInfo

Güncellenen webhook hakkında bilgi.

Mevcut bir webhook'ü güncelleyin.

Örnek:

>>> from huggingface_hub import update_webhook
>>> updated_payload = update_webhook(
...     webhook_id="654bbbc16f2ec14d77f109cc",
...     url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     domains=["repo"],
...     secret="my-secret",
... )
>>> print(updated_payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo"],
    secret="my-secret",
    disabled=False,

upload_attachment

< >

( path: str | Pathtoken: bool | str | None = None ) → str

Parametreler

  • path (str veya Path) — Yüklenmesi gereken dosyanın yolu. Desteklenen biçimler PNG, JPEG, GIF, WebP, MP4, MOV, WebM, MP3 ve WAV'dir. Dosyalar 10MB'tan (videolar için 50MB) küçük olmalıdır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Belirtecin discussion.write iznine sahip olması gerekir. Anonim olarak yüklemek için False geçirin.

Dönüş değeri

str

yüklenen dosyanın URL'si.

Yükseltilen

ValueError

Bir görüntü, video veya ses dosyasını Hub'a yükler ve URL'sini döndürür.

Hub web düzenleyicisi, bir dosyayı Tartışma veya Pull Request yorum kutusuna sürüklediğinizde bunu yapar. Dönen URL'yi bir açıklamaya veya yoruma gömün: bir görsel için ![alt text](url), bir video için çıplak URL ve bir ses dosyası için <audio controls src="url"></audio>.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> url = api.upload_attachment("screenshot.png")
>>> api.create_discussion("username/my-model", title="Rendering bug", description=f"![screenshot]({url})")

upload_file

< >

( path_or_fileobj: str | Path | bytes | BinaryIOpath_in_repo: strrepo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = Nonerun_as_future: bool = False_hot_reload: bool | None = None ) → CommitInfo or Future

Parametreler

  • path_or_fileobj (str, Path, bytes veya IO) — Yerel makinedeki bir dosyanın yolu veya ikili veri akışı / fileobj / tampon.
  • path_in_repo (str) — Depodaki göreli dosya yolu, örneğin: "checkpoints/1fec34a/weights.bin"
  • repo_id (str) — Dosyanın yükleneceği depo, örneğin: "username/custom_transformers"
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri seti, alan veya çekirdek deposuna yükleniyorsa "dataset", "space" veya "kernel" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan None'dir.
  • revision (str, isteğe bağlı) — Taahhüt edilecek git revizyonu. Varsayılan olarak "main" dalının başıdır.
  • commit_message (str, isteğe bağlı) — Oluşturulan commit'in özeti / başlığı / ilk satırı
  • commit_description (str, isteğe bağlı) — Oluşturulan commit'in açıklaması
  • create_pr (boolean, isteğe bağlı) — Bu commit ile bir Pull Request oluşturulup oluşturulmayacağı. Varsayılan olarak False. revision ayarlanmadıysa, PR "main" dalına karşı açılır. revision ayarlandıysa ve bir dal ise, PR bu dala karşı açılır. revision ayarlandıysa ve bir dal adı değilse (örneğin: bir commit oid), sunucu tarafından RevisionNotFoundError döndürülür.
  • parent_commit (str, isteğe bağlı) — Ebeveyn commit'in OID / SHA'sı, onaltılık bir dize olarak. Kısaltmalar (ilk 7 karakter) de desteklenir. Belirtilirse ve create_pr False ise, revision parent_commit'e işaret etmiyorsa commit başarısız olur. Belirtilirse ve create_pr True ise, pull request parent_commit'ten oluşturulur. parent_commit'in belirtilmesi, değişiklikler commit edilmeden önce repoyun değişmediğinden emin olunmasını sağlar ve repoyun eşzamanlı olarak güncellendiği / commit edildiği durumlarda özellikle faydalı olabilir.
  • run_as_future (bool, isteğe bağlı) — Bu yöntemin arka planda çalıştırılıp çalıştırılmayacağı. Arka plan işleri, ana iş parçacığını bloklamadan sıralı olarak çalıştırılır. run_as_future=True geçirilirse bir Future nesnesi döndürülür. Varsayılan değer False'tir.

Dönüş değeri

CommitInfo veya Future

Yeni oluşturulan commit hakkında bilgi içeren CommitInfo örneği (commit hash, commit url, pr url, commit message,…). run_as_future=True geçirilirse, çalıştırıldığında sonucu içerecek bir Future nesnesi döndürülür.

Verilen depoya yerel bir dosya (en fazla 50 GB) yükleyin. Yükleme, bir HTTP post isteği üzerinden yapılır ve git veya git-lfs'in kurulu olmasını gerektirmez.

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError
  • RepositoryNotFoundError İndirilecek depo bulunamadığında. Bunun nedeni, deponun var olmaması veya private olarak ayarlanmış olması ve erişiminizin bulunmaması olabilir.
  • RevisionNotFoundError İndirilecek revizyon bulunamadığında.

upload_file, Hub'da zaten var olan bir repoyu varsayar. 404 istemci hatası alırsanız, kimlik doğrulamanızın yapıldığından, token'ınızın gerekli izinlere sahip olduğundan ve repo_id ile repo_type değerlerinin doğru ayarlandığından emin olun. Repo yoksa, önce create_repo() kullanarak oluşturun.

Örnek:

>>> from huggingface_hub import upload_file

>>> with open("./local/filepath", "rb") as fobj:
...     upload_file(
...         path_or_fileobj=fileobj,
...         path_in_repo="remote/file/path.h5",
...         repo_id="username/my-dataset",
...         repo_type="dataset",
...         token="my_token",
...     )

>>> upload_file(
...     path_or_fileobj=".\\local\\file\\path",
...     path_in_repo="remote/file/path.h5",
...     repo_id="username/my-model",
...     token="my_token",
... )

>>> upload_file(
...     path_or_fileobj=".\\local\\file\\path",
...     path_in_repo="remote/file/path.h5",
...     repo_id="username/my-model",
...     token="my_token",
...     create_pr=True,
... )

upload_folder

< >

( repo_id: strfolder_path: str | Pathpath_in_repo: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = Noneallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonedelete_patterns: list[str] | str | None = Nonerun_as_future: bool = False ) → CommitInfo or Future

Parametreler

  • repo_id (str) — Dosyanın yükleneceği depo, örneğin: "username/custom_transformers"
  • folder_path (str veya Path) — Yerel dosya sisteminde yüklenecek klasörün yolu
  • path_in_repo (str, isteğe bağlı) — Depodaki dizinin göreli yolu, örneğin: "checkpoints/1fec34a/results". Varsayılan olarak deponun kök klasörü kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • repo_type (str, isteğe bağlı) — Bir veri seti, alan veya çekirdek deposuna yükleniyorsa "dataset", "space" veya "kernel" olarak ayarlayın, bir modele yükleniyorsa None veya "model". Varsayılan None'dir.
  • revision (str, isteğe bağlı) — Taahhüt edilecek git revizyonu. Varsayılan olarak "main" dalının başıdır.
  • commit_message (str, isteğe bağlı) — Oluşturulan commit'in özeti / başlığı / ilk satırı. Varsayılan değer: f"Upload {path_in_repo} with huggingface_hub"
  • commit_description (str isteğe bağlı) — Oluşturulan commit'in açıklaması
  • create_pr (boolean, isteğe bağlı) — Bu commit ile bir Pull Request oluşturulup oluşturulmayacağı. Varsayılan değer False'dir. PR her zaman varsayılan branch'e karşı açılır: hem create_pr=True hem de revision ayarlanırsa bir ValueError yükseltilir. create_pr=True ile yapılan her çağrının yeni bir pull request açtığını not edin: yarıda kalmış bir yüklemeyi mevcut PR'a devam ettirmek için bunun yerine revision="refs/pr/N" ile yeniden çalıştırın.
  • parent_commit (str, isteğe bağlı) — Ebeveyn commit'in OID / SHA'sı, onaltılık bir dize olarak. Kısaltmalar (ilk 7 karakter) de desteklenir. Belirtilirse ve create_pr False ise, revision parent_commit'e işaret etmiyorsa commit başarısız olur. parent_commit'in belirtilmesi, değişiklikler commit edilmeden önce repoyu değiştirmediğinden emin olunmasını sağlar ve repo eşzamanlı olarak güncelleniyorsa / commit ediliyorsa özellikle faydalı olabilir. Yükleme birden fazla commite bölünürse (büyük klasörler), parent_commit yalnızca ilkinde geçerlidir.
  • allow_patterns (list[str] veya str, isteğe bağlı) — Verilirse, yalnızca en az bir desenle eşleşen dosyalar yüklenir.
  • ignore_patterns (list[str] veya str, isteğe bağlı) — Verilirse, desenlerden herhangi biriyle eşleşen dosyalar yüklenmez.
  • delete_patterns (list[str] veya str, isteğe bağlı) — Belirtilirse, desenlerden herhangi biriyle eşleşen uzak dosyalar, yeni dosyalar commit edilirken depodan silinir. Hangi dosyaların zaten yüklendiğini bilmiyorsanız bu özellik işinize yarar. Not: Tutarsızlıkları önlemek için .gitattributes dosyası, desene eşleşse bile silinmez.
  • run_as_future (bool, isteğe bağlı) — Bu yöntemin arka planda çalıştırılıp çalıştırılmayacağı. Arka plan işleri, ana iş parçacığını bloklamadan sıralı olarak çalıştırılır. run_as_future=True geçirilirse bir Future nesnesi döndürülür. Varsayılan değer False'tir.

Dönüş değeri

CommitInfo veya Future

Yeni oluşturulan commit hakkında bilgi içeren CommitInfo örneği (commit hash, commit url, pr url, commit message,…). run_as_future=True geçirilirse, çalıştırıldığında sonucu içerecek bir Future nesnesi döndürülür.

Yerel bir klasörü verilen depoya yükler. Yükleme, HTTP istekleri aracılığıyla yapılır ve git veya git-lfs'in kurulu olmasını gerektirmez.

Klasör yapısı korunacaktır. Depoda zaten aynı ada sahip dosyalar üzerine yazılacaktır. Diğer dosyalara dokunulmayacaktır.

Hangi dosyaların yükleneceğini belirtmek için allow_patterns ve ignore_patterns argümanlarını kullanın. Bu parametreler tek bir desen veya desen listesi kabul eder. Desenler, burada belgelenen Standart Jolly Jokerler (globbing desenleri)dir. Hem allow_patterns hem de ignore_patterns sağlanırsa, her iki kısıt da uygulanır. Varsayılan olarak, klasördeki tüm dosyalar yüklenir.

Uzak depodan silmek istediğiniz dosyaları belirtmek için delete_patterns argümanını kullanın. Girdi türü, allow_patterns için olanla aynıdır (bkz. yukarıdaki bölüm). path_in_repo de sağlanırsa, desenler bu klasöre göre göreli yollarla eşleştirilir. Örneğin, upload_folder(..., path_in_repo="experiment", delete_patterns="logs/*") ifadesi, ./experiment/logs/ altındaki tüm uzak dosyaları siler. Desenlerle eşleşse bile .gitattributes dosyasının silinmeyeceğini unutmayın.

Herhangi bir alt dizinde bulunan .git/ klasörü yok sayılır. Ancak .gitignore dosyasının dikkate alınmadığını lütfen unutmayın.

hf_xet yüklüyse (varsayılan), dosyalar akışkan bir boru hattı üzerinden yüklenir: klasör Hub ile karşılaştırılmaya devam ederken yüklemeler başlar, dosyalar yükleme için parçalara ayrılırken özetlenir (tek okuma geçişi) ve büyük klasörler, sunucu sınırlarının altında kalmak için otomatik olarak birkaç partide taahhüt edilir (takip eden taahhütler, taahhüt mesajında (part N) eki alır). Yükleme yarıda kalırsa, aynı çağrının yeniden çalıştırılması kaldığı yerden devam eder: zaten taahhüt edilen dosyalar atlanır ve zaten yüklenen veriler yinelenme giderilir. hf_xet yüklü değilse, create_commit() ile oluşturulan tek bir taahhüde geri düşülür.

Aşağıdaki hataları oluşturur:

  • HuggingFace API bir hata döndürürse HTTPError
  • Bazı parametre değeri geçersizse ValueError

upload_folder, Hub'da zaten var olan bir repoyu varsayar. 404 Client hatası alırsanız, kimlik doğrulamanızın yapıldığından, token'ınızın gerekli izinlere sahip olduğundan ve repo_id ile repo_type değerlerinin doğru ayarlandığından emin olun. Repo yoksa, önce create_repo() kullanarak oluşturun.

Örnek:

# Upload checkpoints folder except the log files
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     ignore_patterns="**/logs/*.txt",
... )

# Upload checkpoints folder including logs while deleting existing logs from the repo
# Useful if you don't know exactly which log files have already being pushed
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     delete_patterns="**/logs/*.txt",
... )

# Upload checkpoints folder while creating a PR
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     create_pr=True,
... )

verify_repo_checksums

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonelocal_dir: str | Path | None = Nonecache_dir: str | Path | None = Nonetoken: str | bool | None = None ) → FolderVerification

Parametreler

  • repo_id (str) — Bir ad alanı (kullanıcı veya kuruluş) ve / ile ayrılmış bir depo adı.
  • repo_type (str, isteğe bağlı) — Ağacın alınacağı depoyun türü ("model", "dataset" veya "space". Varsayılan değer "model".
  • revision (str, isteğe bağlı) — Ağacın alınacağı depoyun revizyonu. Varsayılan olarak "main" dalıdır.
  • local_dir (str veya Path, isteğe bağlı) — Doğrulanacak yerel dizin.
  • cache_dir (str veya Path, isteğe bağlı) — Doğrulanacak önbellek dizini.
  • token (Union[bool, str, None], optional) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.

Dönüş değeri

FolderVerification

doğrulama ayrıntılarını içeren yapılandırılmış bir sonuç.

Yükseltilen

RepositoryNotFoundError veya RevisionNotFoundError

  • RepositoryNotFoundError — Depo bulunamadıysa (hata 404): yanlış repo_id/repo_type, özel ama kimlik doğrulaması yapılmamış veya depo mevcut değil.
  • RevisionNotFoundError — Revizyon depoda bulunamazsa (404 hatası).

Bir repodaki yerel dosyaları Hub kontrol toplamlarıyla doğrulayın.

wait_for_job

< >

( job_id: str | list[str]timeout: float | None = Nonepoll_interval: float = 1.0stages: list[JobStage] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo or list[JobInfo]

Parametreler

  • job_id (str veya list[str]) — Job'un kimliği veya beklenmesi istenen Job kimliklerinin listesi. Liste geçirilirse, JobInfo listesi döndürülür (aynı sırayla).
  • timeout (float, isteğe bağlı) — İş(ler)in bitmesi için saniye cinsinden beklenmesi gereken en uzun süre. None ise, süresiz beklenir.
  • poll_interval (float, isteğe bağlı) — Her durum denetimi arasında beklenen süre, saniye cinsinden. Varsayılan değer 1 sn'dir.
  • stages (list[JobStage], isteğe bağlı) — Beklenecek aşamalar. Varsayılan olarak son aşamalar ("COMPLETED", "CANCELED", "ERROR", "DELETED") kullanılır. Örneğin, Job'ın çalışmaya başlamasını beklemek için [JobStage.RUNNING] geçebilirsiniz. Son aşamalar, bu değerden bağımsız olarak bekleme işlemini her zaman durdurur.
  • namespace (str, isteğe bağlı) — İş(ler)in çalıştığı namespace. Varsayılan olarak mevcut kullanıcının namespace'i kullanılır.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Sağlanmazsa, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

JobInfo veya list[JobInfo]

son İş bilgileri.

Yükseltilen

TimeoutError

  • TimeoutError — En az bir Job, timeout saniye içinde hedef aşamalardan birine ulaşmadıysa.

Hugging Face altyapısındaki bir veya daha fazla hesaplama İşinin (Job) belirli bir aşamaya ulaşmasını bekleyin.

Her Job durumu, aşaması stages (varsayılan olarak son aşamalar: "COMPLETED", "CANCELED", "ERROR" veya "DELETED") değerlerinden biri olana kadar poll_interval saniyede bir (inspect_job() ile) sorgulanır. Her durumda nihai JobInfo döndürülür: başarısız veya iptal edilen bir Job istisna fırlatmaz — sonucu işlemek için job.status.stage değerini kontrol edin.

Terminal aşamalar, stages içinde listelenmemiş olsa bile bekleme işlemini her zaman durdurur. Bu, Job'un asla ulaşamayacağı bir aşama için sonsuza kadar beklenmesini önler (ör. zamanlama sırasında başarısız olan bir Job için "RUNNING" beklenmesi).

Örnek:

>>> from huggingface_hub import run_job, wait_for_job
>>> job = run_job(image="python:3.12", command=["python", "-c", "print('Hello from HF compute!')"])
>>> wait_for_job(job_id=job.id).status.stage
'COMPLETED'

wait_for_space

< >

( repo_id: strtimeout: float | None = Nonepoll_interval: float = 1.0token: bool | str | None = None ) → SpaceRuntime

Parametreler

  • repo_id (str) — Beklenecek Space'in kimliği. Örnek: "username/my-space".
  • timeout (float, isteğe bağlı) — Beklenecek maksimum süre (saniye cinsinden). None ise sonsuza kadar bekler.
  • poll_interval (float, isteğe bağlı) — Durum denetimleri arasındaki saniye sayısı. Varsayılan değer 1 sn'dir.
  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci. Varsayılan olarak, önerilen kimlik doğrulama yöntemi olan yerel olarak kaydedilmiş belirteç kullanılır. Kimlik doğrulamayı devre dışı bırakmak için False olarak ayarlayın. Bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Dönüş değeri

SpaceRuntime

Space son aşamaya ulaştığında nihai çalışma zamanı bilgisi.

Yükseltilen

TimeoutError

  • TimeoutError — Space, timeout saniye içinde son bir aşamaya ulaşmadıysa.

Bir Space'in son bir aşamaya (derleniyor/başlatılıyor değil) ulaşmasını bekleyin.

Polls, Space’in aşaması artık ara bir durum (BUILDING, RUNNING_BUILDING, APP_STARTING, RUNNING_APP_STARTING) olmadıkça her poll_interval saniyede bir get_space_runtime() çağrısı yapar. Tüm durumlarda nihai SpaceRuntime değerini döndürür — sonucu işlemek için runtime.stage değerini kontrol edin (ör. RUNNING ile BUILD_ERROR).

Örnek:

>>> from huggingface_hub import restart_space, wait_for_space
>>> restart_space("username/my-space")
>>> runtime = wait_for_space("username/my-space")
>>> runtime.stage
'RUNNING'

whoami

< >

( token: bool | str | None = Nonecache: bool = False )

Parametreler

  • token (bool veya str, isteğe bağlı) — Geçerli bir kullanıcı erişim belirteci (dize). Varsayılan olarak, kimlik doğrulama için önerilen yöntem olan yerel olarak kaydedilmiş belirteç kullanılır (bkz. https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Kimlik doğrulamayı devre dışı bırakmak için False geçirin.
  • cache (bool, isteğe bağlı) — whoami çağrısının sonucunun sonraki çağrılar için önbelleğe alınıp alınmayacağını belirtir. İlk çağrı sırasında bir hata oluşursa, sonuç önbelleğe alınmaz. Varsayılan değer False'tür.

Kim olduğunuzu öğrenmek için HF API'sini çağırın.

cache=True geçirilirse, sonuç Python sürecinin ömrü boyunca sonraki çağrılar için önbelleğe alınır. Bu, güvenlik nedenleriyle yoğun şekilde hız sınırlamasına tabi olan bu uç noktayı whoami üzerinden birden fazla kez çağırmayı planlıyorsanız faydalıdır.

API Veri Sınıfları

AccessRequest

sınıf huggingface_hub.hf_api.AccessRequest

< >

( username: str | Nonerequest_id: strfullname: str | Noneemail: str | Nonetimestamp: datetimestatus: Literal['pending', 'accepted', 'rejected']fields: dict[str, Any] | None = None )

Parametreler

  • username (str, isteğe bağlı) — Erişim talep eden kullanıcının kullanıcı adı. Kullanıcı adlarının paylaşılmaması yapılandırılmışsa depo için None. Bu durumda, talebi kabul etmek, reddetmek veya iptal etmek için request_id kullanın.
  • request_id (str) — Erişim isteğinin kimliği. Kullanıcı adı paylaşılmamış olsa bile her zaman ayarlanır.
  • fullname (str, isteğe bağlı) — Erişim talep eden kullanıcının tam adı. Kullanıcı adlarının paylaşılmaması yapılandırılmışsa depo için None.
  • email (str, isteğe bağlı) — Erişim talep eden kullanıcının e-posta adresi. Kullanıcıya erişim manuel olarak verilmişse veya depo, talep edenlerin e-posta adreslerini paylaşmamak üzere yapılandırılmışsa None.
  • timestamp (datetime) — İsteğin zaman damgası.
  • status (Literal["pending", "accepted", "rejected"]) — İsteğin durumu. ["pending", "accepted", "rejected"] değerlerinden biri olabilir.
  • fields (dict[str, Any], isteğe bağlı) — Kullanıcının geçit formunda doldurduğu ek alanlar.

Bir kullanıcı erişim isteği hakkında bilgi içeren veri yapısı.

BucketFile

sınıf huggingface_hub.BucketFile

< >

( **kwargs )

Hub'daki bir kovadaki dosya hakkında bilgi içerir. Bu nesne list_bucket_tree() tarafından döndürülür.

RepoFile'e benzer ancak bucketlardaki dosyalar için.

BucketFileMetadata

sınıf huggingface_hub.BucketFileMetadata

< >

( size: intxet_file_data: XetFileData )

Parametreler

  • size (int) — Dosyanın bayt cinsinden boyutu.
  • xet_file_data (XetFileData) — Dosya için Xet bilgileri (hash ve yenileme rotası).

Bir kovadaki dosya hakkında bilgi içeren veri yapısı.

get_bucket_file_metadata() tarafından döndürülür.

BucketInfo

sınıf huggingface_hub.BucketInfo

< >

( **kwargs )

Parametreler

  • id (str) — Kovanın kimliği.
  • private (bool) — Kova özel mi.
  • created_at (datetime) — Hub'da bucket'ın oluşturulma tarihi.
  • size (int) — Büketin bayt cinsinden boyutu.
  • total_files (int) — Kova içindeki dosyaların toplam sayısı.

Hub'daki bir varlık hakkındaki bilgileri içerir. Bu nesne bucket_info() ve list_buckets() tarafından döndürülür.

BucketUrl

sınıf huggingface_hub.BucketUrl

< >

( url: strendpoint: str = '' )

Parametreler

  • url (str) — Kova URL'sinin dize değeri.
  • endpoint (str, isteğe bağlı) — Hub uç noktası. Varsayılan olarak https://huggingface.co.

Hub'daki bir varlık URL'sini açıklar.

BucketUrl, create_bucket() tarafından döndürülür. Başlatma sırasında URL, özellikleri doldurmak için ayrıştırılır:

  • uç nokta (str)
  • namespace (str)
  • bucket_id (str)
  • url (str)
  • uri (HfUri)

DatasetLeaderboardEntry

sınıf huggingface_hub.DatasetLeaderboardEntry

< >

( **kwargs )

Parametreler

  • rank (int) — Modelin liderlik tablosundaki sırası (1'den başlar).
  • model_id (str) — Modelin kimliği (ör. "meta-llama/Llama-3-8b").
  • value (float) — Değerlendirme puanı değeri.
  • filename (str) — Değerlendirme verilerini içeren sonuç dosyasının adı.
  • verified (bool) — Sonucun doğrulanıp doğrulanmadığı.
  • source (dict[str, Any], isteğe bağlı) — Değerlendirme sonucunun kaynağına dair bilgi. "url", "name" ve "isExternal" gibi anahtarlar içerir. Tüm girdilerin bir kaynağı yoktur.
  • author (User veya Organization) — API yanıtındaki "type" alanına göre ayrıştırılan model yazarı.
  • pull_request (int, isteğe bağlı) — Lider tablosu girdisiyle ilişkili olan varsa, pull request numarası.
  • notes (str, isteğe bağlı) — Lider tablosu girdisiyle ilişkili notlar, varsa.

Hub'daki bir veri seti lider tablosundaki tek bir girdi hakkında bilgi içerir.

Bir liderlik tablosu, modelleri belirli bir referans veri setindeki değerlendirme puanlarına göre sıralar. Bu nesne get_dataset_leaderboard() tarafından döndürülür. Belirli bir modelin referans veri setleri genelindeki değerlendirme sonuçlarını almak için model_info() ile expand=["evalResults"] parametresi kullanılarak ModelInfo.eval_results ve EvalResultEntry öğelerine bakın.

EvalResultEntry

sınıf huggingface_hub.EvalResultEntry

< >

( dataset_id: strtask_id: strvalue: typing.Anydataset_revision: str | None = Noneverify_token: str | None = Nonedate: str | None = Nonesource_url: str | None = Nonesource_name: str | None = Nonesource_user: str | None = Nonesource_org: str | None = Nonenotes: str | None = None )

Parametreler

  • dataset_id (str) — Hub'dan benchmark veri seti kimliği. Örnek: “cais/hle”, “Idavidrein/gpqa”.
  • task_id (str) — Benchmarkedaki görev tanımlayıcısı. Örnek: “gpqa_diamond”.
  • value (Any) — Metrik değeri. Örnek: 20.90.
  • dataset_revision (str, isteğe bağlı) — Benchmarks veri setinin Git SHA'sı.
  • verify_token (str, isteğe bağlı) — Değerlendirmenin kanıtlanabilir şekilde denetlenebilir ve yeniden üretilebilir olduğunu kanıtlamak için kullanılabilen bir imza.
  • date (str, isteğe bağlı) — Değerlendirme ne zaman çalıştırıldı (ISO-8601 tarih ve saat). Varsayılan olarak git commit zamanı kullanılır.
  • source_url (str, isteğe bağlı) — Değerlendirme kaynağına bağlantı (ör. https://huggingface.co/spaces/SaylorTwift/smollm3-mmlu-pro). source_name, source_user veya source_org sağlanıyorsa zorunludur.
  • source_name (str, isteğe bağlı) — Kaynağın görüntülenen adı. Örnek: “Eval Logs”.
  • source_user (str, isteğe bağlı) — Atıf için HF kullanıcı adı. Örnek: “celinah”.
  • source_org (str, isteğe bağlı) — Atıf için HF org adı. Örnek: “cais”.
  • notes (str, isteğe bağlı) — Değerlendirme kurulumuyla ilgili ayrıntılar. Örnek: “tools”, “no-tools”, “chain-of-thought”.

.eval_results/*.yaml biçimi için değerlendirme sonucu girişi.

Model depolarında saklanan ve model sayfasında ile benchmark veri setinin liderlik tablosunda otomatik olarak görünen değerlendirme puanlarını temsil eder.

README.md içindeki eski model-index biçimi için bunun yerine EvalResult kullanın.

Daha fazla ayrıntı için https://huggingface.co/docs/hub/eval-results adresine bakın.

Örnek:

>>> from huggingface_hub import EvalResultEntry
>>> # Minimal example with required fields only
>>> result = EvalResultEntry(
...     dataset_id="Idavidrein/gpqa",
...     task_id="gpqa_diamond",
...     value=0.412,
... )
>>> # Full example with all fields
>>> result = EvalResultEntry(
...     dataset_id="cais/hle",
...     task_id="default",
...     value=20.90,
...     dataset_revision="5503434ddd753f426f4b38109466949a1217c2bb",
...     verify_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
...     date="2025-01-15T10:30:00Z",
...     source_url="https://huggingface.co/datasets/cais/hle",
...     source_name="CAIS HLE",
...     source_org="cais",
...     notes="no-tools",
... )

SyncOperation

sınıf huggingface_hub.SyncOperation

< >

( action: typing.Literal['upload', 'download', 'delete', 'skip']path: strsize: int | None = Nonereason: str = ''local_mtime: str | None = Noneremote_mtime: str | None = Nonebucket_file: huggingface_hub._buckets.BucketFile | None = None )

Yapılacak bir senkronizasyon işlemini temsil eder.

SyncPlan

sınıf huggingface_hub.SyncPlan

< >

( source: strdest: strtimestamp: stroperations: list = <factory> )

Tam bir senkronizasyon planını temsil eder.

CommitInfo

sınıf huggingface_hub.CommitInfo

< >

( commit_url: str*args**kwargs )

Parametreler

  • commit_url (str) — Commit'in bulunabileceği URL.
  • commit_message (str) — Oluşturulan commit'in özeti (ilk satırı).
  • commit_description (str) — Oluşturulan commit'in açıklaması. Boş olabilir.
  • oid (str) — Commit hash kimliği. Örnek: "91c54ad1727ee830252e457677f467be0bfd8a57".
  • pr_url (str, isteğe bağlı) — Oluşturulmuşsa, oluşturulan PR'nin URL'si. create_pr=True parametresi iletildiğinde doldurulur.
  • pr_revision (str, isteğe bağlı) — Oluşturulmuşsa, oluşturulan PR'nin revizyonu. create_pr=True parametresi iletildiğinde doldurulur. Örnek: "refs/pr/1".
  • pr_num (int, isteğe bağlı) — Oluşturulmuşsa, oluşturulan PR tartışmasının numarası. create_pr=True parametresi iletildiğinde doldurulur. get_discussion_details() fonksiyonunda discussion_num olarak iletilebilir. Örnek: 1.
  • repo_url (RepoUrl) — repo_id, repo_type gibi bilgileri içeren commit'in depo URL'si.

Yeni oluşturulan bir commit hakkında bilgi içeren veri yapısı.

Hub üzerinde bir commit oluşturan herhangi bir yöntem tarafından döndürülür: create_commit(), upload_file(), upload_folder(), delete_file(), delete_folder(). Geriye dönük uyumluluk için str sınıfından devralır ancak str'e özgü yöntemlerin kullanımı artık önerilmez.

DatasetInfo

sınıf huggingface_hub.DatasetInfo

< >

( **kwargs )

Parametreler

  • id (str) — Veri setinin kimliği.
  • author (str) — Veri setinin yazarı.
  • card_data (DatasetCardData, isteğe bağlı) — huggingface_hub.repocard_data.DatasetCardData nesnesi olarak Dataset Card Metadata.
  • citation (str, isteğe bağlı) — Veri seti için atıf bilgisi.
  • created_at (datetime, isteğe bağlı) — Hub'daki repoyun oluşturulma tarihi. En düşük değerin 2022-03-02T23:29:04.000Z olduğunu ve bu tarihin, oluşturma tarihlerini depolamaya başladığımız tarihe karşılık geldiğini unutmayın.
  • description (str, isteğe bağlı) — Veri setinin açıklaması.
  • disabled (bool, isteğe bağlı) — Depo devre dışı mı.
  • downloads (int) — Son 30 gün içinde veri setinin indirme sayısı.
  • downloads_all_time (int) — Veri setinin oluşturulmasından bu yana kümülatif indirme sayısı.
  • gated (Literal["auto", "manual", False], isteğe bağlı) — Depo kapalı mı? Eğer öyleyse, onayın manuel mi yoksa otomatik mi olduğu.
  • last_modified (datetime, isteğe bağlı) — Depoya son commit'in tarihi.
  • likes (int) — Number of likes of the dataset.
  • main_size (int, isteğe bağlı) — Veri setinin ana dalının bayt cinsinden boyutu.
  • paperswithcode_id (str, isteğe bağlı) — Veri setinin Papers with code kimliği.
  • private (bool) — Depo özel mi.
  • resource_group (dict, isteğe bağlı) — Veri seti için kaynak grubu bilgisi.
  • sha (str) — Bu özel revizyondaki depo SHA'sı.
  • siblings (list[RepoSibling]) — Veri setini oluşturan huggingface_hub.hf_api.RepoSibling nesnelerinin listesi.
  • tags (list[str]) — Veri setinin etiketlerinin listesi.
  • trending_score (int, isteğe bağlı) — Veri setinin trend puanı.
  • used_storage (int, isteğe bağlı) — Hub'daki veri setinin bayt cinsinden boyutu.

Hub'daki bir veri seti hakkında bilgi içerir. Bu nesne dataset_info() ve list_datasets() tarafından döndürülür.

Bu sınıfın çoğu özelliği isteğe bağlıdır. Bunun nedeni, Hub tarafından döndürülen verinin yapılan sorguya bağlı olmasıdır. Genel olarak, sorgu ne kadar spesifikse, o kadar çok bilgi döndürülür. Buna karşılık, list_datasets() kullanarak veri kümelerini listelerken yalnızca özelliklerin bir alt kümesi döndürülür.

DryRunFileInfo

sınıf huggingface_hub.DryRunFileInfo

< >

( commit_hash: strfile_size: int | Nonefilename: strlocal_path: stris_cached: boolwill_download: bool )

Parametreler

  • commit_hash (str) — Dosyayla ilgili commit_hash.
  • file_size (int, isteğe bağlı) — Biliniyorsa dosyanın boyutu. LFS dosyası durumunda, işaretçinin değil, gerçek LFS dosyasının boyutunu içerir.
  • filename (str) — Depodaki dosyanın adı.
  • is_cached (bool) — Dosyanın yerel olarak zaten önbelleğe alınıp alınmadığı.
  • will_download (bool) — hf_hub_download dry_run=False ile çağrıldığında dosyanın indirilip indirilmeyeceğini belirtir. Uygulamada, dosya önbellekte değilse veya force_download=True ise will_download True olur.

Bir dosya indirme işlemi için kuru çalıştırma (dry run) gerçekleştirildiğinde dönen bilgiler.

dry_run=True olduğunda hf_hub_download() tarafından döndürülür.

DuplicatedRepoUrl

sınıf huggingface_hub.DuplicatedRepoUrl

< >

( url: Anyendpoint: str | None = None )

Parametreler

  • files_copy_pending (bool) — Yeni repodaki LFS/Xet dosyaları arka planda kopyalanmaya devam ediyorsa True. Kopyalama işlemi tamamlanana kadar bu dosyaların indirilmesi başarısız olabilir.

duplicate_repo() tarafından döndürülen RepoUrl.

GitRefInfo

sınıf huggingface_hub.GitRefInfo

< >

( name: strref: strtarget_commit: str )

Parametreler

  • name (str) — Referansın adı (ör. etiket adı veya dal adı).
  • ref (str) — Hub'daki tam git ref'i (ör. "refs/heads/main" veya "refs/tags/v1.0").
  • target_commit (str) — ref için hedef commit'in OID'si (ör. "e7da7f221d5bf496a48136c0cd264e630fe9fcc8")

Hub'daki bir depoyu işaret eden bir git referansına ilişkin bilgileri içerir.

GitCommitInfo

sınıf huggingface_hub.GitCommitInfo

< >

( commit_id: strauthors: list[str]created_at: datetimetitle: strmessage: strformatted_title: str | Noneformatted_message: str | None )

Parametreler

  • commit_id (str) — commit'in OID'si (ör. "e7da7f221d5bf496a48136c0cd264e630fe9fcc8")
  • authors (list[str]) — Commit'in yazarlarının listesi.
  • created_at (datetime) — Commit'in oluşturulma zamanı.
  • title (str) — Commit başlığı. Bu, yazarlar tarafından girilen serbest metin bir değerdir.
  • message (str) — Commit açıklaması. Bu, yazarlar tarafından girilen serbest metin bir değerdir.
  • formatted_title (str) — HTML olarak biçimlendirilmiş commit başlığı. Yalnızca formatted=True ayarlanırsa döndürülür.
  • formatted_message (str) — HTML olarak biçimlendirilmiş commit açıklaması. Yalnızca formatted=True ayarlanırsa döndürülür.

Hub'daki bir depo için bir git commit hakkında bilgi içerir. Daha fazla ayrıntı için list_repo_commits() işlevine göz atın.

GitRefs

sınıf huggingface_hub.GitRefs

< >

( branches: list[GitRefInfo]converts: list[GitRefInfo]tags: list[GitRefInfo]pull_requests: list[GitRefInfo] | None = None )

Parametreler

  • branches (list[GitRefInfo]) — Depodaki dallar hakkında bilgi içeren GitRefInfo öğelerinin listesi.
  • converts (list[GitRefInfo]) — Depodaki “convert” ref'leri hakkında bilgi içeren GitRefInfo listesidir. Convert'ler, Dataset depolarında ön işlenmiş verileri itmek için (içeriden) kullanılan ref'lerdir.
  • tags (list[GitRefInfo]) — Depodaki etiketler hakkında bilgi içeren GitRefInfo öğelerinin listesi.
  • pull_requests (list[GitRefInfo], isteğe bağlı) — Depodaki pull request'ler hakkında bilgi içeren GitRefInfo öğelerinin listesi. Yalnızca include_prs=True ayarlandığında döndürülür.

Hub'daki bir repoya ait tüm git referansları hakkında bilgi içerir.

Nesne, list_repo_refs() tarafından döndürülür.

InferenceProviderMapping

sınıf huggingface_hub.hf_api.InferenceProviderMapping

< >

( **kwargs )

KernelInfo

sınıf huggingface_hub.KernelInfo

< >

( **kwargs )

Parametreler

  • id (str) — Çekirdek deposunun kimliği.
  • author (str, isteğe bağlı) — Çekirdek deposunun yazarı.
  • downloads (int, isteğe bağlı) — Son 30 gün içinde çekirdek deposunun indirme sayısı.
  • gated (Literal["auto", "manual", False], isteğe bağlı) — Depo kapalı mı? Öyleyse onay manuel mi yoksa otomatik mi?
  • last_modified (datetime, isteğe bağlı) — Depoya son commit'in tarihi.
  • likes (int, isteğe bağlı) — Çekirdek deposunun beğeni sayısı.
  • private (bool, isteğe bağlı) — Depo özel mi.
  • sha (str, isteğe bağlı) — Bu özel revizyondaki depo SHA'sı.

Hub'daki bir çekirdek deposu hakkında bilgi içerir. Bu nesne kernel_info() tarafından döndürülür.

LFSFileInfo

sınıf huggingface_hub.hf_api.LFSFileInfo

< >

( **kwargs )

Parametreler

  • file_oid (str) — Dosyanın SHA-256 nesne kimliği. Bu, dosyanın kalıcı olarak silinmesi sırasında geçirilecek tanımlayıcıdır.
  • filename (str) — LFS nesnesi için olası dosya adı. Daha fazla bilgi için yukarıdaki notu inceleyin.
  • oid (str) — LFS nesnesinin OID'si.
  • pushed_at (datetime) — LFS nesnesinin depoya gönderildiği tarih.
  • ref (str, isteğe bağlı) — LFS nesnesinin itildiği ref (varsa).
  • size (int) — LFS nesnesinin boyutu.

Hub'daki bir depoda LFS olarak saklanan bir dosya hakkında bilgi içerir.

Bir depodan LFS dosyalarını listelemek ve kalıcı olarak silmek suretiyle yer açma bağlamında kullanılır. Daha fazla ayrıntı için list_lfs_files() ve permanently_delete_lfs_files() işlevlerine bakın.

Git LFS dosyaları, performansın optimize edilmesi amacıyla dosya yolları yerine SHA-256 nesne kimlikleri kullanılarak izlenir. Bu yaklaşım, tek bir nesnenin farklı commit'ler boyunca birden çok yol tarafından referanslandırılabileceği ve bu bağlantıları aramanın ve çözümlemenin pratik olmadığı için gereklidir. Her SHA ile hangi dosya adlarının ilişkili olduğunu nasıl öğrenebileceğinizi öğrenmek için belgelerimize göz atın.

Örnek:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)

ModelInfo

sınıf huggingface_hub.ModelInfo

< >

( **kwargs )

Parametreler

  • id (str) — Model kimliği.
  • author (str, isteğe bağlı) — Modelin yazarı.
  • base_models (list[str], isteğe bağlı) — Bu modelin türetildiği temel modellerin listesi.
  • card_data (ModelCardData, isteğe bağlı) — Model Card Metadata, bir huggingface_hub.repocard_data.ModelCardData nesnesi olarak.
  • children_model_count (int, isteğe bağlı) — Bu modelden türetilen çocuk modellerin sayısı.
  • config (dict, isteğe bağlı) — Model yapılandırması.
  • created_at (datetime, isteğe bağlı) — Hub'daki repoyun oluşturulma tarihi. En düşük değerin 2022-03-02T23:29:04.000Z olduğunu ve bu tarihin, oluşturma tarihlerini depolamaya başladığımız tarihe karşılık geldiğini unutmayın.
  • disabled (bool, isteğe bağlı) — Depo devre dışı mı.
  • downloads (int) — Son 30 gün içinde modelin indirilme sayısı.
  • downloads_all_time (int) — Modelin oluşturulmasından bu yana kümülatif indirme sayısı.
  • eval_results (list[EvalResultEntry], isteğe bağlı) — Modelin değerlendirme sonuçları.
  • gated (Literal["auto", "manual", False], isteğe bağlı) — Depo kapalı mı? Eğer öyleyse, onayın manuel mi yoksa otomatik mi olduğu.
  • gguf (dict, isteğe bağlı) — Modelin GGUF bilgileri.
  • inference (Literal["warm"], isteğe bağlı) — Modelin Inference Providers'taki durumu. Model en az bir sağlayıcı tarafından sunuluyorsa sıcak (warm) durumdadır.
  • inference_provider_mapping (list[InferenceProviderMapping], isteğe bağlı) — Kullanıcının sağlayıcı sırasına göre sıralanmış bir InferenceProviderMapping listesi.
  • last_modified (datetime, isteğe bağlı) — Depoya son commit'in tarihi.
  • library_name (str, isteğe bağlı) — Modelle ilişkili kütüphane.
  • likes (int) — Modelin beğeni sayısı.
  • mask_token (str, isteğe bağlı) — Model tarafından kullanılan maske sembolü.
  • model_index (dict, isteğe bağlı) — Değerlendirme için model indeksi.
  • pipeline_tag (str, isteğe bağlı) — Modelle ilişkili pipeline etiketi.
  • private (bool) — Depo özel mi.
  • resource_group (dict, isteğe bağlı) — Model için kaynak grubu bilgisi.
  • safetensors (SafeTensorsInfo, isteğe bağlı) — Modelin safetensors bilgileri.
  • security_repo_status (dict, isteğe bağlı) — Modelin güvenlik tarama durumu.
  • sha (str, isteğe bağlı) — Bu özel revizyondaki depo SHA'sı.
  • siblings (list[RepoSibling]) — Modeli oluşturan huggingface_hub.hf_api.RepoSibling nesnelerinin listesi.
  • spaces (list[str], isteğe bağlı) — Modeli kullanan alanların listesi.
  • tags (list[str]) — Modelin etiket listesi. card_data.tags ile karşılaştırıldığında, Hub tarafından hesaplanan ek etiketleri içerir (ör. desteklenen kütüphaneler, modelin arXiv).
  • transformers_info (TransformersInfo, isteğe bağlı) — Modelle ilişkili Transformers'a özgü bilgiler (auto sınıfı, işlemci vb.).
  • trending_score (int, isteğe bağlı) — Modelin trend puanı.
  • used_storage (int, isteğe bağlı) — Hub'daki modelin bayt cinsinden boyutu.
  • widget_data (Any, isteğe bağlı) — Model ile ilişkili widget verisi.

Hub'daki bir model hakkında bilgi içerir. Bu nesne model_info() ve list_models() tarafından döndürülür.

Bu sınıfın çoğu özelliği isteğe bağlıdır. Bunun nedeni, Hub tarafından döndürülen verinin yapılan sorguya bağlı olmasıdır. Genel olarak, sorgu ne kadar spesifikse, o kadar çok bilgi döndürülür. Buna karşılık, list_models() kullanarak modelleri listelerken yalnızca özelliklerin bir alt kümesi döndürülür.

RepoSibling

sınıf huggingface_hub.hf_api.RepoSibling

< >

( rfilename: strsize: int | None = Noneblob_id: str | None = Nonelfs: BlobLfsInfo | None = None )

Parametreler

  • rfilename (str) — depo köküne göre göreli dosya adı.
  • size (int, isteğe bağlı) — Dosyanın bayt cinsinden boyutu. Bu öznitelik, repo_info() işlevinin files_metadata argümanı True olarak ayarlandığında tanımlanır. Aksi halde None değerini alır.
  • blob_id (str, isteğe bağlı) — Dosyanın git OID'si. Bu öznitelik, repo_info()'nin files_metadata argümanı True olarak ayarlandığında tanımlanır. Aksi halde None'dir.
  • lfs (BlobLfsInfo, opsiyonel) — Dosyanın LFS meta verileri. Bu öznitelik, repo_info() işlevinin files_metadata argümanı True olarak ayarlandığında ve dosya Git LFS ile depolandığında tanımlanır. Aksi halde None değerini alır.

Hub'daki bir depodaki depo dosyası hakkında temel bilgiler içerir.

Bu sınıfın rfilename dışında tüm öznitelikleri isteğe bağlıdır. Bunun nedeni, Hub'da depoları listelerken ( list_models() , list_datasets() veya list_spaces() ile) yalnızca dosya adlarının döndürülmesidir. Dosya boyutu, blob kimliği veya lfs ayrıntıları gibi daha fazla bilgiye ihtiyacınız varsa, bunları arka uç sunucuya bu bilgileri getirmek için daha fazla kısıtlama eklediğinden, her bir depodan tek tek ve özellikle talep etmeniz gerekir ( model_info() , dataset_info() veya space_info() kullanarak).

RepoFile

sınıf huggingface_hub.RepoFile

< >

( **kwargs )

Parametreler

  • path (str) — depo köküne göre göreli dosya yolu.
  • size (int) — Dosyanın bayt cinsinden boyutu.
  • blob_id (str) — Dosyanın git OID'si.
  • lfs (BlobLfsInfo, isteğe bağlı) — Dosyanın LFS meta verileri.
  • xet_hash (str, isteğe bağlı) — Dosyanın Xet hash'i.
  • last_commit (LastCommitInfo, isteğe bağlı) — Dosyanın son commit meta verileri. Yalnızca list_repo_tree() ve get_paths_info() expand=True ile çağrıldığında tanımlıdır.
  • security (BlobSecurityInfo, isteğe bağlı) — Dosyanın güvenlik tarama meta verileri. Yalnızca list_repo_tree() ve get_paths_info() fonksiyonları expand=True parametresiyle çağrıldığında tanımlıdır.

Hub'daki bir dosya hakkında bilgi içerir.

RepoUrl

sınıf huggingface_hub.RepoUrl

< >

( url: Anyendpoint: str | None = None )

Parametreler

  • url (Any) — Depo URL'sinin dize değeri.
  • endpoint (str, isteğe bağlı) — Hub uç noktası. Varsayılan olarak https://huggingface.co.

Yükseltilen

HfUriError

  • HfUriError — URL çözümlenemezse (ör. kanonik tek segmentli depo veya bilinmeyen repo_type).

Hub'daki bir depo URL'sini tanımlayan str alt sınıfı.

RepoUrl, HfApi.create_repo tarafından döndürülür. Geriye dönük uyumluluk için str'den devralır. Başlatma sırasında URL, özellikleri doldurmak için ayrıştırılır:

  • uç nokta (str)
  • namespace (str)
  • repo_name (str)
  • repo_id (str)
  • repo_type (Literal["model", "dataset", "space"])
  • url (str)

Örnek:

>>> RepoUrl('https://huggingface.co/openai-community/gpt2')
RepoUrl('https://huggingface.co/openai-community/gpt2', endpoint='https://huggingface.co', repo_type='model', repo_id='openai-community/gpt2')

>>> RepoUrl('https://huggingface.co/static-proxy/hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://huggingface.co/static-proxy/hub-ci.huggingface.co')
RepoUrl('https://huggingface.co/static-proxy/hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://huggingface.co/static-proxy/hub-ci.huggingface.co', repo_type='dataset', repo_id='dummy_user/dummy_dataset')

>>> RepoUrl('hf://datasets/my-user/my-dataset')
RepoUrl('hf://datasets/my-user/my-dataset', endpoint='https://huggingface.co', repo_type='dataset', repo_id='user/dataset')

>>> HfApi.create_repo("dummy_model")
RepoUrl('https://huggingface.co/Wauplin/dummy_model', endpoint='https://huggingface.co', repo_type='model', repo_id='Wauplin/dummy_model')

SafetensorsRepoMetadata

sınıf huggingface_hub.utils.SafetensorsRepoMetadata

< >

( metadata: dict | Nonesharded: boolweight_map: dictfiles_metadata: dict )

Parametreler

  • metadata (dict, isteğe bağlı) — ‘model.safetensors.index.json’ dosyasında bulunan metadata (varsa). Yalnızca parçalı modeller için doldurulur.
  • sharded (bool) — Deponun parçalı bir model içerip içermediğini belirtir.
  • weight_map (dict[str, str]) — Tüm ağırlıkların haritası. Anahtarlar tensör adları, değerler ise tensörleri içeren dosyaların dosya adlarıdır.
  • files_metadata (dict[str, SafetensorsFileMetadata]) — Tüm dosyaların metadata haritası. Anahtarlar dosya adlarıdır ve değerler, ilgili dosyanın metadata'sıdır; bir SafetensorsFileMetadata nesnesi olarak.
  • parameter_count (dict[str, int]) — Veri türü başına parametre sayılarının haritası. Anahtarlar veri türlerini, değerler ise o veri türündeki parametre sayısını temsil eder.

Safetensors deposu için meta veriler.

Bir depo, kök dizininde bir ‘model.safetensors’ ağırlık dosyası (paylaşılmayan model) veya bir ‘model.safetensors.index.json’ dizin dosyası (parçalı model) içeriyorsa bir Safetensors deposu olarak kabul edilir.

Bu sınıf, get_safetensors_metadata() tarafından döndürülür.

safetensors formatı hakkında daha fazla ayrıntı için https://huggingface.co/docs/safetensors/index#format adresine göz atın.

SafetensorsFileMetadata

sınıf huggingface_hub.utils.SafetensorsFileMetadata

< >

( metadata: dicttensors: dict )

Parametreler

  • metadata (dict) — Dosyada bulunan meta veriler.
  • tensors (dict[str, TensorInfo]) — Tüm tensörlerin haritası. Anahtarlar tensör adlarıdır ve değerler, ilgili tensörün bilgilerini TensorInfo nesnesi olarak içerir.
  • parameter_count (dict[str, int]) — Veri türü başına parametre sayılarının haritası. Anahtarlar veri türlerini, değerler ise o veri türündeki parametre sayısını temsil eder.

Hub üzerinde barındırılan bir Safetensors dosyasının meta verileri.

Bu sınıf, parse_safetensors_file_metadata() tarafından döndürülür.

safetensors formatı hakkında daha fazla ayrıntı için https://huggingface.co/docs/safetensors/index#format adresine göz atın.

SpaceInfo

sınıf huggingface_hub.SpaceInfo

< >

( **kwargs )

Parametreler

  • id (str) — Space'in kimliği.
  • author (str, isteğe bağlı) — Space'in yazarı.
  • card_data (SpaceCardData, isteğe bağlı) — Space Card Metadata, huggingface_hub.repocard_data.SpaceCardData nesnesi olarak.
  • created_at (datetime, isteğe bağlı) — Hub'daki repoyun oluşturulma tarihi. En düşük değerin 2022-03-02T23:29:04.000Z olduğunu ve bu tarihin, oluşturma tarihlerini depolamaya başladığımız tarihe karşılık geldiğini unutmayın.
  • datasets (list[str], isteğe bağlı) — Space tarafından kullanılan veri kümelerinin listesi.
  • disabled (bool, isteğe bağlı) — Space devre dışı mı?
  • gated (Literal["auto", "manual", False], isteğe bağlı) — Depo kapalı mı? Eğer öyleyse, onayın manuel mi yoksa otomatik mi olduğu.
  • host (str, isteğe bağlı) — Space'in Host URL'si.
  • last_modified (datetime, isteğe bağlı) — Depoya son commit'in tarihi.
  • likes (int) — Number of likes of the Space.
  • models (list[str], isteğe bağlı) — Space tarafından kullanılan modellerin listesi.
  • private (bool) — Depo özel mi.
  • region (Literal["us", "eu"], isteğe bağlı) — Space'in depolandığı bulut bölgesi.
  • resource_group (dict, isteğe bağlı) — Space için kaynak grubu bilgileri.
  • runtime (SpaceRuntime, isteğe bağlı) — Space çalışma zamanı bilgileri, bir huggingface_hub.hf_api.SpaceRuntime nesnesi olarak.
  • sdk (str, isteğe bağlı) — Space tarafından kullanılan SDK.
  • sha (str, isteğe bağlı) — Bu özel revizyondaki depo SHA'sı.
  • siblings (list[RepoSibling]) — Space'i oluşturan huggingface_hub.hf_api.RepoSibling nesnelerinin listesi.
  • subdomain (str, isteğe bağlı) — Space'in alt alan adı.
  • tags (list[str]) — Space'in etiketlerinin listesi.
  • trending_score (int, isteğe bağlı) — Space'in trend puanı.
  • used_storage (int, isteğe bağlı) — Hub'daki Space'in bayt cinsinden boyutu.

Hub'daki bir Space hakkında bilgi içerir. Bu nesne space_info() ve list_spaces() tarafından döndürülür.

Bu sınıfın çoğu özelliği isteğe bağlıdır. Bunun nedeni, Hub tarafından döndürülen verinin yapılan sorguya bağlı olmasıdır. Genel olarak, sorgu ne kadar spesifikse, o kadar çok bilgi döndürülür. Buna karşılık, list_spaces() kullanarak alanları listelerken yalnızca özelliklerin bir alt kümesi döndürülür.

SpaceSearchResult

sınıf huggingface_hub.SpaceSearchResult

< >

( data: dict )

Parametreler

  • id (str) — Space'in kimliği (ör. "username/repo-name").
  • author (str) — Space'in yazarı.
  • title (str) — Space'in görüntüleme başlığı.
  • emoji (str or None) — Emoji icon of the Space.
  • sdk (str veya None) — Space'in kullandığı SDK (ör. "gradio", "docker", "static").
  • likes (int) — Beğeni sayısı.
  • private (bool) — Space'in özel olup olmadığı.
  • tags (list[str] veya None) — Etiket listesi.
  • runtime (SpaceRuntime veya None) — Çalışma zamanı bilgileri (aşama, donanım vb.).
  • ai_short_description (str veya None) — Yapay zeka tarafından oluşturulan kısa açıklama.
  • ai_category (str veya None) — Yapay zeka tarafından oluşturulan kategori (ör. "Image Generation").
  • semantic_relevancy_score (float veya None) — Arama sorgusuna göre semantik ilgili puanı (0-1).
  • trending_score (int veya None) — Trend skoru.

Spaces anlamsal arama API'sinden tek bir sonuç.

HfApi.search_spaces() tarafından döndürülür.

TensorInfo

sınıf huggingface_hub.utils.TensorInfo

< >

( dtype: typing.Literal['F64', 'F32', 'F16', 'BF16', 'I64', 'I32', 'I16', 'I8', 'U8', 'U3', 'BOOL']shape: listdata_offsets: tuple )

Parametreler

  • dtype (str) — Tensörün veri türü (“F64”, “F32”, “F16”, “BF16”, “I64”, “I32”, “I16”, “I8”, “U8”, “U3”, “BOOL”).
  • shape (list[int]) — Tensörün şekli.
  • data_offsets (tuple[int, int]) — Dosyadaki verilerin [BEGIN, END] biçiminde bir demet olarak ofsetleri.
  • parameter_count (int) — Tensördeki parametre sayısı.

Bir tensör hakkında bilgi.

safetensors formatı hakkında daha fazla ayrıntı için https://huggingface.co/docs/safetensors/index#format adresine göz atın.

Kullanıcı

sınıf huggingface_hub.User

< >

( **kwargs )

Parametreler

  • username (str) — Hub'daki kullanıcının adı (benzersiz).
  • fullname (str) — Kullanıcının tam adı.
  • avatar_url (str) — Kullanıcının avatarının URL'si.
  • details (str, isteğe bağlı) — Kullanıcının ayrıntıları.
  • is_following (bool, isteğe bağlı) — Kimliği doğrulanmış kullanıcının bu kullanıcıyı takip edip etmediğini belirtir.
  • is_pro (bool, isteğe bağlı) — Kullanıcının pro kullanıcısı olup olmadığı.
  • num_models (int, isteğe bağlı) — Kullanıcının oluşturduğu model sayısı.
  • num_datasets (int, isteğe bağlı) — Kullanıcının oluşturduğu veri kümelerinin sayısı.
  • num_spaces (int, isteğe bağlı) — Kullanıcının oluşturduğu boşluk sayısı.
  • num_discussions (int, isteğe bağlı) — Kullanıcının başlattığı tartışma sayısı.
  • num_papers (int, isteğe bağlı) — Kullanıcının yazarı olduğu makale sayısı.
  • num_upvotes (int, isteğe bağlı) — Kullanıcının aldığı olumlu oy sayısı.
  • num_likes (int, isteğe bağlı) — Kullanıcının verdiği beğeni sayısı.
  • num_following (int, isteğe bağlı) — Bu kullanıcının takip ettiği kullanıcı sayısı.
  • num_followers (int, isteğe bağlı) — Bu kullanıcıyı takip eden kullanıcı sayısı.
  • orgs (Organization listesi) — Kullanıcının üye olduğu kuruluşların listesi.

Hub'daki bir kullanıcıyla ilgili bilgileri içerir.

UserLikes

sınıf huggingface_hub.UserLikes

< >

( user: strtotal: intdatasets: list[str]kernels: list[str]models: list[str]spaces: list[str] )

Parametreler

  • user (str) — Beğenileri aldığımız kullanıcının adı.
  • total (int) — Toplam beğeni sayısı.
  • datasets (list[str]) — Kullanıcının beğendiği veri kümelerinin listesi (repo_ids olarak).
  • kernels (list[str]) — Kullanıcının beğendiği kernel listesi (repo_id olarak).
  • models (list[str]) — Kullanıcının beğendiği modellerin listesi (repo_ids olarak).
  • spaces (list[str]) — Kullanıcının beğendiği space'lerin listesi (repo_ids olarak).

Hub'daki bir kullanıcının beğenileri hakkında bilgi içerir.

WebhookInfo

sınıf huggingface_hub.WebhookInfo

< >

( id: strurl: str | Nonejob: JobSpec | Nonewatched: list[WebhookWatchedItem]domains: list[constants.WEBHOOK_DOMAIN_T]secret: str | Nonedisabled: bool )

Parametreler

  • id (str) — Webhook kimliği.
  • url (str, isteğe bağlı) — Webhook'un URL'si.
  • job (JobSpec, isteğe bağlı) — Tetiklenecek Job'un özellikleri.
  • watched (list[WebhookWatchedItem]) — Webhook tarafından izlenen öğelerin listesi, bkz. WebhookWatchedItem.
  • domains (list[WEBHOOK_DOMAIN_T]) — Webhook'ün izlediği alan adlarının listesi. ["repo", "discussion"] değerlerinden biri olabilir.
  • secret (str, isteğe bağlı) — Webhook'un gizli anahtarı.
  • disabled (bool) — Webhook'un devre dışı bırakılıp bırakılmadığı.

Bir webhook hakkında bilgi içeren veri yapısı.

url veya job'dan biri, ancak ikisi birden belirtilmemiştir.

WebhookWatchedItem

sınıf huggingface_hub.WebhookWatchedItem

< >

( type: Literal['bucket', 'dataset', 'model', 'org', 'space', 'user']name: str )

Parametreler

  • type (Literal["bucket", "dataset", "model", "org", "space", "user"]) — İzlenecek öğenin türü. ["bucket", "dataset", "model", "org", "space", "user"] değerlerinden biri olabilir.
  • name (str) — İzlenecek öğenin adı. Kullanıcı adı, kuruluş adı, model adı, veri seti adı, space adı veya bucket adı olabilir.

Bir webhook tarafından izlenen öğeler hakkında bilgi içeren veri yapısı.

CommitOperation

Aşağıda CommitOperation() için desteklenen değerler yer almaktadır:

sınıf huggingface_hub.CommitOperationAdd

< >

( path_in_repo: strpath_or_fileobj: str | pathlib.Path | bytes | typing.BinaryIO )

Parametreler

  • path_in_repo (str) — Depodaki göreli dosya yolu, örneğin: "checkpoints/1fec34a/weights.bin"
  • path_or_fileobj (str, Path, bytes, veya BinaryIO) — Şu seçeneklerden biri:
    • Yüklemek için yerel bir dosyanın yolu (str veya pathlib.Path olarak)
    • Yüklemek istenen dosyanın içeriğini tutan bir bayt tamponu (bytes)
    • bir “dosya nesnesi” (io.BufferedIOBase alt sınıfı), genellikle open(path, "rb") ile elde edilir. seek() ve tell() yöntemlerini desteklemelidir.

Yükseltilen

ValueError

  • ValueError — path_or_fileobj, str, Path, bytes veya io.BufferedIOBase değilse.
  • ValueError — path_or_fileobj bir str veya Path ise ancak mevcut bir dosyanın yoluna işaret etmiyorsa.
  • ValueError — path_or_fileobj bir io.BufferedIOBase ise ancak hem seek() hem de tell() desteklenmiyorsa.

Hub'daki bir depoya dosya yüklemek için gerekli bilgileri tutan veri yapısı.

as_file

< >

( with_tqdm: bool = False )

Parametreler

  • with_tqdm (bool, isteğe bağlı, varsayılan False) — True ise, dosya nesnesi üzerinde gezinirken bir ilerleme çubuğu görüntülenir. Yalnızca dosya benzeri nesne bir dosya yoluysa çalışır. Saf baytlar ve tamponlar desteklenmez.

path_or_fileobj altındaki verileri okumaya izin veren dosya benzeri bir nesne üreten bir bağlam yöneticisi.

Örnek:

>>> operation = CommitOperationAdd(
...        path_in_repo="remote/dir/weights.h5",
...        path_or_fileobj="./local/weights.h5",
... )
CommitOperationAdd(path_in_repo='remote/dir/weights.h5', path_or_fileobj='./local/weights.h5')

>>> with operation.as_file() as file:
...     content = file.read()

>>> with operation.as_file(with_tqdm=True) as file:
...     while True:
...         data = file.read(1024)
...         if not data:
...              break
config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s]

>>> with operation.as_file(with_tqdm=True) as file:
...     httpx2.put(..., data=file)
config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s]

b64content

< >

( )

path_or_fileobj'in base64 kodlanmış içeriği

Dönüş: bytes

sınıf huggingface_hub.CommitOperationDelete

< >

( path_in_repo: stris_folder: typing.Union[bool, typing.Literal['auto']] = 'auto' )

Parametreler

  • path_in_repo (str) — Depodaki göreli dosya yolu, örneğin bir dosya için "checkpoints/1fec34a/weights.bin" veya bir klasör için "checkpoints/1fec34a/".
  • is_folder (bool veya Literal["auto"], isteğe bağlı) — Silme İşleminin bir klasöre mi yoksa dosyaya mı uygulandığını belirtir. “auto” değeri verilirse, yol türü (dosya veya klasör), yolun “/” ile (klasör) bitip bitmediğine bakılarak otomatik olarak tahmin edilir. Yol türünü açıkça belirtmek için is_folder=True veya is_folder=False değerlerini ayarlayabilirsiniz.

Hub'daki bir depodan bir dosya veya klasörü silmek için gerekli bilgileri tutan veri yapısı

sınıf huggingface_hub.CommitOperationCopy

< >

( src_path_in_repo: strpath_in_repo: strsrc_revision: str | None = Nonesrc_repo_id: str | None = Nonesrc_repo_type: str | None = None_src_oid: str | None = None_dest_oid: str | None = None_is_duplicated: bool = False )

Parametreler

  • src_path_in_repo (str) — Kopyalanacak dosyanın depodaki göreli dosya yolu, örn. "checkpoints/1fec34a/weights.bin".
  • path_in_repo (str) — Dosyanın kopyalanacağı depodaki göreli dosya yolu, örn. "checkpoints/1fec34a/weights_copy.bin".
  • src_revision (str, isteğe bağlı) — Kopyalanacak dosyanın git revizyonu. Geçerli herhangi bir git revizyonu olabilir. Varsayılan olarak hedef commit revizyonuna ayarlanır.
  • src_repo_id (str, isteğe bağlı) — Kopyalanacak kaynak depo (ör. "username/source-model"). Varsayılan olarak hedef depodur (depo içi kopyalama).
  • src_repo_type (str, isteğe bağlı) — Kaynak depoyun türü ("model", "dataset" veya "space"). src_repo_id ayarlandığında zorunludur.

Hub'daki bir depodaki dosyayı kopyalamak için gerekli bilgileri tutan veri yapısı.

Hem LFS dosyaları hem de normal dosyalar desteklenir. LFS dosyaları sunucu tarafında kopyalanırken normal dosyalar, commit'in bir parçası olarak indirilir ve yeniden yüklenir.

Depo arası kopyalamalar, src_repo_id ve src_repo_type ayarlanarak desteklenir. Depo arası LFS kopyalamalarında, commit oluşturulmadan önce LFS nesneleri hedef depoya kopyalanır. Bu işlem create_commit() tarafından otomatik olarak yönetilir. Depo arası kopyalamaların yalnızca aynı depolama bölgesi içinde çalıştığını, bölgeler arası kopyalamanın desteklenmediğini unutmayın.

Not: Hub'da bir LFS dosyasını yeniden adlandırmak için CommitOperationCopy ve CommitOperationDelete işlemlerini birleştirebilirsiniz.

CommitScheduler

sınıf huggingface_hub.CommitScheduler

< >

( repo_id: strfolder_path: str | pathlib.Pathevery: int | float = 5path_in_repo: str | None = Nonerepo_type: str | None = Nonerevision: str | None = Noneprivate: bool | None = Nonetoken: str | None = Noneallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonesquash_history: bool = Falsehf_api: typing.Optional[ForwardRef('HfApi')] = None )

Parametreler

  • repo_id (str) — Yükleme yapılacak deposunun kimliği.
  • folder_path (str veya Path) — Düzenli olarak yüklenmesi gereken yerel klasörün yolu.
  • every (int veya float, isteğe bağlı) — Her commit arasındaki dakika sayısı. Varsayılan olarak 5 dakikadır.
  • path_in_repo (str, isteğe bağlı) — Depodaki dizinin göreli yolu, örneğin: "checkpoints/". Varsayılan olarak deponun kök klasörüdür.
  • repo_type (str, isteğe bağlı) — Yükleme yapılacak depoyun türü. Varsayılan olarak model.
  • revision (str, isteğe bağlı) — Commit yapılacak repo sürümü. Varsayılan olarak main.
  • private (bool, isteğe bağlı) — Deponun özel yapılıp yapılmayacağı. None (varsayılan) ise, organizasyonun varsayılanı özel değilse depo herkese açık olur. Depo zaten mevcutsa bu değer yok sayılır.
  • token (str, isteğe bağlı) — Depoya taahhüt etmek için kullanılacak jeton. Varsayılan olarak makinede kayıtlı jeton kullanılır.
  • allow_patterns (list[str] veya str, isteğe bağlı) — Verilirse, yalnızca en az bir desenle eşleşen dosyalar yüklenir.
  • ignore_patterns (list[str] veya str, isteğe bağlı) — Verilirse, desenlerden herhangi biriyle eşleşen dosyalar yüklenmez.
  • squash_history (bool, isteğe bağlı) — Her commit sonrasında repo geçmişinin sıkıştırılıp sıkıştırılmayacağı. Varsayılan değer False'dir. Commit'lerin sıkıştırılması, repo çok büyüdüğünde performans düşüşlerini önlemek için faydalıdır.
  • hf_api (HfApi, isteğe bağlı) — Hub'a commit yapmak için kullanılacak HfApi istemcisi. Özel ayarlarla (user agent, token,…) ayarlanabilir.

Hub'a düzenli aralıklarla (ör. her 5 dakikada bir) yerel bir klasör yüklemek için zamanlayıcı.

Zamanlayıcının önerilen kullanım yöntemi, bir bağlam yöneticisi olarak kullanmaktır. Bu, betik sonlandığında zamanlayıcının düzgün şekilde durdurulmasını ve son commit'in tetiklenmesini sağlar. Zamanlayıcı ayrıca stop yöntemiyle manuel olarak da durdurulabilir. Kullanımı hakkında daha fazla bilgi edinmek için yükleme kılavuzuna göz atın.

Örnek:

>>> from pathlib import Path
>>> from huggingface_hub import CommitScheduler

# Scheduler uploads every 10 minutes
>>> csv_path = Path("watched_folder/data.csv")
>>> CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path=csv_path.parent, every=10)

>>> with csv_path.open("a") as f:
...     f.write("first line")

# Some time later (...)
>>> with csv_path.open("a") as f:
...     f.write("second line")

Bağlam yöneticisi kullanan örnek:

>>> from pathlib import Path
>>> from huggingface_hub import CommitScheduler

>>> with CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path="watched_folder", every=10) as scheduler:
...     csv_path = Path("watched_folder/data.csv")
...     with csv_path.open("a") as f:
...         f.write("first line")
...     (...)
...     with csv_path.open("a") as f:
...         f.write("second line")

# Scheduler is now stopped and last commit have been triggered

push_to_hub

< >

( )

Klasörü Hub'a gönderin ve commit bilgilerini döndürün.

Bu yöntemin doğrudan çağrılması amaçlanmamıştır. Eşzamanlı commit'leri önlemek için bir kuyruk mekanizmasına uyarak zamanlayıcı tarafından arka planda çalıştırılır. Yönteme doğrudan bir çağrı yapılması, eşzamanlılık sorunlarına yol açabilir.

push_to_hub varsayılan davranışı, eklemeye özel bir klasör varsayar. Klasördeki tüm dosyaları listeler ve yalnızca değiştirilen dosyaları yükler. Değişiklik bulunmazsa, yöntem hiçbir şey taahhüt etmeden döner. Bu davranışı değiştirmek isterseniz, CommitScheduler sınıfından türetip bu yöntemi geçersiz kılabilirsiniz. Örneğin, taahhüt etmeden önce verileri tek bir dosyada bir araya getirip sıkıştırmak için bu işe yarar. Daha fazla ayrıntı ve örnekler için entegrasyon kılavuzumuza göz atın.

durdur

< >

( )

Zamanlayıcıyı durdurun.

Durdurulmuş bir zamanlayıcı yeniden başlatılamaz. Ağırlıklı olarak test amaçlıdır.

tetikleyici

< >

( )

Bir push_to_hub tetikleyin ve bir gelecek (future) döndürün.

Bu yöntem her every dakikada bir otomatik olarak çağrılır. Bir sonraki planlanan commit'i beklemeden hemen bir commit tetiklemek için bunu manuel olarak da çağırabilirsiniz.

Update on GitHub

←Ortam değişkenleri CLI→