Hugging Face's logo

Hub Python Library documentation

Tugas

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Tugas

Periksa halaman dokumentasi HfApi untuk referensi metode mengelola Jobs Anda di Hub.

Struktur data

JobInfo

kelas huggingface_hub.JobInfo

< >

( **kwargs )

Parameter

  • id (str) — ID pekerjaan.
  • created_at (datetime atau None) — Waktu Job dibuat.
  • started_at (datetime atau None) — Waktu Job mulai berjalan. None selama Job masih dalam penjadwalan.
  • finished_at (datetime atau None) — Waktu Job selesai. None selama Job masih dalam penjadwalan atau berjalan.
  • docker_image (str atau None) — Gambar Docker dari Docker Hub yang digunakan untuk Job. Dapat berupa None jika space_id hadir sebagai gantinya.
  • space_id (str atau None) — Gambar Docker dari Hugging Face Spaces yang digunakan untuk Job. Dapat berupa None jika docker_image hadir sebagai gantinya.
  • command (list[str] atau None) — Perintah dari Job, misalnya ["python", "-c", "print('hello world')"]
  • arguments (list[str] atau None) — Argumen yang diteruskan ke perintah
  • environment (dict[str] atau None) — Variabel lingkungan dari Job sebagai dictionary.
  • secrets (dict[str] atau None) — Variabel lingkungan rahasia dari Job (terenkripsi).
  • flavor (str atau None) — Flavor untuk perangkat keras. Lihat JobHardware untuk nilai yang mungkin. Contoh: "cpu-basic".
  • labels (dict[str, str] atau None) — Label yang akan dilampirkan ke job (pasangan kunci-nilai).
  • volumes (list[Volume] atau None) — Volume yang dipasang di kontainer job (bucket, model, dataset, spaces).
  • status — (JobStatus atau None): Status dari Job, misalnya JobStatus(stage="RUNNING", message=None) Lihat JobStage untuk nilai stage yang mungkin.
  • durations (JobDurations atau None) — Rincian waktu dari Job. Ada untuk semua status job termasuk SCHEDULING.
  • owner — (JobOwner atau None): Pemilik Job, misalnya JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")
  • initiator (JobInitiator atau None) — Apa yang memicu Job, misalnya JobInitiator(type="scheduled-job", id="...") untuk eksekusi yang dipicu oleh cron.
  • expose_urls (list[str] atau None) — URL publik yang dapat diakses melalui port yang diekspos oleh Job (satu URL per port yang diekspos), misalnya ["https://687fb701029421ae5549d998--8000.hf.jobs"]. None jika tidak ada port yang diekspos. Akses ke URL memerlukan token HF dengan akses baca ke namespace Job, kecuali port tersebut bersifat publik.
  • ssh_url (str atau None) — Endpoint SSH dari Job, misalnya "ssh://687fb701029421ae5549d998@ssh.hf.jobs". Hanya ada ketika Job dimulai dengan ssh=True. Koneksi memerlukan akses tulis ke namespace Job dan kunci SSH publik yang terdaftar di Hub (https://huggingface.co/settings/keys).
  • network (JobNetwork atau None) — Grup jaringan yang diikuti oleh Job dan alias yang diklaimnya, misalnya JobNetwork(group="train", aliases=["master"]). None ketika Job dimulai tanpa network_group=.
  • retry (int atau None) — Jumlah percobaan ulang yang dikonfigurasi untuk Job (attempts - 1).
  • expose (list[int] atau None) — Semua port yang diekspos melalui proxy Jobs, termasuk yang bersifat publik.
  • expose_public (list[int] atau None) — Port yang terbuka dan dapat diakses tanpa autentikasi.

Berisi informasi tentang sebuah Job.

Contoh:

>>> 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

kelas huggingface_hub.JobOwner

< >

( id: strname: strtype: str )

JobNetwork

kelas huggingface_hub.JobNetwork

< >

( **kwargs )

Parameter

  • group (str) — Nama grup jaringan, sebagaimana yang diteruskan ke network_group=.
  • aliases (list[str]) — Alias yang diklaim oleh Job dalam grup, sebagaimana diteruskan ke network_aliases=. Kosong jika tidak ada.

Grup jaringan a Job bergabung.

JobStage

kelas huggingface_hub.JobStage

< >

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

Enumerasi kemungkinan tahap sebuah Job di Hub.

Value dapat dibandingkan dengan string:

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

kelas huggingface_hub.JobStatus

< >

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

Volume

kelas huggingface_hub.Volume

< >

( **kwargs )

Parameter

  • type (str) — Jenis volume: "bucket", "model", "dataset", atau "space".
  • source (str) — Pengidentifikasi sumber, misalnya "username/my-bucket" atau "username/my-model".
  • mount_path (str) — Path mount di dalam container, misalnya "/data". Harus diawali dengan /.
  • revision (str atau None) — Revisi Git (hanya untuk repos, defaultnya "main").
  • read_only (bool atau None) — Mount read-only. Dipaksa True untuk repos, default False untuk buckets.
  • path (str atau None) — Prefiks subfolder di dalam bucket/repo untuk di-mount, misalnya "path/to/dir".

Menggambarkan volume yang akan dipasang dalam kontainer Space atau Job.

to_dict

< >

( )

Serialisasi ke payload JSON yang diharapkan oleh API Hub.

to_uri

< >

( )

Kembalikan volume sebagai URI mount HF dalam format yang diharapkan oleh CLI.

Update on GitHub

←OAuth Sandbox→