Hub Python 函式庫文件
Jobs
加入 Hugging Face 社群
並獲得增強的文件體驗
開始使用
作業 (Jobs)
請查閱 HfApi 文件頁面，以獲取在 Hub 上管理作業的方法參考。
- 執行作業： run_job()
- 獲取日誌： fetch_job_logs()
- 獲取指標： fetch_job_metrics()
- 檢查作業： inspect_job()
- 列出作業： list_jobs()
- 取消作業： cancel_job()
- 執行 UV 作業： run_uv_job()
資料結構
JobInfo
class huggingface_hub.JobInfo
< 原始碼 >( **kwargs )
參數
- id (
str) — 作業 ID。 - created_at (
datetime或None) — 作業建立時間。 - started_at (
datetime或None) — 作業開始運行的時間。當作業仍處於排程階段時為 None。 - finished_at (
datetime或None) — 作業完成時間。當作業仍處於排程或執行階段時為 None。 - docker_image (
str或None) — 用於該作業的 Docker Hub Docker 映像檔。如果存在 space_id，則可以為 None。 - space_id (
str或None) — 用於該作業的 Hugging Face Spaces Docker 映像檔。如果存在 docker_image，則可以為 None。 - command (
list[str]或None) — 作業的指令，例如["python", "-c", "print('hello world')"] - arguments (
list[str]或None) — 傳遞給指令的參數 - environment (
dict[str]或None) — 以字典形式表示的作業環境變數。 - secrets (
dict[str]或None) — 作業的密鑰環境變數（已加密）。 - flavor (
str或None) — 硬體類型，與 Hugging Face Spaces 相同。請參閱 SpaceHardware 以了解可能的值。例如"cpu-basic"。 - labels (
dict[str, str]或None) — 要附加到作業的標籤（鍵值對）。 - volumes (
list[Volume]或None) — 掛載在作業容器中的磁碟區（儲存桶、模型、資料集、Spaces）。 - status — (
JobStatus或None)：作業狀態，例如JobStatus(stage="RUNNING", message=None)。請參閱 JobStage 以了解可能的階段值。 - durations (
JobDurations或None) — 作業的時間細分。適用於所有作業狀態，包括 SCHEDULING。 - owner — (
JobOwner或None)：作業擁有者，例如JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user") - initiator (
JobInitiator或None) — 觸發作業的原因，例如用於排程作業 (cron-triggered run) 的JobInitiator(type="scheduled-job", id="...")。
包含有關作業的資訊。
範例
>>> 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
JobStage
class huggingface_hub.JobStage
< 原始碼 >( value names = None module = None qualname = None type = None start = 1 )
Hub 上作業可能階段的列舉。
可能的值為： `COMPLETED`、`CANCELED`、`ERROR`、`DELETED`、`SCHEDULING`、`RUNNING`。取自 https://github.com/huggingface/moon-landing/blob/main/server/job_types/JobInfo.ts#L61 (私人網址)。JobStatus
Volume
class huggingface_hub.Volume
< 原始碼 >( **kwargs )
參數
- type (
str) — 磁碟區類型："bucket"、"model"、"dataset"或"space"。 - source (
str) — 來源識別碼，例如"username/my-bucket"或"username/my-model"。 - mount_path (
str) — 容器內的掛載路徑，例如"/data"。必須以/開頭。 - revision (
str或None) — Git 版本（僅適用於儲存庫，預設為"main"）。 - read_only (
bool或None) — 唯讀掛載。儲存庫強制為True，儲存桶預設為False。 - path (
str或None) — 要掛載的儲存桶/儲存庫內的子資料夾前綴，例如"path/to/dir"。
描述在 Space 或作業容器中掛載的磁碟區。
序列化為 Hub API 預期的 JSON 酬載。
以 CLI 預期的格式回傳磁碟區作為 HF 掛載 URI。