Trackio documentation
Ortam Değişkenleri
Ortam Değişkenleri
Trackio, davranışının çeşitli yönlerini, özellikle Hugging Face Spaces'e dağıtım ve veri kalıcılığı için yapılandırmak amacıyla ortam değişkenlerini kullanır. Bu kılavuz, ana ortam değişkenlerini ve kullanım alanlarını kapsar.
Çekirdek Ortam Değişkenleri
TRACKIO_DIR
Trackio verilerini depolamak için özel bir dizin belirtir. Varsayılan olarak Trackio, verileri ~/.cache/huggingface/trackio/ dizininde saklar.
export TRACKIO_DIR="/path/to/trackio/data"Not: Bu ortam değişkeni, Trackio kalıcı depolama etkinleştirilmiş bir Space'te çalışmadığı sürece geçerlidir. Trackio, kalıcı depolama etkinleştirilmiş bir Space'te çalışıyorsa (bu durum PERSISTANT_STORAGE_ENABLED ortam değişkeni ile algılanır), Trackio verileri /data/trackio konumunda saklanır.
TRACKIO_SERVER_URL
Kendi barındırdığınız bir Trackio sunucusunun temel URL'si (http:// veya https://). Sorgu dizisine write_token ekleyebilirsiniz (trackio.show() içindeki full_url gibi) veya URL'yi boş bırakıp bunun yerine TRACKIO_WRITE_TOKEN değerini ayarlayabilirsiniz. Ayarlandığında trackio.init() metrikleri o sunucuya gönderir. trackio.init() fonksiyonuna server_url= parametresini geçirmekle eşdeğerdir.
Öncelik: TRACKIO_SPACE_ID de ayarlanmışsa (veya kodda space_id geçirildiyse), Hugging Face Space kullanılır ve TRACKIO_SERVER_URL yok sayılır. space_id ve server_url birlikte geçirildiğinde de aynı kural geçerlidir: space_id önceliklidir.
Sunucuyu Kendi Barındırın bölümüne bakın.
export TRACKIO_SERVER_URL="http://127.0.0.1:7860"
export TRACKIO_WRITE_TOKEN="YOUR_TOKEN"TRACKIO_WRITE_TOKEN
Kendi barındırılan bir Trackio sunucusu için yazma belirteci (yazma erişim URL'sindeki write_token sorgu parametresiyle aynı değer). Trackio sunucusunda ayarlandığında, bu değer, başlangıçta rastgele bir belirteç oluşturmak yerine sunucunun yazma belirteci olarak kullanılır. Trackio istemcisinde ayarlandığında, TRACKIO_SERVER_URL veya server_url sorgu parametreleri olmadan bir temel URL olduğunda bunu kullanın. İstemci, bu belirteci her istekte (örneğin X-Trackio-Write-Token başlığı olarak) gönderir, böylece Hugging Face Spaces üzerinde çalışılmadığında metrik alımı ve yüklemeler kimlik doğrulanmış olur.
TRACKIO_FRONTEND_DIR
Trackio için özel statik ön yüz dizinine yol. Dizin index.html dosyasını içermelidir.
Ayarlandığında, Trackio, açık bir frontend_dir / --frontend argümanı geçirilmediği sürece trackio.show() ve trackio.sync() ile trackio.freeze() gibi dağıtım akışları için bu ön yüzü kullanır.
export TRACKIO_FRONTEND_DIR="/path/to/my-trackio-frontend"Yapılandırılan dizin geçersizse Trackio bunu yok sayar ve yerleşik ön yüz seçim mantığına geri döner. Otomatik başlangıç şablonu kopyalama davranışı yalnızca açık bir frontend_dir / --frontend argümanı eksik veya boş bir dizini işaret ettiğinde uygulanır.
TRACKIO_LOGO_LIGHT_URL ve TRACKIO_LOGO_DARK_URL
Trackio panelinde açık ve koyu temalar için görüntülenen logoları özelleştirin. Özel logolar için URL'ler sağlayabilirsiniz. Her iki ortam değişkeninin de sağlanması gerektiğini unutmayın; aksi takdirde, sağlanmayan herhangi bir değişken için Trackio varsayılanı kullanılacaktır.
export TRACKIO_LOGO_LIGHT_URL="https://example.com/logo-light.png"
export TRACKIO_LOGO_DARK_URL="https://example.com/logo-dark.png"Not: Uzaktan Trackio Spaces için bu ortam değişkenleri, Space yalnızca
trackio.init(space_id=...)ile ilk kez oluşturulduğunda uygulanır. Mevcut bir Space'te logoları değiştirmek için Space değişkenlerini doğrudan Hugging Face Space ayarlarında güncelleyin.
TRACKIO_PLOT_ORDER
Trackio panelinde grafiklerin ve metrik gruplarının sıralamasını kontrol eder. Değer, istenen sıralamayı belirleyen virgülle ayrılmış bir metrik deseni listesi olmalıdır. Gruplar korunur - train/loss ilk olarak belirtilirse, diğer tüm train/* metrikleri train grubunda birlikte görünür ve train/loss bu grup içinde ilk sırada yer alır.
Bir desen hiçbir metrikle eşleşmiyorsa, hata oluşturmadan basitçe yok sayılır.
export TRACKIO_PLOT_ORDER="train/loss,val/loss"
**Pattern Matching:**
- **Exact matches**: `train/loss` matches exactly `train/loss`
- **Group wildcards**: `train/*` matches all metrics starting with `train/`
- **Partial wildcards**: `*gpu*` matches any metric containing "gpu"
**Behavior:**
- Metrics are grouped first (e.g., all `train/*` metrics stay together)
- Within each group, metrics are ordered according to the specified patterns
- Groups appear in the order of their first matching pattern
- Unspecified metrics appear in alphabetical order after specified ones
> **Note:** For remote Trackio Spaces, this environment variable is only applied when the Space is first created via `trackio.init(space_id=...)`. To change the plot order on an existing Space, update the `TRACKIO_PLOT_ORDER` Space variable directly in the Hugging Face Space settings.
### `TRACKIO_THEME`
Sets the theme for the Trackio dashboard. Can be a built-in Gradio theme name or a theme from the Hugging Face Hub.
```bash
# Built-in themes
export TRACKIO_THEME="soft"
export TRACKIO_THEME="citrus"
export TRACKIO_THEME="monochrome"
# Themes from the Hub
export TRACKIO_THEME="gstaff/xkcd"
export TRACKIO_THEME="ParityError/Anime"Not: Uzaktan Trackio Spaces için bu ortam değişkeni, Space yalnızca
trackio.init(space_id=...)ile ilk kez oluşturulduğunda uygulanır. Mevcut bir Space'in temasını değiştirmek içinTRACKIO_THEMESpace değişkenini doğrudan Hugging Face Space ayarlarında güncelleyin.
TRACKIO_COLOR_PALETTE
Trackio panelinde çizgi grafiklerde kullanılan renk paletini özelleştirir. Değer, virgülle ayrılmış bir hex renk kodu listesi olmalıdır. Birden fazla çalıştırma çizildiğinde bu renkler sırayla kullanılacaktır.
export TRACKIO_COLOR_PALETTE="#FF0000,#00FF00,#0000FF,#FFFF00,#FF00FF,#00FFFF"Varsayılan palet: #A8769B, #E89957, #3B82F6, #10B981, #EF4444, #8B5CF6, #14B8A6, #F59E0B, #EC4899, #06B6D4
TRACKIO_TABLE_TRUNCATE_LENGTH
Tablo hücrelerinde kesilmeden önce görüntülenen dizge değerlerinin maksimum uzunluğunu kontrol eder. Bir hücre değeri bu uzunluğu aştığında, tam metni görüntülemeye izin veren genişletilebilir bir öğeyle kesilir. Varsayılan olarak 250 karakterdir.
export TRACKIO_TABLE_TRUNCATE_LENGTH="500"TRACKIO_STORAGE_MODE
Trackio'nun verileri yerel olarak nasıl kalıcı hale getirdiğini kontrol eder. İzin verilen değerler: auto (varsayılan), sqlite, jsonl.
sqlite: eğitim süreçleri, doğrudan proje SQLite veritabanına yazar (geçmiş davranış).jsonl: eğitim süreçleri, her süreç için bir dosya olacak şekilde eklemeye özel JSONL parçacıklarınıTRACKIO_DIR/inbox/dizinine yazar; gösterge paneli sunucusu (trackio show) bunları SQLite içe aktarır. Bu, eşzamanlı SQLite yazarlarını tamamen ortadan kaldırır ve bu da Trackio’yu, SQLite kilitleme ve mmap semantiğinin güvenilir olmadığı ağ dosya sistemlerinde (NFS, Lustre, FSx, GPFS, WekaFS, CephFS, …) güvenli hale getirir.auto:TRACKIO_DIRbir ağ dosya sisteminde (yalnızca Linux) algılanırsajsonlseçilir, aksi haldesqlitekullanılır.
export TRACKIO_STORAGE_MODE="jsonl"TRACKIO_INBOX_POLL_INTERVAL
Dashboard sunucusunun ve Trackio Spaces'in, hem yerel gelen kutusu dizininden hem de Hugging Face Bucket gelen kutusundan içe aktarılacak yeni JSONL parçacıklarını ne sıklıkla (saniye cinsinden) kontrol ettiğini belirtir. Varsayılan değer 15'tir; 5'in altındaki değerler 5 olarak ayarlanır.
export TRACKIO_INBOX_POLL_INTERVAL="30"TRACKIO_SQLITE_* (ileri düzey)
Trackio'nun SQLite bağlantılarında ayarladığı PRAGMAları geçersiz kılın. Bunlar özellikle alışılmadık dosya sistemlerinde faydalıdır; geçersiz değerler yok sayılır.
TRACKIO_SQLITE_JOURNAL_MODE:wal,delete,truncate,persist,memory,offdeğerlerinden biri. Yerel ortamda varsayılan değeriwal, Spaces üzerinde isedelete'tir.TRACKIO_SQLITE_MMAP_SIZE: bayt cinsinden bellek eşlemeli I/O boyutu. Trackio’nun iş yükü için az fayda sağladığı ve ağ dosya sistemlerinde SIGBUS çöküşlerinin doğrudan tetikleyicisi olduğu için her yerde varsayılan olarak0(devre dışı) olarak ayarlanmıştır.TRACKIO_SQLITE_SYNCHRONOUS:off,normal,full,extradeğerlerinden biri. Varsayılan değerinormal'dir.TRACKIO_SQLITE_LOCKING_MODE:normalveyaexclusivedeğerlerinden biri. Spaces üzerinde varsayılan olarakexclusive, diğer ortamlardanormaldeğerini alır.TRACKIO_SQLITE_TEMP_STORE:default,file,memorydeğerlerinden biri. Varsayılan değerimemory'dir.
Önerilen küme kurulumu: Ev veya önbellek dizininiz paylaşımlı bir dosya sisteminde (/fsx, Lustre, NFS, GPFS, WekaFS, …) yer alıyorsa, TRACKIO_DIR değerini düğüm yerel diske (ör. /tmp veya $SLURM_TMPDIR) yönlendirin ya da ağ dosya sistemlerini algılayıp JSONL parça günlüğe geçiş yapan TRACKIO_STORAGE_MODE=auto değerine güvenin. Paylaşımlı bir dosya sisteminde doğrudan SQLite yazmanız gerekiyorsa, şunu ayarlayın:
export TRACKIO_SQLITE_JOURNAL_MODE="delete"
export TRACKIO_SQLITE_MMAP_SIZE="0"TRACKIO_WEBHOOK_URL
Uyarılar için küresel bir webhook URL'si ayarlar. Ayarlandığında, trackio.alert() çağrılarının her biri, uyarı yükünü bu URL'ye POST eder. Slack ve Discord webhook URL'lerini yerel olarak destekler (yükler otomatik biçimlendirilir). webhook_url parametresi üzerinden uyarı bazlı veya çalışma bazlı olarak geçersiz kılınabilir.
export TRACKIO_WEBHOOK_URL="https://hooks.slack.com/services/T.../B.../xxx"Daha fazla ayrıntı için Uyarılar kılavuzu'na bakın.
TRACKIO_WEBHOOK_MIN_LEVEL
Webhook'lara gönderilecek minimum uyarı seviyesini ayarlar. Bu seviyenin altındaki uyarılar yine de terminalde yazdırılır, veritabanında saklanır ve gösterge panelinde görüntülenir ancak webhook hedeflerine gönderilmez.
İzin verilen değerler: info, warn, error.
export TRACKIO_WEBHOOK_MIN_LEVEL="warn"warn ile yalnızca WARN ve ERROR uyarıları webhook URL'lerine gönderilir.
TRACKIO_CAPTURE_CONSOLE
1 veya true olarak ayarlandığında, Trackio bir çalıştırma sırasında stdout ve stderr'e yazılan her şeyi yakalar ve bunu dashboard'daki çalıştırma sayfasında gösterir. trackio.init() fonksiyonuna capture_console=True parametresinin geçirilmesine eşdeğerdir; açıkça belirtilen bir capture_console argümanı önceliklidir.
export TRACKIO_CAPTURE_CONSOLE=1Daha fazla ayrıntı için Konsol çıktısını ve başlatma komutunu yakalama bölümüne bakın.
TRACKIO_HANDLE_SIGTERM
1 veya true olarak ayarlandığında, trackio.init() bir SIGTERM işleyicisi kurar ve sinyali normal bir çıkışa dönüştürür; böylece süreç bir Slurm zaman sınırı, docker stop veya bir Kubernetes tahliyesi tarafından durdurulduğunda çalışma tamamlanır ve son metrikleri ile konsol çıktısı kaydedilir. Çıkış kodu 143 olarak kalır. İşleyici yalnızca ana iş parçacığından ve başka bir SIGTERM işleyicisi ayarlanmamışsa kurulur. Varsayılan olarak kapalıdır çünkü tüm sürecin SIGTERM sinyaline tepki verme şeklini değiştirir: örneğin, süreç çıkış yapmadan önce daemon olmayan iş parçacıklarını bekler ve mevcut işleyicileri zincirleyen çerçeveler (PyTorch Lightning’in Slurm otomatik yeniden kuyruklama özelliği gibi) sinyali yok saymak yerine çıkış yapar.
export TRACKIO_HANDLE_SIGTERM=1TRACKIO_BUCKET_ID
Hugging Face Space üzerinde çalışırken Trackio verilerini kalıcı hale getirmek için kullanılan Hugging Face Bucket kimliği (ör. username/bucketname). Bu değer, Space trackio.init(space_id=...) veya trackio.sync(...) ile oluşturulduğunda genellikle otomatik olarak ayarlanır; açık bir bucket_id sağlanmadıkça, bucket Space kimliğinden otomatik olarak oluşturulur.
export TRACKIO_BUCKET_ID="username/my-trackio-bucket"TRACKIO_DATASET_ID (kullanımdan kaldırıldı)
Kullanımdan kaldırıldı: Trackio verilerini bir Hugging Face Dataset'e (
dataset_id/TRACKIO_DATASET_ID) kalıcı olarak kaydetme özelliği kullanımdan kaldırılmış olup Trackio'nun gelecekteki bir sürümünde kaldırılacaktır. Bunun yerine bir Hugging Face Bucket kullanın (bucket_id/TRACKIO_BUCKET_ID).
Trackio Space'in arka plan commit zamanlayıcısı aracılığıyla verilerini senkronize ettiği Hugging Face Dataset'in kimliği (ör. username/datasetname). Bir Space üzerinde ayarlandığında, Trackio bir kullanım dışı bırakma uyarısı yayar ve şimdilik Dataset'e senkronize olmaya devam eder.
export TRACKIO_DATASET_ID="username/my-trackio-dataset"HF_TOKEN
Hugging Face kimlik doğrulama anahtarınız. Hugging Face üzerinde Spaces ve Buckets oluşturmak için gereklidir. Makinenizden Spaces’e dağıtım yaparken bunu yerel olarak ayarlayın. Trackio panelini dağıttığınız ad alanı için write izinlerine sahip olmalıdır.
export HF_TOKEN="hf_xxxxxxxxxxxxx"Gradio Ortam Değişkenleri
Trackio, Gradio üzerine inşa edildiğinden, Trackio'nun davranışını kontrol etmek için Gradio tarafından kullanılan ortam değişkenlerini kullanabilirsiniz. İşte birkaç örnek:
GRADIO_SERVER_PORT
Tradio panelinin başlatılacağı portu belirtir. Varsayılan değer 7860'dır
export GRADIO_SERVER_PORT=8000GRADIO_SERVER_NAME
Trackio panel sunucusu için ana bilgisayar adını tanımlar. Panelin herhangi bir IP adresinden erişilebilir olması için bunu "0.0.0.0" olarak ayarlayın
export GRADIO_SERVER_NAME="0.0.0.0"GRADIO_MCP_SERVER
Trackio'da MCP (Model Context Protocol) sunucu işlevselliğini etkinleştirir. Etkinleştirildiğinde, Trackio panosu bir MCP sunucusu olarak yapılandırılır ve belirli işlevler, LLM'ler tarafından (ör. kaydedilen metrikleri okumak için) kullanılabilen MCP araçları olarak dışa açılır.
export GRADIO_MCP_SERVER="True"Gradio tarafından kullanılan ortam değişkenlerinin bu daha kapsamlı listesine göz atın.
Update on GitHub