Trackio documentation

Lançando o Dashboard

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Lançando o Dashboard

Iniciando um painel local

Você pode iniciar o dashboard executando:

Shell
Python
trackio show

Carregando um Projeto Específico

Você também pode fornecer um nome de project opcional como argumento para carregar um projeto específico diretamente:

Shell
Python
trackio show --project "my-project"

Usando um Frontend Personalizado

Você pode substituir o dashboard incluído pelo seu próprio diretório de frontend estático. O diretório precisa apenas de um arquivo index.html; seu frontend pode chamar a API existente do Trackio em /api/*.

O fluxo de trabalho pretendido é:

  1. Execute trackio show --frontend ./my-trackio-frontend.
  2. Peça ao seu LLM para editar os arquivos nesse diretório.
  3. Mantenha o navegador aberto enquanto o Trackio recarrega o frontend em tempo real à medida que esses arquivos são alterados.

Se o diretório passado para --frontend não existir, ou existir, mas estiver vazio, o Trackio copia automaticamente o frontend inicial, exibe uma mensagem indicando que isso foi feito e, em seguida, serve esse diretório. O inicial é um modelo completo em HTML/CSS/JS puro: ele chama a API do Trackio, carrega projetos e execuções, busca os valores das métricas e desenha gráficos simples que você pode substituir pela sua própria interface.

Os endpoints HTTP atualmente disponíveis são:

  • POST /api/get_run_mutation_status
  • POST /api/upload_db_to_space
  • POST /api/bulk_upload_media
  • POST /api/log
  • POST /api/bulk_log
  • POST /api/bulk_log_system
  • POST /api/bulk_alert
  • POST /api/get_alerts
  • POST /api/get_metric_values
  • POST /api/get_runs_for_project
  • POST /api/get_metrics_for_run
  • POST /api/get_all_projects
  • POST /api/get_project_summary
  • POST /api/get_run_summary
  • POST /api/get_system_metrics_for_run
  • POST /api/get_system_logs
  • POST /api/get_system_logs_batch
  • POST /api/get_snapshot
  • POST /api/get_logs
  • POST /api/get_logs_batch
  • POST /api/get_traces
  • POST /api/query_project
  • POST /api/get_settings
  • POST /api/get_project_files
  • POST /api/delete_run
  • POST /api/rename_run
  • POST /api/force_sync
  • POST /api/upload para uploads de arquivos multipart usados em fluxos relacionados a mídia e arquivos

Para ler arquivos armazenados retornados pela API, o Trackio também oferece GET /file?path=....

Shell
Python
trackio show --frontend ./my-trackio-frontend

Se o diretório de frontend fornecido não estiver vazio, mas for inválido, o Trackio recorre ao modelo inicial incluído.

Definindo um Frontend Padrão Persistente

Se você deseja que o mesmo frontend personalizado seja usado por padrão pelo trackio show, trackio sync e pelos fluxos de deploy, salve-o na configuração persistente do Trackio:

trackio config set frontend ./my-trackio-frontend

Redefina-o com:

trackio config unset frontend

Personalizando as cores dos gráficos

Você pode personalizar a paleta de cores usada para as linhas do gráfico fornecendo o argumento color_palette. Isso é útil se você deseja corresponder à identidade visual da sua organização ou tem preferências específicas de cores.

Shell
Python
trackio show --color-palette "#FF0000,#00FF00,#0000FF"

As cores serão alternadas ao exibir múltiplas execuções. Você pode fornecer quantas cores quiser, sejam muitas ou poucas.

Habilitando o Acesso Remoto

Por padrão, o dashboard é vinculado a 127.0.0.1 (localhost), o que significa que ele só pode ser acessado a partir da mesma máquina. Para permitir o acesso remoto de outras máquinas na rede, use a opção --host:

Shell
Python
trackio show --host 0.0.0.0

Isso é particularmente útil ao executar o Trackio em um servidor remoto ou em um ambiente containerizado, onde é necessário acessar o dashboard a partir de outra máquina.

Lançando um Dashboard em Jupyter Notebooks

Você também pode iniciar o dashboard diretamente dentro de um Jupyter Notebook. Basta usar o mesmo comando acima:

import trackio

trackio.show()

Confira o notebook de demonstração.

Update on GitHub