Hub Python Library documentation
İşler
Başlayın
Nasıl yapılır kılavuzları
Genel BakışDosyaları indirDosyaları yükleKovalarCLI'yi kullanınBir CLI uzantısı oluşturunHfFileSystemDepoAraÇıkarımÇıkarım Uç NoktalarıİşlerKum HavuzlarıTopluluk SekmesiKoleksiyonlarÖnbellekModel KartlarıSpace'inizi yönetinBir kütüphaneyi entegre etWebhook'lar
Kavramsal kılavuzlar
Git ve HTTP paradigmasıPerde arkasındaki kum havuzlarıhuggingface_hub v2.0'e geçişhuggingface_hub v1.0 sürümüne geçiş
Referans
Genel BakışKimlik DoğrulamaOrtam değişkenleriHugging Face Hub APICLIDosyaları indirmeMixin'ler ve serielleştirme yöntemleriÇıkarım TürleriÇıkarım İstemcisiÇıkarım Uç NoktalarıMCP İstemcisiHfFileSystemHF URI'leriYardımcılarTartışmalar ve Çekme İstekleriÖnbellek sistemi referansıRepo Cards ve Repo Card VerileriSpace çalışma zamanıKoleksiyonlarTensorBoard kayıtçısıWebhooks sunucusuSeri hale getirmeKatı dataclass'larOAuthİşlerKum Havuzları
İşler
Hub'daki İşlerinizi yönetmek için kullanılan yöntemlerin referansı için HfApi dokümantasyon sayfasını kontrol edin.
- İş Çalıştır: run_job()
- Günlükleri getir: fetch_job_logs()
- Metrikleri getir: fetch_job_metrics()
- İş Denetimi: inspect_job()
- İş(ler)in bitmesini bekleyin: wait_for_job()
- İşleri Listele: list_jobs()
- İşlem İptali: cancel_job()
- UV İşini Çalıştır: run_uv_job()
- Bir Job'da bağlamak için yerel bir dizini senkronize edin: sync_job_volume()
Veri yapıları
JobInfo
sınıf huggingface_hub.JobInfo
< source >( **kwargs )
Parametreler
- id (
str) — İş kimliği. - created_at (
datetimeveyaNone) — Job oluşturulduğunda. - started_at (
datetimeveyaNone) — Job'un çalışmaya başladığı zaman. Job hâlâ zamanlanıyorken None. - finished_at (
datetimeveyaNone) — Job'un bittiği zaman. Job hâlâ zamanlanıyor veya çalışıyorsa None. - docker_image (
strveyaNone) — Job için Docker Hub'dan kullanılan Docker imajı. Bunun yerine space_id mevcut ise None olabilir. - space_id (
strveyaNone) — İş için Hugging Face Spaces'ten kullanılan Docker görüntüsü. docker_image yerine mevcut ise None olabilir. - command (
list[str]veyaNone) — Job'un komutu, örn.["python", "-c", "print('hello world')"] - arguments (
list[str]veyaNone) — Komuta aktarılan argümanlar - environment (
dict[str]veyaNone) — Job'un sözlük olarak ortam değişkenleri. - secrets (
dict[str]veyaNone) — Job'un gizli ortam değişkenleri (şifreli). - flavor (
strveyaNone) — Donanım için lezzet. Olası değerler içinJobHardware'a bakın. Örn."cpu-basic". - labels (
dict[str, str]veyaNone) — İşlemeye eklenmesi gereken etiketler (anahtar-değer çiftleri). - volumes (
list[Volume]veyaNone) — İş konteynerine bağlanan hacimler (variller, modeller, veri kümeleri, uzaylar). - status — (
JobStatusveyaNone): Job durumu, örn.JobStatus(stage="RUNNING", message=None)Olası stage değerleri için JobStage'e bakın. - durations (
JobDurationsveyaNone) — Job'un zamanlama dökümü. SCHEDULING dahil olmak üzere tüm job durumları için mevcuttur. - owner — (
JobOwnerveyaNone): Job'un sahibi, örn.JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user") - initiator (
JobInitiatorveyaNone) — Job'u neyin tetiklediğini belirtir, örneğin cron ile tetiklenen bir çalıştırma içinJobInitiator(type="scheduled-job", id="..."). - expose_urls (
list[str]veyaNone) — Job’un açık portlarına erişilebilen herkese açık URL’ler (her açık port için bir tane), ör.["https://687fb701029421ae5549d998--8000.hf.jobs"]. Hiçbir port açık değilseNone. Bir URL’ye erişmek, port herkese açık olmadıkça, Job’un ad alanına okuma erişimi olan bir HF token gerektirir. - ssh_url (
strorNone) — Job'un SSH uç noktası, örn."ssh://687fb701029421ae5549d998@ssh.hf.jobs". Yalnızca Jobssh=Trueile başlatıldığında mevcuttur. Bağlanmak için Job'un ad alanına yazma erişimi ve Hub'da kayıtlı bir SSH genel anahtarı (https://huggingface.co/settings/keys) gerektirir. - network (
JobNetworkveyaNone) — Job'ın katıldığı ağ grubu ve iddia ettiği takma adlar, örn.JobNetwork(group="train", aliases=["master"]). Job,network_group=olmadan başlatıldıysaNone. - retry (
intveyaNone) — Job için yapılandırılan yeniden deneme sayısı (attempts - 1). - expose (
list[int]veyaNone) — Jobs vekili üzerinden açılan tüm portlar, herkese açık olanlar dahil. - expose_public (
list[int]veyaNone) — Kimlik doğrulama olmadan erişilebilir olan açık portlar.
Bir Job hakkında bilgi içerir.
Örnek:
>>> from huggingface_hub import run_job
>>> job = run_job(
... image="python:3.12",
... command=["python", "-c", "print('Hello from the cloud!')"]
... )
>>> job
JobInfo(id='687fb701029421ae5549d998', created_at=datetime.datetime(2025, 7, 22, 16, 6, 25, 79000, tzinfo=datetime.timezone.utc), started_at=datetime.datetime(2025, 7, 22, 16, 6, 31, 79000, tzinfo=datetime.timezone.utc), finished_at=None, docker_image='python:3.12', space_id=None, command=['python', '-c', "print('Hello from the cloud!')"], arguments=[], environment={}, secrets={}, flavor='cpu-basic', labels=None, status=JobStatus(stage='RUNNING', message=None), durations=JobDurations(scheduling_secs=6, running_secs=2, total_secs=8), owner=JobOwner(id='5e9ecfc04957053f60648a3e', name='lhoestq', type='user'), initiator=JobInitiator(type='user', id='5e9ecfc04957053f60648a3e', name='lhoestq'), endpoint='https://huggingface.co', url='https://huggingface.co/jobs/lhoestq/687fb701029421ae5549d998')
>>> job.id
'687fb701029421ae5549d998'
>>> job.url
'https://huggingface.co/jobs/lhoestq/687fb701029421ae5549d998'
>>> job.status.stage
'RUNNING'JobOwner
JobNetwork
sınıf huggingface_hub.JobNetwork
< source >( **kwargs )
Ağ grubuna bir İş katıldı.
JobStage
sınıf huggingface_hub.JobStage
< source >( valuenames = Nonemodule = Nonequalname = Nonetype = Nonestart = 1 )
Hub'daki bir Job'ın olası aşamalarının listesi.
Possible values are: `COMPLETED`, `CANCELED`, `ERROR`, `DELETED`, `SCHEDULING`, `RUNNING`. Taken from https://github.com/huggingface/moon-landing/blob/main/server/job_types/JobInfo.ts#L61 (private url).JobStatus
sınıf huggingface_hub.JobStatus
< source >( stage: JobStagemessage: str | Noneexpose_urls: list[str] | Nonessh_url: str | None )
Hacim
sınıf huggingface_hub.Volume
< source >( **kwargs )
Parametreler
- type (
str) — Hacim türü:"bucket","model","dataset"veya"space". - source (
str) — Kaynak tanımlayıcısı, örn."username/my-bucket"veya"username/my-model". - mount_path (
str) — Kapsayıcı içindeki bağlama yolu, örn."/data"./ile başlamalıdır. - revision (
strveyaNone) — Git revizyonu (yalnızca depolar için, varsayılan"main"). - read_only (
boolveyaNone) — Salt okunur bağlama. Depolar içinTrueolarak zorunlu tutulur, variller için varsayılan değeriFalse'dir. - path (
strveyaNone) — Mount edilecek bucket/repo içindeki alt klasör öneki, örn."path/to/dir".
Bir Space veya Job konteynerine bağlanacak bir hacmi açıklar.
Hub API tarafından beklenen JSON yüklemesine (payload) serialize edin.
Hacmi, CLI tarafından beklenen formatta bir HF mount URI olarak döndürün.