Trackio documentation

Meluncurkan Dasbor

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Meluncurkan Dasbor

Meluncurkan Dasbor Lokal

Anda dapat meluncurkan dasbor dengan menjalankan:

Shell
Python
trackio show

Memuat Proyek Tertentu

Anda juga dapat menyediakan nama project opsional sebagai argumen untuk memuat proyek tertentu secara langsung:

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

Menggunakan Frontend Kustom

Anda dapat mengganti dashboard bawaan dengan direktori frontend statis Anda sendiri. Direktori tersebut hanya memerlukan file index.html; frontend Anda dapat memanggil API Trackio yang sudah ada di bawah /api/*.

Alur kerja yang dimaksud adalah:

  1. Jalankan trackio show --frontend ./my-trackio-frontend.
  2. Minta LLM Anda untuk mengedit file di direktori tersebut.
  3. Biarkan browser tetap terbuka saat Trackio memuat ulang frontend secara langsung saat file-file tersebut berubah.

Jika direktori yang diteruskan ke --frontend tidak ada, atau ada tetapi kosong, Trackio akan menyalin frontend starter secara otomatis, mencetak pesan bahwa hal tersebut telah dilakukan, dan kemudian menyajikan direktori tersebut. Starter ini adalah template HTML/CSS/JS polos yang lengkap: ia memanggil API Trackio, memuat proyek dan run, mengambil nilai metrik, dan menggambar grafik sederhana yang dapat Anda ganti dengan UI Anda sendiri.

Endpoint HTTP yang saat ini tersedia adalah:

  • 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 untuk unggah file multipart yang digunakan oleh alur media dan file

Untuk membaca file yang disimpan dan dikembalikan oleh API, Trackio juga menyajikan GET /file?path=....

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

Jika direktori frontend yang diberikan tidak kosong tetapi tidak valid, Trackio akan kembali ke template starter bawaan.

Mengatur Frontend Default yang Persisten

Jika Anda ingin frontend kustom yang sama digunakan secara default oleh trackio show, trackio sync, dan alur deployment, simpannya di konfigurasi persisten Trackio:

trackio config set frontend ./my-trackio-frontend

Reset dengan:

trackio config unset frontend

Menyesuaikan Warna Plot

Anda dapat menyesuaikan palet warna yang digunakan untuk garis plot dengan menyediakan argumen color_palette. Hal ini berguna jika Anda ingin mencocokkan dengan branding organisasi Anda atau memiliki preferensi warna tertentu.

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

Warna akan bergantian saat menampilkan beberapa run. Anda dapat memberikan sebanyak atau sesedikit warna yang Anda inginkan.

Mengaktifkan Akses Jarak Jauh

Secara default, dashboard mengikat ke 127.0.0.1 (localhost), yang berarti hanya dapat diakses dari mesin yang sama. Untuk memungkinkan akses jarak jauh dari mesin lain di jaringan, gunakan opsi --host:

Shell
Python
trackio show --host 0.0.0.0

Hal ini sangat berguna saat menjalankan Trackio pada server jarak jauh atau dalam lingkungan terkontainerisasi di mana Anda perlu mengakses dasbor dari mesin yang berbeda.

Meluncurkan Dashboard di Jupyter Notebooks

Anda juga dapat meluncurkan dashboard langsung di dalam Jupyter Notebook. Cukup gunakan perintah yang sama seperti di atas:

import trackio

trackio.show()

Periksa notebook demo.

Update on GitHub