Referencia de configuración de Spaces

Los Spaces se configuran mediante el bloque YAML situado al inicio del archivo README.md en la raíz del repositorio. A continuación se enumeran todos los parámetros aceptados.

title : string
Título de visualización para el Space.

emoji : string
Emoji de espacio (se permite un carácter solo de emoji).

colorFrom : string
Color para el degradado de la miniatura (rojo, amarillo, verde, azul, índigo, morado, rosa, gris).

colorTo : string
Color para el degradado de la miniatura (rojo, amarillo, verde, azul, índigo, morado, rosa, gris).

sdk : string
Puede ser gradio, docker o static.

python_version: string
Cualquier versión válida de Python 3.x o 3.x.x.
El valor predeterminado es 3.10.

sdk_version : string
Especifica la versión de Gradio que se va a utilizar. Se admiten todas las versiones de Gradio.

suggested_hardware : string
Especifica el hardware sugerido en el que debe ejecutarse este Space.
Útil para Spaces que están destinados a ser duplicados por otros usuarios.
Establecer este valor no asignará automáticamente un hardware a este Space.
El valor debe ser un sabor de hardware válido. Sabores de hardware válidos actuales:

• 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
Especifica el almacenamiento permanente sugerido en el que debe ejecutarse este Space.
Útil para Spaces que están destinados a ser duplicados por otros usuarios.
Establecer este valor no asignará automáticamente un almacenamiento permanente a este Space.
El valor debe ser uno de "small", "medium" o "large".

La función de almacenamiento persistente ya no está disponible, por lo que esta configuración se ignorará.

app_file : string
Ruta a su archivo principal de la aplicación (que contiene código Python de gradio o código html static).
La ruta es relativa a la raíz del repositorio.

app_build_command : string
Para los Spaces estáticos, comando que se ejecuta primero para generar el HTML que se va a renderizar. Ejemplo: npm run build.

Se utiliza junto con app_file, que apunta al archivo de índice compilado: p. ej. app_file: dist/index.html.

En cada actualización, el comando de compilación se ejecutará en un Job y la salida de la compilación se almacenará en refs/convert/build, que será servida por el Space. Consulta un ejemplo en https://huggingface.co/spaces/coyotte508/static-vite

app_port : int
Puerto en el que se está ejecutando su aplicación. Se utiliza solo si sdk es docker. El puerto predeterminado es 7860.

base_path: string Para Spaces no estáticos, la url inicial para renderizar. Debe comenzar con /. Para Spaces estáticos, usa app_file en su lugar.

fullWidth: boolean
Indica si tu Space se renderiza dentro de una columna de ancho completo (cuando true) o de ancho fijo (es decir, CSS “container”) dentro del iframe. El valor predeterminado es true.

header: string
Puede ser mini o default. Si header se establece en mini, el espacio se mostrará a pantalla completa con una cabecera flotante mini.

short_description: string Una descripción breve del Space. Se mostrará en la miniatura del Space.

models : List[string]
IDs de modelos de HF (como openai-community/gpt2 o deepset/roberta-base-squad2) utilizados en el Space. Se analizarán automáticamente desde tu código si no se especifican aquí.

datasets : List[string]
HF dataset IDs (like mozilla-foundation/common_voice_13_0 or oscar-corpus/OSCAR-2109) used in the Space. Will be parsed automatically from your code if not specified here.

tags : List[string]
Lista de términos que describen la tarea o el alcance de tu Space.

thumbnail: string
URL para definir una miniatura personalizada para el uso en redes sociales.

pinned : boolean
Indica si el Space permanece en la parte superior de tu perfil. Puede ser útil si tienes muchos Spaces, para que tú y otras personas puedan ver rápidamente tu mejor Space.

hf_oauth : boolean
Indica si una aplicación de OAuth conectada está asociada a este Space. Consulte Adding a Sign-In with HF button to your Space para más detalles.

hf_oauth_scopes : List[string] Alcances autorizados de la aplicación OAuth conectada. openid y profile están autorizados de forma predeterminada y no requieren este parámetro. Consulte Agregar un botón de Iniciar sesión con HF a su espacio para obtener más detalles.

hf_oauth_expiration_minutes : int Duración del token OAuth en minutos. El valor predeterminado es de 480 minutos (8 horas). La duración máxima es de 43200 minutos (30 días). Consulte Añadir un botón de Iniciar sesión con HF a su espacio para obtener más detalles.

hf_oauth_authorized_org : string o List[string] Restringe el acceso de OAuth a miembros de organizaciones específicas. Consulta Añadir un botón de Sign-In with HF a tu space para más detalles.

disable_embedding : boolean Indica si el iframe del Space puede incrustarse en otros sitios web. El valor predeterminado es false, es decir, los Spaces pueden incrustarse.

startup_duration_timeout: string Establece un tiempo de espera personalizado para la duración de inicio de tu Space. Este es el tiempo máximo que se permite a tu Space para iniciar antes de que se agote el tiempo de espera y se marque como no saludable. Por defecto es de 30 minutos, pero se acepta cualquier duración válida (como 1h, 30m).

custom_headers : Dict[string, string]
Establece cabeceras HTTP personalizadas que se añadirán a todas las respuestas HTTP al servir tu Space.
Por ahora, solo se permiten las cabeceras cross-origin-embedder-policy (COEP), cross-origin-opener-policy (COOP) y cross-origin-resource-policy (CORP). Estas cabeceras se pueden utilizar para configurar un entorno aislado entre orígenes y habilitar funciones potentes como SharedArrayBuffer, por ejemplo:

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

Nota: todas las cabeceras y los valores deben estar en minúsculas.

preload_from_hub: List[string] Especifica una lista de modelos de Hugging Face Hub u otros archivos grandes que se precargarán durante la compilación de tu Space. Esto optimiza el tiempo de inicio al tener los archivos listos cuando tu aplicación se inicia. Esto es particularmente útil para Spaces que dependen de modelos o conjuntos de datos grandes que, de lo contrario, necesitarían descargarse en tiempo de ejecución.

El formato de cada elemento es "repository_name" para descargar todos los archivos de un repositorio, o "repository_name file1,file2" para descargar archivos específicos dentro de ese repositorio. También puede especificar un commit específico para descargar usando el formato "repository_name file1,file2 commit_sha256".

Ejemplo de uso:

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

En este ejemplo, el Space pre cargará archivos .safetensors específicos de warp-ai/wuerstchen-prior, el repositorio completo coqui/XTTS-v1 y una revisión específica del archivo config.json en el repositorio openai-community/gpt2 desde el Hugging Face Hub durante el tiempo de compilación.

Los archivos se guardan en la caché de disco predeterminada de huggingface_hub ~/.cache/huggingface/hub. Si su aplicación espera que estén en otra ubicación o si cambió su variable HF_HOME, esta precarga no sigue esa configuración en este momento.

La precarga de repositorios privados aún no está admitida.