Referência de Configuração do Spaces

Os Spaces são configurados por meio do bloco YAML no topo do arquivo README.md na raiz do repositório. Todos os parâmetros aceitos estão listados abaixo.

title : string
Título de exibição do Space.

emoji : string
Emoji de espaço (caractere apenas de emoji permitido).

colorFrom : string
Cor para o gradiente da miniatura (red, yellow, green, blue, indigo, purple, pink, gray).

colorTo : string
Cor para o gradiente da miniatura (red, yellow, green, blue, indigo, purple, pink, gray).

sdk : string
Pode ser gradio, docker ou static.

python_version: string
Qualquer versão válida do Python 3.x ou 3.x.x.
O padrão é 3.10.

sdk_version : string
Especifique a versão do Gradio a ser usada. Todas as versões do Gradio são suportadas.

suggested_hardware : string
Especifique o hardware sugerido no qual este Space deve ser executado.
Útil para Spaces que têm a intenção de ser duplicados por outros usuários.
Definir este valor não atribuirá automaticamente um hardware a este Space.
O valor deve ser um sabor de hardware válido. Sabor de hardware válidos atuais:

• 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
Especifique o armazenamento permanente sugerido no qual este Space deve ser executado.
Útil para Spaces que têm a intenção de ser duplicados por outros usuários.
Definir este valor não atribuirá automaticamente um armazenamento permanente a este Space.
O valor deve ser um de "small", "medium" ou "large".

O recurso de armazenamento persistente não está mais disponível, portanto, esta configuração será ignorada.

app_file : string
Caminho para o arquivo principal da sua aplicação (que contém código Python do gradio ou código html static).
O caminho é relativo à raiz do repositório.

app_build_command : string
Para Spaces estáticos, comando a ser executado primeiro para gerar o HTML a ser renderizado. Exemplo: npm run build.

Isso é usado em conjunto com app_file, que aponta para o arquivo de índice compilado: por exemplo, app_file: dist/index.html.

A cada atualização, o comando de build será executado em um Job e a saída do build será armazenada em refs/convert/build, que será servida pelo Space. Veja um exemplo em https://huggingface.co/spaces/coyotte508/static-vite

app_port : int
Porta na qual sua aplicação está em execução. Usado apenas se sdk for docker. A porta padrão é 7860.

base_path: string Para Spaces não estáticos, a URL inicial para renderização. Deve começar com /. Para Spaces estáticos, use app_file em vez disso.

fullWidth: boolean
Indica se o seu Space é renderizado em uma coluna de largura total (quando true) ou em uma coluna de largura fixa (ou seja, CSS “container”) dentro do iframe. O valor padrão é true.

header: string
Pode ser mini ou default. Se header for definido como mini, o espaço será exibido em tela cheia com um cabeçalho flutuante mini.

short_description: string Uma breve descrição do Space. Isso será exibido na miniatura do Space.

models : List[string]
IDs de modelos do HF (como openai-community/gpt2 ou deepset/roberta-base-squad2) usados no Space. Serão analisados automaticamente do seu código, caso não sejam especificados aqui.

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 termos que descrevem a tarefa ou o escopo do seu Space.

thumbnail: string
URL para definir uma miniatura personalizada para compartilhamento em redes sociais.

pinned : boolean
Se o Space permanece no topo do seu perfil. Pode ser útil se você tiver muitos Spaces, para que você e outros possam ver rapidamente seu melhor Space.

hf_oauth : boolean
Indica se um aplicativo OAuth conectado está associado a este Space. Consulte Adicionando um botão de Sign-In with HF ao seu Space para mais detalhes.

hf_oauth_scopes : List[string] Escopos autorizados do aplicativo OAuth conectado. openid e profile são autorizados por padrão e não precisam deste parâmetro. Consulte Adicionando um botão de Sign-In with HF ao seu space para mais detalhes.

hf_oauth_expiration_minutes : int Duração do token OAuth em minutos. O padrão é 480 minutos (8 horas). A duração máxima é 43200 minutos (30 dias). Consulte Adicionando um botão Sign-In with HF ao seu espaço para mais detalhes.

hf_oauth_authorized_org : string ou List[string] Restringe o acesso via OAuth a membros de organizações específicas. Consulte Adicionando um botão Sign-In with HF ao seu space para mais detalhes.

disable_embedding : boolean Se o iframe do Space pode ser incorporado em outros sites. O valor padrão é false, ou seja, os Spaces podem ser incorporados.

startup_duration_timeout: string Defina um tempo limite personalizado de inicialização para o seu Space. Este é o tempo máximo que o seu Space pode levar para iniciar antes de expirar o tempo limite e ser marcado como não saudável. O padrão é 30 minutos, mas qualquer duração válida (como 1h, 30m) é aceita.

custom_headers : Dict[string, string]
Defina cabeçalhos HTTP personalizados que serão adicionados a todas as respostas HTTP ao servir seu Space.
Por enquanto, apenas os cabeçalhos cross-origin-embedder-policy (COEP), cross-origin-opener-policy (COOP) e cross-origin-resource-policy (CORP) são permitidos. Esses cabeçalhos podem ser usados para configurar um ambiente isolado entre origens e habilitar recursos poderosos, como SharedArrayBuffer, por exemplo:

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

Observação: todos os cabeçalhos e valores devem estar em minúsculas.

preload_from_hub: List[string] Especifique uma lista de modelos do Hugging Face Hub ou outros arquivos grandes para serem pré-carregados durante o tempo de compilação do seu Space. Isso otimiza o tempo de inicialização, mantendo os arquivos prontos quando sua aplicação inicia. Isso é particularmente útil para Spaces que dependem de modelos ou conjuntos de dados grandes que, de outra forma, precisariam ser baixados em tempo de execução.

O formato de cada item é "repository_name" para baixar todos os arquivos de um repositório, ou "repository_name file1,file2" para baixar arquivos específicos dentro desse repositório. Você também pode especificar um commit específico para download usando o formato "repository_name file1,file2 commit_sha256".

Exemplo 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

Neste exemplo, o Space pré-carregará arquivos .safetensors específicos de warp-ai/wuerstchen-prior, o repositório completo coqui/XTTS-v1 e uma revisão específica do arquivo config.json no repositório openai-community/gpt2 do Hugging Face Hub durante o tempo de build.

Os arquivos são salvos no cache de disco padrão do huggingface_hub ~/.cache/huggingface/hub. Se o seu aplicativo os espera em outro local ou se você alterou sua variável HF_HOME, esse pré-carregamento não segue essa configuração no momento.

O pré-carregamento de repositórios privados ainda não é suportado.