Справочник по конфигурации Spaces

Spaces настраиваются через блок YAML в начале файла README.md в корне репозитория. Все поддерживаемые параметры перечислены ниже.

title : string
Заголовок для отображения в Space.

emoji : string
Пространственный эмодзи (допускается только один символ эмодзи).

colorFrom : string
Цвет для градиента миниатюры (red, yellow, green, blue, indigo, purple, pink, gray).

colorTo : string
Цвет для градиента миниатюры (red, yellow, green, blue, indigo, purple, pink, gray).

sdk : string
Может принимать значение gradio, docker или static.

python_version: string
Любая допустимая версия Python 3.x или 3.x.x.
По умолчанию — 3.10.

sdk_version : string
Укажите версию Gradio, которую нужно использовать. Поддерживаются все версии Gradio.

suggested_hardware : string
Укажите рекомендуемое оборудование, на котором должен запускаться этот Space.
Полезно для Spaces, предназначенных для дублирования другими пользователями.
Установка этого значения не приводит к автоматическому назначению оборудования для данного Space.
Значение должно быть допустимым типом оборудования. Текущие допустимые типы оборудования:

• CPU: "cpu-basic", "cpu-upgrade"
• GPU: "t4-small", "t4-medium", "l4x1", "l4x4", "l40sx1", "l40sx4", "l40sx8", "rtx-pro-6000", "rtx-pro-6000x2", "rtx-pro-6000x4", "rtx-pro-6000x8", "a10g-small", "a10g-large", "a10g-largex2", "a10g-largex4", "a100-large", "a100x4", "a100x8"

suggested_storage : string
Указывает рекомендуемое постоянное хранилище, на котором должен запускаться этот Space.
Полезно для Spaces, предназначенных для дублирования другими пользователями.
Установка этого значения не приводит к автоматическому назначению постоянного хранилища для данного Space.
Значение должно быть одним из "small", "medium" или "large".

Функция постоянного хранилища больше не доступна, поэтому этот параметр будет проигнорирован.

app_file : string
Путь к основному файлу приложения (содержащему код Python gradio или статический код static html).
Путь указан относительно корня репозитория.

app_build_command : string
Для статических Spaces команда, которая выполняется первой для генерации HTML для отображения. Пример: npm run build.

Это используется в связке с app_file, который указывает на собранный файл индекса: например, app_file: dist/index.html.

При каждом обновлении команда сборки выполняется в Job, а результат сборки сохраняется в refs/convert/build, который будет обслуживаться Space. Пример можно найти по адресу https://huggingface.co/spaces/coyotte508/static-vite

app_port : int
Порт, на котором запущено ваше приложение. Используется только в том случае, если sdk равно docker. Порт по умолчанию — 7860.

base_path: string Для нестатических Spaces — начальный URL для рендеринга. Должен начинаться с /. Для статических Spaces используйте вместо этого app_file.

fullWidth: boolean
Определяет, будет ли ваш Space отображаться в колонке полной ширины (если true) или в колонке фиксированной ширины (например, CSS-класс “container”) внутри iframe. По умолчанию true.

header: string
Может принимать значение mini или default. Если header установлен в mini, пространство будет отображаться на весь экран с мини-плавающим заголовком.

short_description: string Краткое описание Space. Отображается в миниатюре Space.

models : List[string]
Идентификаторы моделей HF (например, openai-community/gpt2 или deepset/roberta-base-squad2), используемые в Space. Если не указаны здесь, будут автоматически распознаны из вашего кода.

datasets : List[string]
ID датасетов HF (например, mozilla-foundation/common_voice_13_0 или oscar-corpus/OSCAR-2109), используемые в Space. Если не указаны здесь, будут автоматически распознаны из вашего кода.

tags : List[string]
Список терминов, описывающих задачу или область применения вашего Space.

thumbnail: string
URL для определения пользовательского миниатюрного изображения для социальных сетей.

pinned : boolean
Определяет, закрепляется ли Space вверху вашего профиля. Может быть полезно, если у вас много Spaces, чтобы вы и другие могли быстро найти ваш лучший Space.

hf_oauth : boolean
Указывает, связано ли с этим Space подключенное OAuth-приложение. Подробности см. в разделе Добавление кнопки входа через HF в ваш Space.

hf_oauth_scopes : List[string] Разрешённые области (scopes) подключённого OAuth-приложения. openid и profile разрешены по умолчанию, поэтому этот параметр для них не требуется. Подробнее см. в разделе Добавление кнопки входа через HF в ваше пространство.

hf_oauth_expiration_minutes : int Срок действия OAuth-токена в минутах. По умолчанию — 480 минут (8 часов). Максимальный срок — 43200 минут (30 дней). Подробнее см. в разделе Добавление кнопки входа через HF в ваше пространство.

hf_oauth_authorized_org : string или List[string] Ограничивает доступ OAuth для членов конкретных организаций. Подробности см. в разделе Добавление кнопки Sign-In with HF в ваше пространство.

disable_embedding : boolean Определяет, можно ли встроить iframe Space на другие сайты. По умолчанию false, то есть Spaces можно встраивать.

startup_duration_timeout: string Установите пользовательский тайм-аут запуска для вашего Space. Это максимальное время, в течение которого Space может запускаться, прежде чем произойдёт тайм-аут и он будет помечен как нездоровый. По умолчанию составляет 30 минут, но допустима любая корректная длительность (например, 1h, 30m).

custom_headers : Dict[string, string]
Устанавливает пользовательские HTTP-заголовки, которые будут добавляться ко всем HTTP-ответам при обслуживании вашего Space.
На данный момент разрешены только заголовки cross-origin-embedder-policy (COEP), cross-origin-opener-policy (COOP) и cross-origin-resource-policy (CORP). Эти заголовки можно использовать для настройки среды с изоляцией между источниками и включения мощных функций, таких как SharedArrayBuffer, например:

custom_headers:
  cross-origin-embedder-policy: require-corp
  cross-origin-opener-policy: same-origin
  cross-origin-resource-policy: cross-origin

Примечание: все заголовки и значения должны быть в нижнем регистре.

preload_from_hub: List[string] Укажите список моделей Hugging Face Hub или других крупных файлов, которые нужно предварительно загрузить во время сборки вашего Space. Это оптимизирует время запуска, так как файлы будут готовы к моменту старта вашего приложения. Это особенно полезно для Spaces, которые зависят от крупных моделей или наборов данных, которые в противном случае пришлось бы скачивать во время выполнения.

Формат для каждого элемента — "repository_name" для загрузки всех файлов из репозитория или "repository_name file1,file2" для загрузки конкретных файлов из этого репозитория. Также можно указать конкретный коммит для загрузки, используя формат "repository_name file1,file2 commit_sha256".

Пример использования:

preload_from_hub:
  - warp-ai/wuerstchen-prior text_encoder/model.safetensors,prior/diffusion_pytorch_model.safetensors
  - coqui/XTTS-v1
  - openai-community/gpt2 config.json 11c5a3d5811f50298f278a704980280950aedb10

В этом примере Space во время сборки предварительно загрузит с Hugging Face Hub конкретные файлы .safetensors из warp-ai/wuerstchen-prior, весь репозиторий coqui/XTTS-v1 и конкретную ревизию файла config.json в репозитории openai-community/gpt2.

Файлы сохраняются в кэше на диске по умолчанию huggingface_hub ~/.cache/huggingface/hub. Если ваше приложение ожидает их в другом месте или вы изменили переменную HF_HOME, то на данный момент эта предварительная загрузка не учитывает эти изменения.

Предварительная загрузка частных репозиториев пока не поддерживается.