Hugging Face's logo

Hub Python Library documentation

Задания

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v2.4.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Задания

См. страницу документации HfApi для справочника методов управления вашими Jobs на Hub.

Структуры данных

JobInfo

класс huggingface_hub.JobInfo

< >

( **kwargs )

Параметры

  • id (str) — Идентификатор задания.
  • created_at (datetime или None) — Время создания Job.
  • started_at (datetime или None) — Момент начала выполнения Job. Значение None, пока Job находится в очереди на планирование.
  • finished_at (datetime или None) — Время завершения Job. Значение None, пока Job находится в очереди или выполняется.
  • docker_image (str or None) — Образ Docker из Docker Hub, используемый для Job. Может быть None, если вместо него указано space_id.
  • space_id (str or None) — Образ Docker из Hugging Face Spaces, используемый для Job. Может быть None, если вместо него указан docker_image.
  • command (list[str] или None) — Команда Job, например ["python", "-c", "print('hello world')"]
  • arguments (list[str] или None) — Аргументы, передаваемые команде
  • environment (dict[str] или None) — Переменные окружения Job в виде словаря.
  • secrets (dict[str] или None) — Секретные переменные окружения задания (зашифрованные).
  • flavor (str or None) — Вариант для оборудования. См. JobHardware для возможных значений. Например, "cpu-basic".
  • labels (dict[str, str] или None) — Метки, которые нужно назначить задаче (пары ключ-значение).
  • volumes (list[Volume] or None) — Тома, смонтированные в контейнере задания (бакеты, модели, наборы данных, пространства).
  • status — (JobStatus или None): Статус задачи, например, JobStatus(stage="RUNNING", message=None) См. JobStage для возможных значений этапов.
  • durations (JobDurations или None) — Разбивка по времени выполнения Job. Присутствует для всех состояний job, включая SCHEDULING.
  • owner — (JobOwner или None): Владелец Job, например, JobOwner(id="5e9ecfc04957053f60648a3e", name="lhoestq", type="user")
  • initiator (JobInitiator или None) — Что инициировало Job, например JobInitiator(type="scheduled-job", id="...") для запуска по расписанию cron.
  • expose_urls (list[str] или None) — Публичные URL, по которым доступны открытые порты Job (один URL на каждый открытый порт), например, ["https://687fb701029421ae5549d998--8000.hf.jobs"]. None, если ни один порт не открыт. Для доступа к URL требуется HF-токен с правами на чтение в пространстве имён Job, если только порт не является публичным.
  • ssh_url (str or None) — SSH-адрес Job, например "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"]). None, если Job был запущен без network_group=.
  • retry (int or 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=. Пусто, если их нет.

Группа сети a Job присоединилась.

JobStage

класс huggingface_hub.JobStage

< >

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

Перечисление возможных стадий выполнения задачи (Job) на Hub.

Значение можно сравнить со строкой:

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 or None) — Префикс подпапки внутри bucket/repo для монтирования, например, "path/to/dir".

Описывает том для монтирования в контейнере Space или Job.

to_dict

< >

( )

Сериализуйте в JSON-нагрузку, ожидаемую API Hub.

to_uri

< >

( )

Возвращает том в виде URI монтирования HF в формате, ожидаемом CLI.

Update on GitHub

←OAuth Песочницы→