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

Consulte a página de documentação do HfApi para a referência dos métodos de gerenciamento dos seus Jobs no Hub.

Estruturas de dados

JobInfo

classe huggingface_hub.JobInfo

< >

( **kwargs )

Parâmetros

  • id (str) — ID do trabalho.
  • created_at (datetime ou None) — Quando o Job foi criado.
  • started_at (datetime ou None) — Quando o Job começou a ser executado. None enquanto o Job ainda estiver em agendamento.
  • finished_at (datetime ou None) — Quando o Job terminou. None enquanto o Job ainda estiver em agendamento ou em execução.
  • docker_image (str ou None) — A imagem Docker do Docker Hub usada para o Job. Pode ser None se space_id estiver presente no lugar dela.
  • space_id (str ou None) — A imagem Docker do Hugging Face Spaces usada para o Job. Pode ser None se docker_image estiver presente no lugar dela.
  • command (list[str] ou None) — Comando do Job, por exemplo, ["python", "-c", "print('hello world')"]
  • arguments (list[str] ou None) — Argumentos passados para o comando
  • environment (dict[str] ou None) — Variáveis de ambiente do Job como um dicionário.
  • secrets (dict[str] ou None) — Variáveis de ambiente secretas do Job (criptografadas).
  • flavor (str ou None) — Flavor para o hardware. Consulte JobHardware para os valores possíveis. Por exemplo, "cpu-basic".
  • labels (dict[str, str] ou None) — Rótulos a serem anexados ao job (pares chave-valor).
  • volumes (list[Volume] ou None) — Volumes montados no contêiner do job (buckets, modelos, conjuntos de dados, spaces).
  • status — (JobStatus ou None): Status do Job, por exemplo, JobStatus(stage="RUNNING", message=None) Veja JobStage para os valores possíveis de stage.
  • durations (JobDurations ou None) — Detalhamento de tempo do Job. Presente para todos os estados do job, incluindo SCHEDULING.
  • owner — (JobOwner ou None): Proprietário do Job, por exemplo, JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")
  • initiator (JobInitiator ou None) — O que acionou o Job, por exemplo, JobInitiator(type="scheduled-job", id="...") para uma execução acionada por cron.
  • expose_urls (list[str] ou None) — URLs públicas por meio das quais as portas expostas do Job são acessíveis (uma por porta exposta), por exemplo, ["https://687fb701029421ae5549d998--8000.hf.jobs"]. None quando nenhuma porta é exposta. O acesso a uma URL requer um token HF com acesso de leitura ao namespace do Job, a menos que a porta seja pública.
  • ssh_url (str ou None) — Ponto de extremidade SSH do Job, por exemplo, "ssh://687fb701029421ae5549d998@ssh.hf.jobs". Presente apenas quando o Job foi iniciado com ssh=True. A conexão requer acesso de escrita ao namespace do Job e uma chave pública SSH registrada no Hub (https://huggingface.co/settings/keys).
  • network (JobNetwork ou None) — Grupo de rede ao qual o Job pertence e os aliases que ele reivindica, por exemplo, JobNetwork(group="train", aliases=["master"]). None quando o Job foi iniciado sem network_group=.
  • retry (int ou None) — Número de novas tentativas configuradas para o Job (attempts - 1).
  • expose (list[int] ou None) — Todas as portas expostas através do proxy de Jobs, incluindo as públicas.
  • expose_public (list[int] ou None) — Portas expostas acessíveis sem autenticação.

Contém informações sobre um Job.

Exemplo:

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

classe huggingface_hub.JobOwner

< >

( id: strname: strtype: str )

JobNetwork

classe huggingface_hub.JobNetwork

< >

( **kwargs )

Parâmetros

  • group (str) — Nome do grupo de rede, conforme passado para network_group=.
  • aliases (list[str]) — Aliases que o Job reivindica no grupo, conforme passado para network_aliases=. Vazio quando não há.

Grupo de rede ao qual um Job se juntou.

JobStage

classe huggingface_hub.JobStage

< >

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

Enumeração dos possíveis estágios de um Job no Hub.

O valor pode ser comparado a uma 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

classe huggingface_hub.JobStatus

< >

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

Volume

classe huggingface_hub.Volume

< >

( **kwargs )

Parâmetros

  • type (str) — Tipo de volume: "bucket", "model", "dataset" ou "space".
  • source (str) — Identificador da origem, por exemplo, "username/my-bucket" ou "username/my-model".
  • mount_path (str) — Caminho de montagem dentro do contêiner, por exemplo, "/data". Deve começar com /.
  • revision (str ou None) — Revisão Git (apenas para repositórios, padrão é "main").
  • read_only (bool ou None) — Montagem somente leitura. Forçado como True para repositórios, padrão False para buckets.
  • path (str ou None) — Prefixo de subpasta dentro do bucket/repositório para montar, por exemplo, "path/to/dir".

Descreve um volume para montar em um contêiner de Space ou Job.

to_dict

< >

( )

Serializa para o payload JSON esperado pela API do Hub.

to_uri

< >

( )

Retorne o volume como um URI de montagem do HF no formato esperado pelo CLI.

Update on GitHub

←OAuth Sandboxes→