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 la página de documentación de HfApi para obtener la referencia de los métodos para gestionar sus Jobs en el Hub.

Estructuras de datos

JobInfo

clase huggingface_hub.JobInfo

< >

( **kwargs )

Parámetros

  • id (str) — ID del trabajo.
  • created_at (datetime o None) — Momento en que se creó el Job.
  • started_at (datetime o None) — Momento en que el Job comenzó a ejecutarse. None mientras el Job sigue en programación.
  • finished_at (datetime o None) — Momento en que el Job terminó. None mientras el Job sigue en programación o en ejecución.
  • docker_image (str o None) — La imagen de Docker de Docker Hub utilizada para el Job. Puede ser None si en su lugar está presente space_id.
  • space_id (str o None) — La imagen de Docker de Hugging Face Spaces utilizada para el Job. Puede ser None si en su lugar está presente docker_image.
  • command (list[str] o None) — Comando del Job, p. ej. ["python", "-c", "print('hello world')"]
  • arguments (list[str] o None) — Argumentos pasados al comando
  • environment (dict[str] o None) — Variables de entorno del Job como un diccionario.
  • secrets (dict[str] o None) — Variables de entorno secretas del Job (cifradas).
  • flavor (str o None) — Flavor para el hardware. Consulte JobHardware para los valores posibles. Por ejemplo, "cpu-basic".
  • labels (dict[str, str] o None) — Etiquetas para adjuntar al trabajo (pares clave-valor).
  • volumes (list[Volume] o None) — Volúmenes montados en el contenedor del trabajo (buckets, modelos, conjuntos de datos, espacios).
  • status — (JobStatus o None): Estado del Job, p. ej. JobStatus(stage="RUNNING", message=None) Consulta JobStage para los valores de etapa posibles.
  • durations (JobDurations o None) — Desglose de tiempos del Job. Presente en todos los estados del job, incluido SCHEDULING.
  • owner — (JobOwner o None): Propietario del Job, p. ej. JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")
  • initiator (JobInitiator o None) — Lo que desencadenó el Job, por ejemplo, JobInitiator(type="scheduled-job", id="...") para una ejecución activada por cron.
  • expose_urls (list[str] o None) — URLs públicas a través de las cuales se pueden alcanzar los puertos expuestos del Job (una por cada puerto expuesto), p. ej. ["https://687fb701029421ae5549d998--8000.hf.jobs"]. None cuando no se expone ningún puerto. El acceso a una URL requiere un token de HF con acceso de lectura al espacio de nombres del Job, a menos que el puerto sea público.
  • ssh_url (str o None) — Punto de conexión SSH del Job, por ejemplo "ssh://687fb701029421ae5549d998@ssh.hf.jobs". Solo está presente cuando el Job se inició con ssh=True. Para conectar se requiere acceso de escritura al espacio de nombres del Job y una clave pública SSH registrada en el Hub (https://huggingface.co/settings/keys).
  • network (JobNetwork o None) — Grupo de red al que se unió el Job y los alias que reclama, p. ej. JobNetwork(group="train", aliases=["master"]). None cuando el Job se inició sin network_group=.
  • retry (int o None) — Número de reintentos configurados para el Job (attempts - 1).
  • expose (list[int] o None) — Todos los puertos expuestos a través del proxy de Jobs, incluidos los públicos.
  • expose_public (list[int] o None) — Puertos expuestos accesibles sin autenticación.

Contiene información sobre un Job.

Ejemplo:

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

clase huggingface_hub.JobOwner

< >

( id: strname: strtype: str )

JobNetwork

clase huggingface_hub.JobNetwork

< >

( **kwargs )

Parámetros

  • group (str) — Nombre del grupo de red, tal como se pasó a network_group=.
  • aliases (list[str]) — Alias que el Job reclama en el grupo, tal como se pasa a network_aliases=. Vacío cuando no hay ninguno.

Grupo de red: un trabajo se unió.

JobStage

clase huggingface_hub.JobStage

< >

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

Enumeración de las posibles etapas de un Job en el Hub.

Value se puede comparar con una cadena:

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

clase huggingface_hub.JobStatus

< >

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

Volumen

clase huggingface_hub.Volume

< >

( **kwargs )

Parámetros

  • type (str) — Tipo de volumen: "bucket", "model", "dataset" o "space".
  • source (str) — Identificador de origen, p. ej. "username/my-bucket" o "username/my-model".
  • mount_path (str) — Ruta de montaje dentro del contenedor, p. ej. "/data". Debe comenzar con /.
  • revision (str o None) — Revisión de Git (solo para repositorios, por defecto "main").
  • read_only (bool o None) — Montaje de solo lectura. Forzado a True para repositorios, con un valor predeterminado de False para cubos.
  • path (str o None) — Prefijo de subcarpeta dentro del bucket/repo para montar, p. ej. "path/to/dir".

Describe un volumen para montar en un contenedor de Space o Job.

to_dict

< >

( )

Serializa en el payload JSON esperado por la API de Hub.

to_uri

< >

( )

Devuelve el volumen como una URI de montaje de HF en el formato esperado por la CLI.

Update on GitHub

←OAuth Sandboxes→