Trackio documentation

Implantação e incorporação de painéis

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Implantação e incorporação de painéis

Implantação nos Hugging Face Spaces

Ao chamar init(), por padrão, o serviço será executado localmente e armazenará os dados do projeto na máquina local.

Mas, se você passar um space_id para init(), como:

trackio.init(project="my-project", space_id="orgname/space_id")

ou

trackio.init(project="my-project", space_id="username/space_id")

ele usará um Hugging Face Space existente ou implantará automaticamente um novo conforme necessário. Você deve estar conectado localmente com o huggingface-cli e seu token deve ter permissões de escrita para criar o Space.

Sincronizando Projetos Locais com Spaces

Se você estava registrando localmente e deseja enviar seus dados para um Space depois, use sync:

trackio.sync(project="my-project", space_id="username/space_id")

Ou pela CLI:

trackio sync --project "my-project" --space-id "username/space_id"

Por padrão, o sync implanta um Gradio Space com um servidor ao vivo. Você também pode implantar um static Space que lê de um HF Bucket (sem necessidade de servidor):

trackio.sync(project="my-project", space_id="username/space_id", sdk="static")
trackio sync --project "my-project" --space-id "username/space_id" --sdk static

Os Spaces estáticos são leves e gratuitos — eles servem um dashboard somente leitura baseado em arquivos Parquet em um HF Bucket. Como o dashboard é executado inteiramente no navegador, os Spaces estáticos do Trackio exigem dados de snapshot públicos e não suportam private=True. Use o Space Gradio padrão (sdk="gradio") para dashboards privados.

Congelando um instantâneo de um Space

Se você tem um Espaço Gradio ao vivo e deseja criar um snapshot estático somente de leitura dos dados de um projeto, use freeze:

trackio.freeze(space_id="username/my-space", project="my-project")

Ou pela CLI:

trackio freeze --space-id "username/my-space" --project "my-project"

Isso cria um novo Space estático (com o nome padrão {space_id}_static) contendo um instantâneo dos dados do projeto do bucket do Space de origem. O Space original não é modificado.

Observe quefreeze() é um instantâneo de uso único. Se novas métricas forem enviadas posteriormente ao Gradio Space original, o Gradio Space estático congelado não será atualizado automaticamente. O Gradio Space de origem pode usar um bucket privado, mas o instantâneo estático congelado é público. freeze(private=True) não é suportado; use um Gradio Space se o dashboard congelado precisar permanecer privado.

Você pode personalizar o destino:

trackio.freeze(
    space_id="username/my-space",
    project="my-project",
    new_space_id="username/my-snapshot",
)

Observação: freeze() exige que a origem seja um Gradio Space com um bucket montado em /data. Se o Space de destino já existir e não for um Trackio static Space, freeze() recusará sobrescrevê-lo.

Incorporando um painel do Trackio

Uma das razões pelas quais criamos o trackio foi facilitar a incorporação de painéis ao vivo em sites, posts de blog ou em qualquer outro lugar onde você possa incorporar um site.

image

Se o seu painel do Trackio estiver hospedado no Spaces, você pode incorporá-lo em qualquer lugar usando um <iframe>:

<iframe src="https://username-space_id.hf.space"></iframe>

Você também pode filtrar o painel para exibir apenas projetos ou métricas específicos usando parâmetros de consulta. Os parâmetros suportados incluem:

  • project (string): Exibe apenas um projeto específico.

  • metrics (lista separada por vírgulas): Exibe apenas métricas específicas, por exemplo, train_loss,train_accuracy.

  • sidebar (string, "auto", "visible", "collapsed" ou "hidden"):

    • "auto" abre ou recolhe a barra lateral com base na largura da viewport e é o padrão.
    • "visible" inicia com a barra lateral totalmente aberta.
    • "collapsed" começa apenas com a barra estreita.
    • "hidden" oculta completamente a barra lateral.

    Os modos explícitos não são alterados quando a viewport é redimensionada.

  • footer (string, "false"): Quando definido como "false", oculta o rodapé do Gradio. Por padrão, o rodapé é visível.

  • xmin (number): Define o valor mínimo inicial para os limites do eixo x em todos os gráficos de métricas.

  • xmax (number): Define o valor máximo inicial para os limites do eixo x em todos os gráficos de métricas.

  • smoothing (número): Define o valor inicial do controle deslizante de suavização (0-20, onde 0 = sem suavização).

  • plots_per_row (auto ou inteiro de 1 a 6): Define o valor inicial do controle Plots per row. O padrão é auto, que ajusta os plots à largura disponível.

  • accordion (string, "hidden"): Quando definido como "hidden", oculta os acordeões de cabeçalho de seção ao redor dos grupos de métricas. Por padrão, os cabeçalhos de seção são visíveis.

Você pode personalizar seu <iframe> usando atributos padrão, como width, height e style. Para mais detalhes, consulte MDN Web Docs: <iframe>. Por exemplo:

<iframe 
    src="https://trackio-documentation.hf.space/?project=my-project&metrics=train_loss,train_accuracy&sidebar=hidden" 
    width="600" 
    height="630" 
    style="border:0;">
</iframe>
Update on GitHub