Trackio documentation

Iniciando el Panel

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Iniciando el Panel

Iniciar un panel de control local

Puede iniciar el panel de control ejecutando:

Shell
Python
trackio show

Cargar un proyecto específico

También puede proporcionar un nombre de project opcional como argumento para cargar un proyecto específico directamente:

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

Uso de un frontend personalizado

Puede reemplazar el panel de control incluido con su propio directorio de frontend estático. El directorio solo necesita un archivo index.html; su frontend puede llamar a la API existente de Trackio bajo /api/*.

El flujo de trabajo previsto es:

  1. Ejecuta trackio show --frontend ./my-trackio-frontend.
  2. Pídale a su LLM que edite los archivos en ese directorio.
  3. Mantén el navegador abierto mientras Trackio recarga el frontend en vivo a medida que cambian esos archivos.

Si el directorio pasado a --frontend no existe, o existe pero está vacío, Trackio copia automáticamente el frontend inicial, imprime que lo ha hecho y luego sirve ese directorio. El inicial es una plantilla completa de HTML/CSS/JS plano: llama a la API de Trackio, carga proyectos y ejecuciones, obtiene los valores de las métricas y dibuja gráficos simples que puedes reemplazar con tu propia interfaz de usuario.

Los puntos finales HTTP disponibles actualmente son:

  • 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 cargas de archivos multipartes utilizadas por los flujos relacionados con medios y archivos

Para leer los archivos almacenados que devuelve la API, Trackio también sirve GET /file?path=....

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

Si el directorio de frontend proporcionado no está vacío pero es inválido, Trackio recurre a la plantilla inicial incluida.

Establecer un frontend predeterminado persistente

Si desea que el mismo frontend personalizado se utilice de forma predeterminada por trackio show, trackio sync y los flujos de despliegue, guárdelo en la configuración persistente de Trackio:

trackio config set frontend ./my-trackio-frontend

Restablécelo con:

trackio config unset frontend

Personalizar los colores de los gráficos

Puedes personalizar la paleta de colores utilizada para las líneas del gráfico proporcionando el argumento color_palette. Esto es útil si deseas que coincida con la identidad de marca de tu organización o si tienes preferencias de color específicas.

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

Los colores se alternarán al mostrar varias ejecuciones. Puede proporcionar tantos o tan pocos colores como desee.

Habilitar el acceso remoto

Por defecto, el panel de control se une a 127.0.0.1 (localhost), lo que significa que solo se puede acceder desde la misma máquina. Para permitir el acceso remoto desde otras máquinas de la red, use la opción --host:

Shell
Python
trackio show --host 0.0.0.0

Esto resulta especialmente útil al ejecutar Trackio en un servidor remoto o en un entorno containerizado donde es necesario acceder al panel desde otra máquina.

Lanzar un panel de control en Jupyter Notebooks

También puede iniciar el panel de control directamente dentro de un Jupyter Notebook. Solo use el mismo comando que se muestra arriba:

import trackio

trackio.show()

Comprueba el cuaderno de demostración.

Update on GitHub