Hub Python Library documentation

İşler

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

İşler

Hub'daki İşlerinizi yönetmek için kullanılan yöntemlerin referansı için HfApi dokümantasyon sayfasını kontrol edin.

Veri yapıları

JobInfo

sınıf huggingface_hub.JobInfo

< >

( **kwargs )

Parametreler

  • id (str) — İş kimliği.
  • created_at (datetime veya None) — Job oluşturulduğunda.
  • started_at (datetime veya None) — Job'un çalışmaya başladığı zaman. Job hâlâ zamanlanıyorken None.
  • finished_at (datetime veya None) — Job'un bittiği zaman. Job hâlâ zamanlanıyor veya çalışıyorsa None.
  • docker_image (str veya None) — Job için Docker Hub'dan kullanılan Docker imajı. Bunun yerine space_id mevcut ise None olabilir.
  • space_id (str veya None) — İş için Hugging Face Spaces'ten kullanılan Docker görüntüsü. docker_image yerine mevcut ise None olabilir.
  • command (list[str] veya None) — Job'un komutu, örn. ["python", "-c", "print('hello world')"]
  • arguments (list[str] veya None) — Komuta aktarılan argümanlar
  • environment (dict[str] veya None) — Job'un sözlük olarak ortam değişkenleri.
  • secrets (dict[str] veya None) — Job'un gizli ortam değişkenleri (şifreli).
  • flavor (str veya None) — Donanım için lezzet. Olası değerler için JobHardware'a bakın. Örn. "cpu-basic".
  • labels (dict[str, str] veya None) — İşlemeye eklenmesi gereken etiketler (anahtar-değer çiftleri).
  • volumes (list[Volume] veya None) — İş konteynerine bağlanan hacimler (variller, modeller, veri kümeleri, uzaylar).
  • status — (JobStatus veya None): Job durumu, örn. JobStatus(stage="RUNNING", message=None) Olası stage değerleri için JobStage'e bakın.
  • durations (JobDurations veya None) — Job'un zamanlama dökümü. SCHEDULING dahil olmak üzere tüm job durumları için mevcuttur.
  • owner — (JobOwner veya None): Job'un sahibi, örn. JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")
  • initiator (JobInitiator veya None) — Job'u neyin tetiklediğini belirtir, örneğin cron ile tetiklenen bir çalıştırma için JobInitiator(type="scheduled-job", id="...").
  • expose_urls (list[str] veya None) — 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ğilse None. 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 (str or None) — Job'un SSH uç noktası, örn. "ssh://687fb701029421ae5549d998@ssh.hf.jobs". Yalnızca Job ssh=True ile 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 (JobNetwork veya None) — 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ıysa None.
  • retry (int veya None) — Job için yapılandırılan yeniden deneme sayısı (attempts - 1).
  • expose (list[int] veya None) — Jobs vekili üzerinden açılan tüm portlar, herkese açık olanlar dahil.
  • expose_public (list[int] veya None) — 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

sınıf huggingface_hub.JobOwner

< >

( id: strname: strtype: str )

JobNetwork

sınıf huggingface_hub.JobNetwork

< >

( **kwargs )

Parametreler

  • group (str) — network_group= parametresine iletilen ağ grubunun adı.
  • aliases (list[str]) — Job'un grupta iddia ettiği takma adlar, network_aliases= parametresine iletildiği gibi. Hiçbiri yoksa boş.

Ağ grubuna bir İş katıldı.

JobStage

sınıf huggingface_hub.JobStage

< >

( valuenames = Nonemodule = Nonequalname = Nonetype = Nonestart = 1 )

Hub'daki bir Job'ın olası aşamalarının listesi.

Value bir dizeyle karşılaştırılabilir:

assert JobStage.COMPLETED == "COMPLETED"
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

< >

( stage: JobStagemessage: str | Noneexpose_urls: list[str] | Nonessh_url: str | None )

Hacim

sınıf huggingface_hub.Volume

< >

( **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 (str veya None) — Git revizyonu (yalnızca depolar için, varsayılan "main").
  • read_only (bool veya None) — Salt okunur bağlama. Depolar için True olarak zorunlu tutulur, variller için varsayılan değeri False'dir.
  • path (str veya None) — 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.

to_dict

< >

( )

Hub API tarafından beklenen JSON yüklemesine (payload) serialize edin.

to_uri

< >

( )

Hacmi, CLI tarafından beklenen formatta bir HF mount URI olarak döndürün.

Update on GitHub