Trackio documentation

Lancement du tableau de bord

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Lancement du tableau de bord

Lancement d'un tableau de bord local

Vous pouvez lancer le tableau de bord en exécutant :

Shell
Python
trackio show

Charger un projet spécifique

Vous pouvez également fournir un nom de project facultatif en tant qu'argument pour charger directement un projet spécifique :

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

Utiliser un frontend personnalisé

Vous pouvez remplacer le tableau de bord intégré par votre propre répertoire de frontend statique. Le répertoire n’a besoin que d’un fichier index.html ; votre frontend peut appeler l’API Trackio existante sous /api/*.

Le flux de travail prévu est le suivant :

  1. Exécutez trackio show --frontend ./my-trackio-frontend.
  2. Demandez à votre LLM de modifier les fichiers dans ce répertoire.
  3. Gardez le navigateur ouvert pendant que Trackio recharge le frontend en direct à mesure que ces fichiers changent.

Si le répertoire passé à --frontend n'existe pas, ou s'il existe mais est vide, Trackio copie automatiquement le frontend de démarrage, affiche un message indiquant qu'il l'a fait, puis sert ce répertoire. Le starter est un modèle complet en HTML/CSS/JS pur : il appelle l'API Trackio, charge les projets et les exécutions, récupère les valeurs des métriques et dessine des graphiques simples que vous pouvez remplacer par votre propre interface utilisateur.

Les points de terminaison HTTP actuellement disponibles sont :

  • 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 pour les téléversements de fichiers multipart utilisés par les flux liés aux médias et aux fichiers

Pour lire les fichiers stockés renvoyés par l’API, Trackio sert également GET /file?path=....

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

Si le répertoire frontend fourni n'est pas vide mais est invalide, Trackio revient au modèle de démarrage fourni.

Définir un frontend par défaut persistant

Si vous souhaitez que le même frontend personnalisé soit utilisé par défaut par trackio show, trackio sync et les flux de déploiement, enregistrez-le dans la configuration persistante de Trackio :

trackio config set frontend ./my-trackio-frontend

Réinitialisez-le avec :

trackio config unset frontend

Personnalisation des couleurs des graphiques

Vous pouvez personnaliser la palette de couleurs utilisée pour les lignes du graphique en fournissant l'argument color_palette. Cela est utile si vous souhaitez correspondre à l'identité visuelle de votre organisation ou si vous avez des préférences de couleurs spécifiques.

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

Les couleurs seront utilisées en boucle lors de l’affichage de plusieurs exécutions. Vous pouvez fournir autant de couleurs que vous le souhaitez, ou aussi peu.

Activer l’accès à distance

Par défaut, le tableau de bord est lié à 127.0.0.1 (localhost), ce qui signifie qu’il ne peut être accédé que depuis la même machine. Pour autoriser l’accès à distance depuis d’autres machines du réseau, utilisez l’option --host :

Shell
Python
trackio show --host 0.0.0.0

Ceci est particulièrement utile lorsque vous exécutez Trackio sur un serveur distant ou dans un environnement conteneurisé où vous devez accéder au tableau de bord depuis une autre machine.

Lancement d'un tableau de bord dans Jupyter Notebooks

Vous pouvez également lancer le tableau de bord directement dans un Jupyter Notebook. Utilisez simplement la même commande que ci-dessus :

import trackio

trackio.show()

Consultez le cahier de démonstration.

Update on GitHub