Hugging Face's logo

Hub Python Library documentation

ジョブ

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

ジョブ

Hub上のJobsを管理するためのメソッドの参考情報については、HfApiのドキュメントページを確認してください。

データ構造

JobInfo

クラス huggingface_hub.JobInfo

< >

( **kwargs )

パラメータ

  • id (str) — ジョブ ID。
  • created_at (datetime または None) — Job が作成された日時です。
  • started_at (datetime または None) — Job が実行を開始した時刻。Job がまだスケジューリング中の場合は None です。
  • finished_at (datetime または None) — Job が完了した時刻。Job がスケジューリング中または実行中の場合は None です。
  • docker_image (str または None) — Job に使用される Docker Hub からの Docker イメージです。 が存在する場合は、None にできます。
  • space_id (str または None) — Job に使用される Hugging Face Spaces の Docker イメージです。 docker_image が存在する場合は、None にできます。
  • command (list[str] または None) — Job のコマンド。例: ["python", "-c", "print('hello world')"]
  • arguments (list[str] または None) — コマンドに渡される引数
  • environment (dict[str] または None) — Job の環境変数を辞書として指定します。
  • secrets (dict[str] または None) — Job のシークレット環境変数（暗号化済み）。
  • flavor (str または None) — ハードウェアのフレーバーです。使用可能な値については JobHardware を参照してください。 例: "cpu-basic"。
  • labels (dict[str, str] または None) — ジョブに付与するラベル（キーと値のペア）。
  • volumes (list[Volume] または None) — ジョブのコンテナにマウントされているボリューム（バケット、モデル、データセット、スペース）。
  • status — (JobStatus または None): Job のステータス。例: JobStatus(stage="RUNNING", message=None) ステージの値については JobStage を参照してください。
  • durations (JobDurations または None) — Job のタイミングの分解です。SCHEDULING を含むすべての Job 状態で存在します。
  • owner — (JobOwner または None): Job の所有者。例: JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")
  • initiator (JobInitiator または None) — Job をトリガーした要因です。例えば、cron による実行の場合は JobInitiator(type="scheduled-job", id="...") となります。
  • expose_urls (list[str] または None) — Job の公開ポートにアクセスできるパブリック URL のリスト（公開ポートごとに 1 つ）、 例: ["https://687fb701029421ae5549d998--8000.hf.jobs"]。ポートが公開されていない場合は None になります。 ポートがパブリックでない限り、URL にアクセスするには、Job の名前空間に対する読み取りアクセス権限を持つ HF トークンが必要です。
  • ssh_url (str または None) — Job の SSH エンドポイントです。例: "ssh://687fb701029421ae5549d998@ssh.hf.jobs"。Job が ssh=True で起動された場合のみ存在します。接続には、Job のネームスペースへの書き込みアクセス権と、Hub に登録された SSH 公開鍵が必要です (https://huggingface.co/settings/keys)。
  • network (JobNetwork または None) — Job が参加したネットワークグループと、そのグループ内で使用しているエイリアスです。例: JobNetwork(group="train", aliases=["master"])。 network_group= を指定せずに Job が開始された場合は None になります。
  • retry (int または None) — Job に設定されたリトライ回数 (attempts - 1)。
  • expose (list[int] または None) — Jobs プロキシを介して公開されるすべてのポート（パブリックなポートを含む）。
  • expose_public (list[int] または None) — 認証なしでアクセス可能な公開ポート。

Jobに関する情報を含みます。

例:

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

クラス huggingface_hub.JobOwner

< >

( id: strname: strtype: str )

JobNetwork

クラス huggingface_hub.JobNetwork

< >

( **kwargs )

パラメータ

  • group (str) — network_group= に渡されるネットワークグループの名前。
  • aliases (list[str]) — グループ内でJobが要求するエイリアスです。network_aliases= に渡される値です。指定がない場合は空です。

Network group a Job が参加しました。

JobStage

クラス huggingface_hub.JobStage

< >

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

Hub上のJobの可能なステージの列挙。

Value は文字列と比較できます:

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

クラス huggingface_hub.JobStatus

< >

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

ボリューム

クラス 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またはJobのコンテナにマウントするボリュームを説明します。

to_dict

< >

( )

Hub APIが期待するJSONペイロードにシリアライズします。

to_uri

< >

( )

CLIが期待する形式で、ボリュームをHFマウントURIとして返します。

Update on GitHub

←OAuth サンドボックス→