Hugging Face's logo

Hub Python Library documentation

Jobs

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Jobs

Xem trang tài liệu HfApi để tham khảo các phương thức quản lý Jobs của bạn trên Hub.

Cấu trúc dữ liệu

JobInfo

lớp huggingface_hub.JobInfo

< >

( **kwargs )

Tham số

  • id (str) — ID của tác vụ.
  • created_at (datetime hoặc None) — Thời điểm Job được tạo.
  • started_at (datetime hoặc None) — Thời điểm Job bắt đầu chạy. Giá trị là None trong khi Job vẫn đang được lên lịch.
  • finished_at (datetime hoặc None) — Thời điểm Job hoàn thành. Là None trong khi Job vẫn đang được lên lịch hoặc đang chạy.
  • docker_image (str hoặc None) — Ảnh Docker từ Docker Hub được sử dụng cho Job. Có thể là None nếu space_id được cung cấp thay thế.
  • space_id (str hoặc None) — Ảnh Docker từ Hugging Face Spaces được sử dụng cho Job. Có thể là None nếu docker_image được cung cấp thay thế.
  • command (list[str] hoặc None) — Lệnh của Job, ví dụ ["python", "-c", "print('hello world')"]
  • arguments (list[str] hoặc None) — Các đối số được truyền cho lệnh
  • environment (dict[str] hoặc None) — Các biến môi trường của Job dưới dạng từ điển.
  • secrets (dict[str] hoặc None) — Các biến môi trường bí mật của Job (được mã hóa).
  • flavor (str hoặc None) — Flavor cho phần cứng. Xem JobHardware để biết các giá trị có thể. Ví dụ: "cpu-basic".
  • labels (dict[str, str] hoặc None) — Nhãn cần gắn cho tác vụ (các cặp khóa-giá trị).
  • volumes (list[Volume] hoặc None) — Các volume được gắn vào container của job (buckets, models, datasets, spaces).
  • status — (JobStatus hoặc None): Trạng thái của Job, ví dụ JobStatus(stage="RUNNING", message=None) Xem JobStage để biết các giá trị stage có thể có.
  • durations (JobDurations hoặc None) — Phân tích thời gian của Job. Có mặt ở tất cả các trạng thái job, bao gồm cả SCHEDULING.
  • owner — (JobOwner hoặc None): Chủ sở hữu của Job, ví dụ JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")
  • initiator (JobInitiator hoặc None) — Yếu tố kích hoạt Job, ví dụ JobInitiator(type="scheduled-job", id="...") cho một lần chạy được kích hoạt bởi cron.
  • expose_urls (list[str] hoặc None) — Các URL công khai mà qua đó các cổng được phơi bày của Job có thể được truy cập (một URL cho mỗi cổng được phơi bày), ví dụ: ["https://687fb701029421ae5549d998--8000.hf.jobs"]. None khi không có cổng nào được phơi bày. Việc truy cập một URL yêu cầu một HF token có quyền đọc vào namespace của Job, trừ khi cổng đó là công khai.
  • ssh_url (str hoặc None) — Điểm cuối SSH của Job, ví dụ "ssh://687fb701029421ae5549d998@ssh.hf.jobs". Chỉ có mặt khi Job được khởi chạy với ssh=True. Việc kết nối yêu cầu quyền ghi vào namespace của Job và một khóa SSH công khai được đăng ký trên Hub (https://huggingface.co/settings/keys).
  • network (JobNetwork hoặc None) — Nhóm mạng mà Job tham gia và các alias mà nó yêu cầu, ví dụ JobNetwork(group="train", aliases=["master"]). None khi Job được khởi chạy mà không có network_group=.
  • retry (int hoặc None) — Số lần thử lại được cấu hình cho Job (attempts - 1).
  • expose (list[int] hoặc None) — Tất cả các cổng được phơi bày thông qua proxy của Jobs, bao gồm cả các cổng công khai.
  • expose_public (list[int] hoặc None) — Các cổng được phơi bày, có thể truy cập mà không cần xác thực.

Chứa thông tin về một Job.

Ví dụ:

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

lớp huggingface_hub.JobOwner

< >

( id: strname: strtype: str )

JobNetwork

lớp huggingface_hub.JobNetwork

< >

( **kwargs )

Tham số

  • group (str) — Tên của nhóm mạng, như đã truyền vào network_group=.
  • aliases (list[str]) — Các alias mà Job yêu cầu trong nhóm, như được truyền vào network_aliases=. Rỗng nếu không có.

Nhóm mạng mà một Job đã tham gia.

JobStage

lớp huggingface_hub.JobStage

< >

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

Danh sách các giai đoạn có thể có của một Job trên Hub.

Value có thể được so sánh với một chuỗi:

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

lớp huggingface_hub.JobStatus

< >

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

Dung lượng

lớp huggingface_hub.Volume

< >

( **kwargs )

Tham số

  • type (str) — Loại volume: "bucket", "model", "dataset" hoặc "space".
  • source (str) — Định danh nguồn, ví dụ "username/my-bucket" hoặc "username/my-model".
  • mount_path (str) — Đường dẫn gắn (mount) bên trong container, ví dụ "/data". Phải bắt đầu bằng /.
  • revision (str hoặc None) — Phiên bản Git (chỉ dành cho kho, mặc định là "main").
  • read_only (bool hoặc None) — Gắn chỉ đọc. Được ép là True cho các kho, mặc định là False cho các bucket.
  • path (str hoặc None) — Tiền tố thư mục con bên trong bucket/repo để gắn, ví dụ "path/to/dir".

Mô tả một volume để gắn vào container của Space hoặc Job.

to_dict

< >

( )

Chuẩn hóa thành payload JSON được API Hub mong đợi.

to_uri

< >

( )

Trả về dung lượng dưới dạng URI gắn HF theo định dạng được CLI mong đợi.

Update on GitHub

←OAuth Các môi trường cách ly→