Trackio documentation

Запуск панели управления

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Запуск панели управления

Запуск локальной панели управления

Вы можете запустить панель управления, выполнив команду:

Shell
Python
trackio show

Загрузка конкретного проекта

Вы также можете указать необязательное имя project в качестве аргумента, чтобы загрузить конкретный проект напрямую:

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

Использование пользовательского фронтенда

Вы можете заменить встроенную панель управления собственной статической директорией фронтенда. В директории достаточно иметь файл index.html; ваш фронтенд может вызывать существующий API Trackio по адресу /api/*.

Предполагаемый рабочий процесс:

  1. Выполните trackio show --frontend ./my-trackio-frontend.
  2. Попросите вашу LLM отредактировать файлы в этой директории.
  3. Держите браузер открытым, пока Trackio в режиме live reload обновляет фронтенд по мере изменения этих файлов.

Если каталог, переданный в --frontend, не существует или существует, но пуст, Trackio автоматически копирует в него стартовый фронтенд, выводит сообщение об этом и затем обслуживает этот каталог. Стартовый вариант представляет собой полноценный шаблон на чистом HTML/CSS/JS: он вызывает API Trackio, загружает проекты и запуски, получает значения метрик и рисует простые графики, которые вы можете заменить собственным интерфейсом.

В настоящее время доступны следующие HTTP-эндпоинты:

  • 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 для загрузки файлов в формате multipart, используемой в потоках, связанных с медиа и файлами

Для чтения сохранённых файлов, возвращаемых API, Trackio также предоставляет GET /file?path=....

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

Если предоставленный каталог фронтенда не пуст, но недействителен, Trackio откатывается к поставляемому стартовому шаблону.

Настройка постоянного фронтенда по умолчанию

Если вы хотите, чтобы тот же пользовательский интерфейс по умолчанию использовался в trackio show, trackio sync и потоках развертывания, сохраните его в постоянном конфигурационном файле Trackio:

trackio config set frontend ./my-trackio-frontend

Сбросьте его с помощью:

trackio config unset frontend

Настройка цветов графиков

Вы можете настроить цветовую палитру, используемую для линий на графике, передав аргумент color_palette. Это полезно, если вы хотите соответствовать фирменному стилю вашей организации или имеете определенные предпочтения по цветам.

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

Цвета будут циклически переключаться при отображении нескольких запусков. Вы можете указать любое количество цветов — от одного до нескольких.

Включение удаленного доступа

По умолчанию панель управления привязывается к 127.0.0.1 (localhost), что означает, что к ней можно получить доступ только с того же компьютера. Чтобы разрешить удалённый доступ с других машин в сети, используйте параметр --host:

Shell
Python
trackio show --host 0.0.0.0

Это особенно полезно при запуске Trackio на удалённом сервере или в контейнеризированной среде, когда необходимо получить доступ к панели управления с другого компьютера.

Запуск панели управления в Jupyter Notebooks

Вы также можете запустить панель управления непосредственно в Jupyter Notebook. Просто используйте ту же команду, что и выше:

import trackio

trackio.show()

Ознакомьтесь с демо-ноутбуком.

Update on GitHub