Trackio documentation

API Referansı

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

API Referansı

Çalıştır

sınıf trackio.Run

< >

( url: str | Noneproject: strclient: typing.Optional[typing.Any]name: str | None = Nonerun_id: str | None = Nonegroup: str | None = Noneconfig: dict | None = Nonespace_id: str | None = Nonebucket_id: str | None = Noneserver_base_url: str | None = Nonewrite_token: str | None = Noneexisting_runs: list[str] | None = Noneinitial_last_step: int | None = Noneauto_log_gpu: bool = Falsegpu_log_interval: float = 10.0auto_log_cpu: bool = Falsecpu_log_interval: float = 10.0webhook_url: str | None = Nonewebhook_min_level: trackio.alerts.AlertLevel | str | None = Nonecapture_console: bool = False )

link_artifact

< >

( artifact: Artifacttarget_path: straliases: list[str] | None = Nonebucket_id: str | None = None )

Parametreler

  • artifact (Artifact) — Bağlantı kurulacak artifact sürümü. Kaydedilmiş veya alınmış bir Artifact olmalıdır. Belirli bir mevcut sürüme bağlantı kurmak için, önce use_artifact("my-model:v3") ile alın ve sonucu bağlayın. Hiç kaydedilmemiş bir artifact, önce bu çalışmanın projesine kaydedilir.
  • target_path (str) — Bağlantı kurulacak koleksiyon, "registry-<registry>/<collection>" biçiminde, örn. "registry-models/my-model". Kayıt defteri (registry) zaten var olmalıdır (bkz. trackio.Api().create_registry). Koleksiyon ilk bağlantıda oluşturulur ve artefaktın türünü benimser; sonraki bağlantılar bu türle uyumlu olmalıdır.
  • aliases (list[str], isteğe bağlı) — Bağlı sürüme yerleştirilecek takma adlar, örn. ["staging"]. Bir takma ad, koleksiyon başına bir sürüme işaret eder; bu nedenle başka bir sürümde tutulan bir takma adı atamak, onu oradan taşır. latest otomatik olarak yönetilir ve her zaman en yeni bağlı sürümü takip eder; burada geçersizdir.
  • bucket_id (str, isteğe bağlı) — Kaydı (registry) barındıran Hugging Face bucket'ı, örn. "my-org/models-registry". Bir Space'e veya kendi barındırdığınız bir sunucuya kayıt yapan bir çalışmadan (run) bağlantı kurmak için gereklidir. Yerel bir kayıt için (registry) atlayın; TRACKIO_REGISTRY_BUCKET_ID ayarlıysa varsayılan olarak bu değer kullanılır.

Bir artefakt sürümünü bir kayıt defteri koleksiyonuna bağlayın.

Bağlantı, kaynak sürümüne işaret eden bir imleçtir: dosyalar kopyalanmaz. Bağlantı, koleksiyondaki bir sonraki sürüm numarasını alır (v0, v1, …), kaynak artefaktın kendi sürüm numaralarından bağımsız olarak. Koleksiyonda zaten bulunan bir sürüm bağlantı kurulduğunda yeni bir sürüm oluşturulmaz: mevcut sürüm geri döner ve geçirdiğiniz aliases yine de taşınır.

Yerel kayıt defteri, bağlantıyı çalıştırmanın verileriyle birlikte kaydeder; bu nedenle bağlantı yalnızca bu makinedeki çalıştırmalar için kullanılabilir. Bunun yerine, bir varlık kovası destekli kayıt defterine yayınlamak için bucket_id parametresini iletin — bir Space'e veya kendi barındırdığınız bir sunucuya kayıt yapan bir çalıştırmanın da yayınlama yöntemi budur, çünkü varlık kovası her iki taraftan da erişilebilir durumdadır.

use_artifact

< >

( artifact_or_name: trackio.artifact.Artifact | strtype: str | None = None )

Bir artefaktı çözümlen ve bu çalışmayı onun bir tüketici olarak kaydet.

Spec, bir proje artefaktıdır ("name", "name:vN", "name:alias") veya bir kayıt defteri konumudur ("registry-<registry>/<collection>[:vN|:alias]"); bu konum, koleksiyonun bağlantıları aracılığıyla işaret ettiği kaynak sürüme çözümlenir.

init

trackio.init

< >

( project: strname: str | None = Nonegroup: str | None = Nonespace_id: str | None = Noneserver_url: str | None = Nonedataset_id: str | None = Nonebucket_id: str | None = Noneconfig: dict | None = Noneresume: str = 'never'settings: typing.Any = Noneprivate: bool | None = Noneembed: bool = Trueauto_log_gpu: bool | None = Nonegpu_log_interval: float = 10.0auto_log_cpu: bool | None = Nonecpu_log_interval: float = 10.0webhook_url: str | None = Nonewebhook_min_level: trackio.alerts.AlertLevel | str | None = Nonecapture_console: bool | None = None ) → Run

Parametreler

  • project (str) — Projenin adı (izlemeye devam etmek için mevcut bir proje veya sıfırdan izlemeye başlamak için yeni bir proje).
  • name (str, isteğe bağlı) — Çalışmanın adı (verilmezse, varsayılan bir ad oluşturulur).
  • group (str, opsiyonel) — Bu çalışmanın ait olduğu grubun adı; ilgili çalışmaları birlikte organize etmeye yardımcı olur. Panoda grubun tümünü görünürlüğünü aç veya kapatabilirsiniz.
  • space_id (str, isteğe bağlı) — Belirtilirse, proje yerel bir dizin yerine bir Hugging Face Space'e kaydedilir. “username/reponame” veya “orgname/reponame” gibi tam bir Space adı olmalıdır, veya yalnızca “reponame” olabilir; bu durumda Space, giriş yapılmış Hugging Face kullanıcısının ad alanına oluşturulur. Space mevcut değilse oluşturulur. Space zaten mevcut ise, proje ona kaydedilir. Ayrıca TRACKIO_SPACE_ID ortam değişkeni üzerinden de ayarlanabilir. dondurulmuş (statik SDK'ya dönüştürülmüş) bir Space'e kayıt yapılamaz; trackio.sync(..., sdk="static") komutunu yalnızca kayıt işlemleri tamamlandıktan sonra kullanın. Birden fazla değer ayarlandığında server_url ve TRACKIO_SERVER_URL değerlerine öncelik verir.
  • server_url (str, isteğe bağlı) — Kendi barındırılan bir Trackio sunucusunun temel URL'si (http:// veya https://), ya da trackio.show() tarafından sağlanan ve write_token sorgu parametresi içerebilen yazma erişim URL'si. İstemci, bu belirteci her istekte gönderir (X-Trackio-Write-Token); belirteci URL'ye gömlemek yerine TRACKIO_WRITE_TOKEN değerini de ayarlayabilirsiniz. Ayarlandığında, metrikler bir Hugging Face Space oluşturmak veya senkronize etmek yerine HTTP üzerinden o sunucuya gönderilir. TRACKIO_SERVER_URL ortam değişkeni üzerinden de ayarlanabilir. space_id veya TRACKIO_SPACE_ID ayarlandığında yok sayılır.
  • dataset_id (str, isteğe bağlı) — Kullanımdan kaldırıldı: trackio verilerini bir Hugging Face Dataset'ine kalıcı olarak kaydetme özelliği, trackio'nun gelecekteki bir sürümünde kaldırılacak. Bunun yerine bucket_id (bir Hugging Face Bucket) kullanın.
  • bucket_id (str, opsiyonel) — Metrik kalıcılığı için kullanılacak Hugging Face Bucket kimliği. Varsayılan olarak, space_id sağlandığında ve bucket_id açıkça ayarlanmadığında, bir bucket, space_id'den otomatik olarak oluşturulur. Buckets, git yükü olmadan S3 benzeri depolama sağlar - SQLite veritabanı, Space içinde doğrudan hf-mount aracılığıyla saklanır. “username/bucketname” gibi bir adla veya sadece “bucketname” ile bir Bucket belirtin.
  • config (dict, isteğe bağlı) — Yapılandırma seçeneklerinin sözlüğü. wandb.init() ile uyumluluk için sağlanır.
  • resume (str, isteğe bağlı, varsayılanı “never) — Bir çalıştırmanın devam ettirilmesinin nasıl ele alınacağını kontrol eder. Aşağıdakilerden biri olabilir:
    • “must”: Verilen adla çalışmayı yeniden başlatmak zorundadır; çalışma yoksa hata fırlatılır
    • “allow”: Çalışma zaten varsa kaldığı yerden devam et, yoksa yeni bir çalışma oluştur
    • “never”: Çalışmayı asla devam ettirme, her zaman yenisini oluştur
  • private (bool, opsiyonel) — Space'in özel (private) yapılıp yapılmayacağını belirtir. None (varsayılan) ise, organizasyonun varsayılanı özel değilse depo herkese açık (public) olur. Depo zaten mevcutsa bu değer yok sayılır.
  • settings (Any, isteğe bağlı) — Kullanılmıyor. wandb.init() ile uyumluluk için sağlanmıştır.
  • embed (bool, isteğe bağlı, varsayılan True) — Jupyter/Colab defterinde çalışıyorsa, trackio.init() çağrıldığında panonun hücreye otomatik olarak gömülüp gömülmemesini belirler. Yerel çalıştırmalarda, yerel bir Trackio panosu başlatılır ve gömülür. Space çalıştırmalarında, Space URL'si gömülür. Colab'da, share=True olduğunda yerel panoya herkese açık bir paylaşım URL'si üzerinden erişilebilir.
  • auto_log_gpu (bool veya None, isteğe bağlı, varsayılan None) — Otomatik GPU metrik günlükleme işlevini kontrol eder. None (varsayılan) ise, nvidia-ml-py yüklüyse ve bir NVIDIA GPU veya Apple M serisi algılanırsa GPU günlükleme otomatik olarak etkinleştirilir. Zorla etkinleştirmek için True veya devre dışı bırakmak için False olarak ayarlayın.
  • gpu_log_interval (float, opsiyonel, varsayılan 10.0) — Otomatik GPU metrik günlükleri arasındaki saniye cinsinden aralık. Yalnızca auto_log_gpu=True olduğunda kullanılır.
  • auto_log_cpu (bool veya None, isteğe bağlı, varsayılan None) — Otomatik CPU ve RAM metrikleri günlükleme işlevini (kullanım oranı, bellek, disk G/Ç, ağ G/Ç ve sensörler) kontrol eder. None (varsayılan) ise, psutil yüklüyse CPU günlükleme otomatik olarak etkinleştirilir. Zorla etkinleştirmek için True veya devre dışı bırakmak için False olarak ayarlayın.
  • cpu_log_interval (float, opsiyonel, varsayılan 10.0) — Otomatik CPU metrik günlükleri arasındaki saniye cinsinden aralık. Yalnızca CPU otomatik günlükleme etkinleştirildiğinde kullanılır.
  • webhook_url (str, isteğe bağlı) — trackio.alert() çağrıldığında uyarı yüklemelerinin POST edileceği bir webhook URL'si. Slack ve Discord webhook URL'lerini yerel olarak destekler (yüklemeler otomatik biçimlendirilir). Ayrıca TRACKIO_WEBHOOK_URL ortam değişkeni üzerinden de ayarlanabilir. Bireysel uyarılar, trackio.alert() fonksiyonuna webhook_url parametresini geçirerek bu URL'yi geçersiz kılabilir.
  • webhook_min_level (AlertLevel veya str, isteğe bağlı) — Webhook iletimini tetiklemesi gereken minimum uyarı düzeyi. Örneğin, AlertLevel.WARN yalnızca WARN ve ERROR uyarılarını webhook hedefine gönderir. Ayrıca TRACKIO_WEBHOOK_MIN_LEVEL üzerinden de ayarlanabilir.
  • capture_console (bool veya None, isteğe bağlı, varsayılan None) — Betik tarafından stdout ve stderr'e yazılan her şeyin (dahil print() ve logging çıktıları) yakalanıp çalıştırma ile birlikte saklanıp saklanmayacağı. Çıktı, indirilebildiği dashboard'daki çalıştırma sayfasında görüntülenir. None ise (varsayılan), konsol yakalama yalnızca TRACKIO_CAPTURE_CONSOLE ortam değişkeni 1 veya true olarak ayarlandığında etkinleştirilir.

Dönüş değeri

Çalıştır

Metrikleri kaydetmek ve çalışmayı sonlandırmak için kullanılabilen bir [Run] nesnesi.

Yeni bir Trackio projesi oluşturur ve bir [Run] nesnesi döndürür.

log

trackio.log

< >

( metrics: dictstep: int | None = None )

Parametreler

  • metrics (dict) — Kaydedilecek metriklerin sözlüğü.
  • step (int, isteğe bağlı) — Adım numarası. Verilmezse, adım otomatik olarak artırılır.

Metrikleri mevcut çalıştırmaya kaydeder.

log_gpu

trackio.log_gpu

< >

( run: trackio.run.Run | None = Nonedevice: int | None = None ) → dict

Parametreler

  • run — İsteğe bağlı Run örneği. None ise, bağlamdaki mevcut çalışmayı kullanır.
  • device — Metriklerin toplanacağı CUDA cihazı indeksi (yalnızca NVIDIA GPU'lar). None ise, bu sürecin görebildiği tüm GPU'lardan toplanır. Bu parametre Apple GPU'lar için yok sayılır.

Dönüş değeri

dict

Kaydedilen GPU metrikleri.

GPU metriklerini sistem metrikleri olarak mevcut veya belirtilen çalışmaya kaydedin. NVIDIA veya Apple GPU'nun mevcut olup olmadığını otomatik olarak algılar ve uygun kayıt yöntemini çağırır.

Örnek:

import trackio

run = trackio.init(project="my-project")
trackio.log({"loss": 0.5})
trackio.log_gpu()
trackio.log_gpu(device=0)

log_system

trackio.log_system

< >

( metrics: dict )

Parametreler

  • metrics (dict) — Kaydedilecek sistem metriklerinin sözlüğü.

Zaman damgalarını adımlar yerine kullanarak sistem metriklerini (GPU vb.) mevcut çalıştırmaya kaydeder.

log_artifact

trackio.log_artifact

< >

( artifact_or_path: trackio.artifact.Artifact | str | pathlib.Pathname: str | None = Nonetype: str | None = Nonealiases: list[str] | None = Noneoverwrite: bool = False )

Parametreler

  • artifact_or_path (Artifact, str veya Path) — Kaydedilecek artifact (add_file veya add_dir ile en az bir dosya eklenmiş olmalı) veya yeni bir artifact olarak kaydedilecek bir dosya veya dizin yolu.
  • name (str, isteğe bağlı) — Bir yol kaydederken artefakt adı. Varsayılan olarak run-<run_id>-<basename> değerini alır. Bir Artifact ile birlikte geçirilemez.
  • type (str, isteğe bağlı) — Bir yol kaydederken artefakt türü (ör. "model", "dataset"). Varsayılan değeri "unspecified"'dir. Bir Artifact ile birlikte geçirilmemelidir.
  • aliases (list[str], isteğe bağlı) — Sonuç sürümüne, latest ile birlikte (yeni bir sürüm oluşturulduğunda otomatik olarak atanır) döndürülecek takma adlar. İçerik aynı olsa bile, takma adlarınız sürüme döndürülür.
  • overwrite (bool, isteğe bağlı) — True ise, yeni içerik kaydedildikten sonra bu artefaktın diğer tüm sürümleri kaldırılır. Diğer artefaktlar tarafından hâlâ kullanılan bloblar korunur ve sürüm numaraları artmaya devam eder. Varsayılan değer False'tur.

Mevcut çalıştırmanın bir çıktısı olarak bir artefakt kaydeder.

use_artifact

trackio.use_artifact

< >

( artifact_or_name: trackio.artifact.Artifact | strtype: str | None = None )

Parametreler

  • artifact_or_name (Artifact veya str) — Zaten kaydedilmiş bir Artifact veya bir artifact adı. Sadece bir ad ("my-model") :latest olarak çözümlenir; bir sürümü de sabitleyebilirsiniz ("my-model:v3") veya bir takma adı çözebilirsiniz ("my-model:prod").
  • type (str, isteğe bağlı) — Verilirse, depolanan artefakt türüyle karşılaştırılır ve eşleşmezse bir hata fırlatılır.

Bir artefaktı alır ve mevcut çalıştırmanın girdisi olarak kaydeder.

bitir

trackio.finish

< >

( )

Mevcut çalışmayı sonlandırır.

göster

trackio.show

< >

( project: str | None = Nonedashboard: str | None = Nonetheme: typing.Any = Nonemcp_server: bool | None = Nonefooter: bool = Truecolor_palette: list[str] | None = Noneopen_browser: bool = Trueblock_thread: bool | None = Nonehost: str | None = Noneshare: bool | None = Noneserver_port: int | None = Nonefrontend_dir: str | pathlib.Path | None = None ) → app

Parametreler

  • project (str, isteğe bağlı) — Gösterilecek çalışmalara sahip projenin adı. Verilmezse tüm projeler gösterilir ve kullanıcı bunlardan birini seçebilir.
  • dashboard (str, isteğe bağlı) — Bağımsız kayıt defteri panelini göstermek için "registry" olarak ayarlayın. Varsayılan, proje panelidir.
  • theme (Any, isteğe bağlı) — Yoksayılır. Geriye dönük uyumluluk için korunur; Trackio artık Gradio temalarını kullanmaz.
  • mcp_server (bool, isteğe bağlı) — True ise, isteğe bağlı trackio[mcp] bağımlılığı yüklüyse, gösterge paneli bir MCP sunucusunu /mcp adresinde dışa açar. None (varsayılan) ise, GRADIO_MCP_SERVER ortam değişkeni kullanılır (ör. Spaces'te).
  • footer (bool, isteğe bağlı, varsayılan True) — False olduğunda, yazma belirteç URL'sine footer=false dahil edilecek mi. Bu, URL'deki footer sorgu parametresi üzerinden de kontrol edilebilir.
  • color_palette (list[str], isteğe bağlı) — Grafik çizgileri için kullanılacak onaltılık renk kodlarının listesi. Sağlanmazsa, TRACKIO_COLOR_PALETTE ortam değişkeni kullanılır (virgülle ayrılmış onaltılık kodlar) veya bu değişken ayarlanmamışsa varsayılan renk paleti kullanılır. Örnek: ['#FF0000', '#00FF00', '#0000FF']
  • open_browser (bool, isteğe bağlı, varsayılan True) — True ise ve bir defterde değilse, gösterge paneli yeni bir tarayıcı sekmesinde açılır. False ise tarayıcı açılmaz.
  • block_thread (bool, isteğe bağlı) — True ise, ana iş parçacığı (thread) panoyu (dashboard) kapatılana kadar engellenir. None ise (varsayılan davranış), pano bir defterde (notebook) başlatılırsa ana iş parçacığı engellenmez, aksi halde ana iş parçacığı engellenir.
  • host (str, isteğe bağlı) — Sunucunun bağlanacağı ana bilgisayar. Belirtilmezse, varsayılan olarak '127.0.0.1' (yalnızca yerel ana bilgisayar) kullanılır. Uzak erişime izin vermek için '0.0.0.0' olarak ayarlayın.
  • share (bool, isteğe bağlı) — True ise, geçici bir herkese açık URL oluşturur (Gradio ile uyumlu tünel). Colab veya barındırılan defterlerde, aksi belirtilmedikçe varsayılan olarak True değerine ayarlanır.
  • server_port (int, isteğe bağlı) — Bağlanacak port. Ayarlanmazsa GRADIO_SERVER_PORT (varsayılan 7860) üzerinden tarama yapılır.
  • frontend_dir (str | Path, isteğe bağlı) — Özel statik bir ön yüz içeren dizin. index.html dosyasını içermelidir. Belirtilmezse Trackio, TRACKIO_FRONTEND_DIR değişkenini, ardından kalıcı Trackio yapılandırmasını, en son olarak da paketlenmiş ön yüzü kontrol eder. Açıkça belirtilen bir frontend_dir değerinin eksik veya boş bir dizini işaret etmesi durumunda Trackio, başlangıç şablonunu kopyalar ve bu dizini sunar.

Dönüş değeri

app

Panel işleyicisi (.close() sunucuyu durdurur). url: Panelin yerel URL'si. share_url: Varsa, herkese açık paylaşım URL'si. full_url: Yazma belirteci dahil tam URL (paylaşım sırasında paylaşım URL'si, aksi halde yerel).

Trackio panelini başlatır.

sync

trackio.sync

< >

( project: strspace_id: str | None = Noneprivate: bool | None = Noneforce: bool = Falserun_in_background: bool = Falsesdk: str = 'gradio'dataset_id: str | None = Nonebucket_id: str | None = Nonefrontend_dir: str | pathlib.Path | None = None ) → str

Parametreler

  • project (str) — Yüklemek istediğiniz projenin adı.
  • space_id (str, isteğe bağlı) — Yüklemesinin yapılacağı Space'in kimliği (ör. “username/space_id”). Belirtilmezse, önce proje meta verileri kontrol edilir, ardından rastgele bir space_id üretilir.
  • private (bool, opsiyonel) — Space'in özel (private) yapılıp yapılmayacağını belirtir. None (varsayılan) ise, organizasyonun varsayılanı özel değilse depo herkese açık (public) olur. Depo zaten mevcutsa bu değer yok sayılır. Statik Trackio panoları anlık görüntü verilerini doğrudan tarayıcıdan okuduğu için sdk="static" ile desteklenmez.
  • force (bool, isteğe bağlı, varsayılan False) — True ise, onay sormadan mevcut veritabanını üzerine yazar. False ise, mevcut bir veritabanını üzerine yazmadan önce kullanıcıya soru sorar.
  • run_in_background (bool, isteğe bağlı, varsayılan False) — True ise, Space oluşturma ve veritabanı yükleme işlemleri arka plan iş parçacığında (background thread) çalıştırılır. False ise, tüm adımlar senkron olarak çalıştırılır.
  • sdk (str, opsiyonel, varsayılan “gradio”) — Dağıtılacak Space türü. “gradio”, canlı bir sunucuyla bir Gradio Space dağıtır. “static”, Space'i dondurur: bir HF Bucket'tan okuyan statik bir Space dağıtır (sunucu gerekmez).
  • dataset_id (str, isteğe bağlı) — Kullanımdan kaldırıldı: trackio verilerini bir Hugging Face Dataset'ine kalıcı olarak kaydetme özelliği, trackio'nun gelecekteki bir sürümünde kaldırılacak. Bunun yerine bucket_id (bir Hugging Face Bucket) kullanın.
  • bucket_id (str, optional) — The ID of the HF Bucket to sync to. By default, a bucket is auto-generated from the space_id.

Dönüş değeri

str

Eşitlenmiş projenin Space kimliği.

Yerel bir Trackio projesinin veritabanını bir Hugging Face Space'ine senkronize eder. Space mevcut değilse oluşturulur. Yerel veriler asla silinmez.

Dondurma: sdk="static" parametresini geçmek, bir HF Bucket tarafından desteklenen statik bir Space dağıtır (salt okunur panel, Gradio sunucusu yok). Daha sonra aynı projeyi tekrar senkronize ederek bu statik Space'i yenileyebilirsiniz. Mevcut bir Gradio Space'inin tek seferlik bir anlık görüntüsünü almak istiyorsanız, bunun yerine freeze() kullanın.

freeze

trackio.freeze

< >

( space_id: strproject: strnew_space_id: str | None = Noneprivate: bool | None = Nonebucket_id: str | None = Nonefrontend_dir: str | pathlib.Path | None = None ) → str

Parametreler

  • space_id (str) — Kaynak Gradio Space'in kimliği (ör. "username/my-space" veya oturum açılmış ad alanından çıkarılan kısa bir depo adı, örn. init()). /data konumunda bir bucket'a sahip bir Gradio Space olmalıdır.
  • project (str) — Donusu dondurulmus Space'e dahil edilecek verilerin ait oldugu projenin adi.
  • new_space_id (str, isteğe bağlı) — Yeni statik Space için kimlik. Belirtilmezse, varsayılan olarak "{space_id}_static" kullanılır.
  • private (bool, isteğe bağlı) — Desteklenmiyor. Donmuş statik panolar, görüntü verilerini doğrudan tarayıcıdan okuduğu için hedef görüntü herkese açık olmalıdır.
  • bucket_id (str, isteğe bağlı) — Yeni statik Space'in veri depolaması için HF Bucket kimliği. Belirtilmezse, yeni Space kimliğinden otomatik olarak oluşturulur.

Dönüş değeri

str

Yeni oluşturulan statik Space'in Space kimliği.

Belirtilen proje için kaynak Gradio Space'teki verilerin salt okunur bir anlık görüntüsünü içeren yeni bir statik Hugging Face Space oluşturur. Veriler, dondurma (freeze) sırasında kaynak Space'e bağlı olan kovadan (bucket) okunur. Orijinal Space değiştirilmez ve dondurma işlemi tamamlandıktan sonra orijinal Gradio Space'e yüklenen metrikler, yeni statik Space'te otomatik olarak yansıtılmaz.

delete_project

trackio.delete_project

< >

( project: strforce: bool = False ) → bool

Parametreler

  • project (str) — Silinecek projenin adı.
  • force (bool, isteğe bağlı, varsayılan False) — True ise, onay sormadan projeyi siler. False ise, silmeden önce kullanıcıdan onay ister.

Dönüş değeri

bool

Proje silindiyse True, aksi halde False.

Yerel SQLite veritabanını kaldırarak bir projeyi siler.

import_csv

trackio.import_csv

< >

( csv_path: str | pathlib.Pathproject: strname: str | None = Nonespace_id: str | None = Nonedataset_id: str | None = Noneprivate: bool | None = Noneforce: bool = False )

Parametreler

  • csv_path (str veya Path) — İçe aktarılacak CSV dosyasının str veya Path değeri.
  • project (str) — CSV dosyasının içe aktarılacağı projenin adı. Mevcut bir proje olmamalıdır.
  • name (str, isteğe bağlı) — CSV dosyasının içe aktarılacağı Run'un adı. Verilmezse, varsayılan bir ad oluşturulur.
  • name (str, isteğe bağlı) — Çalışmanın adı (verilmezse, varsayılan bir ad oluşturulur).
  • space_id (str, isteğe bağlı) — Verilirse, proje yerel bir dizin yerine bir Hugging Face Space'e kaydedilir. "username/reponame" veya "orgname/reponame" gibi tam bir Space adı olmalıdır veya yalnızca "reponame" olabilir; bu durumda Space, oturum açılmış Hugging Face kullanıcısının ad alanına oluşturulur. Space mevcut değilse oluşturulur. Space zaten mevcut ise, proje ona kaydedilir.
  • dataset_id (str, isteğe bağlı) — Kullanımdan kaldırıldı: trackio verilerinin bir Hugging Face Dataset'ine kalıcı olarak kaydedilmesi, trackio'nun gelecekteki bir sürümünde kaldırılacak. Bunun yerine bucket_id (bir Hugging Face Bucket) kullanın.
  • private (bool, isteğe bağlı) — Space'in özel yapılıp yapılmayacağını belirtir. None (varsayılan) ise, organizasyonun varsayılanı özel değilse depo herkese açık olur. Depo zaten mevcutsa bu değer yok sayılır.

Bir CSV dosyasını bir Trackio projesine içe aktarır. CSV dosyası bir "step" sütunu içermelidir, isteğe bağlı olarak bir "timestamp" sütunu içerebilir ve diğer tüm sütunlar metrik olarak ele alınır. Ayrıca sütun adlarını içeren bir başlık satırı da bulunmalıdır.

TODO: init() çağrılmalı ve kullanıcının metrikleri kaydetmeye devam edebilmesi için bir Run nesnesi döndürülmelidir.

import_tf_events

trackio.import_tf_events

< >

( log_dir: str | pathlib.Pathproject: strname: str | None = Nonespace_id: str | None = Nonedataset_id: str | None = Noneprivate: bool | None = Noneforce: bool = False )

Parametreler

  • log_dir (str veya Path) — TensorFlow Events dosyalarını içeren dizine giden str veya Path.
  • project (str) — TensorFlow Events dosyalarının içe aktarılacağı projenin adı. Mevcut bir proje olmamalıdır.
  • name (str, isteğe bağlı) — Çalışmalar için ad öneki (verilmezse, dizin adları kullanılır). Her alt dizin ayrı bir çalışma oluşturur.
  • space_id (str, isteğe bağlı) — Verilirse, proje yerel bir dizin yerine bir Hugging Face Space'e kaydedilir. "username/reponame" veya "orgname/reponame" gibi tam bir Space adı olmalıdır veya yalnızca "reponame" olabilir; bu durumda Space, oturum açılmış Hugging Face kullanıcısının ad alanına oluşturulur. Space mevcut değilse oluşturulur. Space zaten mevcut ise, proje ona kaydedilir.
  • dataset_id (str, isteğe bağlı) — Kullanımdan kaldırıldı: trackio verilerinin bir Hugging Face Dataset'ine kalıcı olarak kaydedilmesi, trackio'nun gelecekteki bir sürümünde kaldırılacak. Bunun yerine bucket_id (bir Hugging Face Bucket) kullanın.
  • private (bool, isteğe bağlı) — Space'in özel yapılıp yapılmayacağını belirtir. None (varsayılan) ise, organizasyonun varsayılanı özel değilse depo herkese açık olur. Depo zaten mevcutsa bu değer yok sayılır.

TensorFlow Events dosyalarını bir dizinden bir Trackio projesine içe aktarır. Kayıt dizinindeki her alt dizin ayrı bir çalıştırma olarak içe aktarılır.

kaydet

trackio.save

< >

( glob_str: str | pathlib.Pathproject: str | None = None ) → str

Parametreler

  • glob_str (str veya Path) — Kaydedilecek dosya yolu veya glob deseni. Tek bir dosya veya birden fazla dosyayla eşleşen bir desen olabilir (ör. "*.py", "models/**/*.pth").
  • project (str, isteğe bağlı) — Dosyaların kaydedileceği projenin adı. Verilmezse, trackio.init() içindeki mevcut proje kullanılır. Hiçbir proje başlatılmamışsa bir hata oluşturur.

Dönüş değeri

str

Dosyaların kaydedildiği yol (projenin dosya dizini).

Dosyaları bir projeye kaydeder (belirli bir çalıştırmayla ilişkilendirilmez). Trackio yerel olarak çalışıyorsa, dosya(lar) projenin dosya dizinine kopyalanır. Trackio bir Space'te çalışıyorsa, dosya(lar) Space'in dosya dizinine yüklenir.

Örnek:

import trackio

trackio.init(project="my-project")
trackio.save("config.yaml")
trackio.save("models/*.pth")

Artefakt

sınıf trackio.Artifact

< >

( name: strtype: strdescription: str | None = Nonemetadata: dict | None = None )

Parametreler

  • name (str) — Proje içinde benzersiz olan artefakt adı. ^[A-Za-z0-9._-]+$ (harfler, rakamlar, nokta, alt çizgi, tire) ile eşleşmelidir.
  • type (str) — Sanatları gruplamak için kullanılan "model" veya "dataset" gibi serbest biçimli bir kategori.
  • description (str, isteğe bağlı) — Artefaktın insan tarafından okunabilir açıklaması.
  • metadata (dict, isteğe bağlı) — Sürümle birlikte saklanan, keyfi JSON-serializable (JSON'a dönüştürülebilir) meta veriler.

Bir projeye bağlı, sürüm numaralı ve adlandırılmış dosya ve referans demeti.

Bir Artifact oluşturun, add_file / add_dir (baytlar içerik adresli depolamaya aktarılır) veya add_reference (hiçbir bayt kopyalanmadan harici bir URI kaydedilir) ile dosyalarını ekleyin, ardından trackio.log_artifact ile kalıcı hale getirin. Kayıt işlemi artefaktı dondurur ve salt okunur version, aliases, size ve manifest alanlarını doldurur.

add_dir

< >

( local_dir: str | pathlib.Pathname: str | None = None )

Parametreler

  • local_dir (str veya Path) — Dosyalarının ekleneceği mevcut bir dizinin yolu.
  • name (str, isteğe bağlı) — Eklenen dosyalar için mantıksal yol öneki. Varsayılan olarak önek yoktur, böylece dosyalar local_dir göreli yollarını korur.

Bir dizin altındaki tüm normal dosyaları, özyinelemeli olarak aşamaya alın.

Simge bağlantılar atlanır.

add_file

< >

( local_path: str | pathlib.Pathname: str | None = None )

Parametreler

  • local_path (str veya Path) — Eklenecek mevcut normal dosyanın yolu.
  • name (str, isteğe bağlı) — Dosyanın artefakt içinde saklandığı mantıksal yol. Varsayılan olarak dosyanın taban adı kullanılır.

Sanığın bir parçası olarak dahil edilmek üzere tek bir dosyayı aşamalaştırın.

add_reference

< >

( uri: strname: str | None = Nonechecksum: bool = Truemax_objects: int | None = None )

Parametreler

  • uri (str) — Referans verilen verinin konumu, yüzde kodlamalı (yerel URI'leri pathlib.Path.as_uri() ile oluşturun). file://, http(s):// ve hf:// yerel olarak çözümlenir ve alınır; diğer tüm şemalar (s3://, gs://, Azure blob URL'leri, …) için trackio.register_reference_handler üzerinden kaydedilmiş özel bir ReferenceHandler gerekir — tam örnekler için artefakt belgelerini inceleyin — aksi takdirde hata fırlatılır.
  • name (str, isteğe bağlı) — Referansın saklandığı mantıksal yol. Varsayılan olarak uri'nin son bölümüdür; genişletilmiş bir önek ( / ile biten) için, her nesnenin göreli yolunun içine yerleştirildiği önektir.
  • checksum (bool, isteğe bağlı, varsayılan True) — True olduğunda, kaynak boyutunu ve bir kontrol toplamını (ve bir dizin/önekini genişletmek için) türetmek üzere kaynağa sorgu gönderir: file:// akış olarak sha256 ile özetlenir, hf:// LFS sha256'sını veya git blob kimliğini kullanır ve http(s):// sunucu ETag'ini kullanır. Bu işlem dosya sistemini okuyabilir veya ağ istekleri yapabilir. uzak bir kaynak için kontrol toplamı alınamazsa (ör. ETag yoksa), URI'nin kendisi digest olarak kullanılır ve bir uyarı yayımlanır. Var olmayan yerel bir file:// yolu ise hata fırlatır. Uzak sorgulamayı tamamen atlamak için checksum=False geçin.
  • max_objects (int, isteğe bağlı) — Bir dizinin/ön ekinin genişlediği nesne sayısının üst sınırı (varsayılan 10.000); bu sınırı aşmak hata verir.

Dış veriye bir referans yerleştirin, hiçbir bayt kopyalamayın.

add_file/add_dir'den farklı olarak, bir referans, verinin URI'sini (ve mevcut olduğunda boyutunu ve checksum'ını) baytları içerik-adresli depoya aktarmadan kaydeder. Bu, kopyalanmaması gereken büyük veya zaten kalıcı olarak depolanmış veri kümeleri üzerinde sürümleme ve soy kütüğü takibi yapmanın yoludur.

Bir dizini gösteren URI (file://, hf:// veya özel bir işleyici tarafından genişletilen bir önek), max_objects sınırıyla her nesne için bir giriş olarak genişletilir. Referans baytları asla bir Space veya kovaya yüklenmez.

URI, artefakt manifestine olduğu gibi kaydedilir ve manifestler paylaşılan bir Hugging Face Dataset ile senkronize edilebilir — bu nedenle güvenlik nedenleriyle imzalı bir URI uyarı tetikler; lütfen nesnenin kanonik imzasız URI'sini (ör. s3://bucket/key) tercih edin.

indir

< >

( root: str | pathlib.Path | None = None )

Parametreler

  • root (str veya Path, isteğe bağlı) — Dosyaların yazılacağı dizin. Varsayılan olarak ./.trackio/artifact-downloads/<project>/<name>_v<version>/ değeri kullanılır; bu değer, farklı projelerden gelen aynı adlı artefaktların asla çakışmaması için proje bazında ve bir önceki sürümden eski dosyaların geride kalmaması için çözümlenen sürüm bazında belirlenir (örneğin latest gibi hareketli bir takma ad durumunda).

Sanığın dosyalarını yerel bir dizine somutlaştırın.

Dosyalar, Trackio’nun içerik adresli önbelleğinden kopyalanır (yerel olarak bulunmuyorsa uzaktan alınır), bu nedenle tekrarlanan çağrılar ucuzdur ve idempotenttir.

add_reference ile eklenen referans girdileri de burada getirilir: her referans URI’sindeki nesne, dizine indirilir (http(s):// için paketlenmiş httpx2, hf:// için huggingface_hub ve diğer tüm şemalar için kayıtlı özel ReferenceHandler kullanılarak). Her nesne atomik olarak yazılır ve çağrılar idempotenttir. Referans özeti değerleri opak olduğu için (bir sağlayıcı ETag’i veya URI’nin kendisi), mevcut bir dosyanın güncel olduğu varsayılır ve kaynağa karşı yeniden doğrulanmaz; yeniden denetlenen özet değeri kaydedilenle artık eşleşmeyen bir kaynak ise uyarıyla birlikte yine de indirilir. İndirme işlemi büyük miktarda veri aktarabilir; indirmeden URI’lerle çalışmak için bunları references özelliğinden veya get_entry_uri üzerinden okuyun. Eksik bir kaynak, erişilemeyen bir sunucu veya kayıtlı işleyicisi olmayan bir şema hata fırlatır.

get_entry_uri

< >

( name: str )

Mantıksal yol name için kayıtlı URI'yi döndürür; bu ada sahip bir referans girişi yoksa None döndürür.

bağlantı

< >

( target_path: straliases: list[str] | None = Nonebucket_id: str | None = None )

Parametreler

  • target_path (str) — Bağlantısının kurulacağı koleksiyon, "registry-<registry>/<collection>" biçiminde. Kayıt defteri zaten var olmalıdır.
  • aliases (list[str], isteğe bağlı) — Bağlı sürümde yer alacak takma adlar. latest otomatik olarak yönetilir; bunu geçmek hiçbir işe yaramaz.
  • bucket_id (str, isteğe bağlı) — Kaydı tutan bucket, örn. "my-org/models-registry". Yerel bir kayıt için atlayın; TRACKIO_REGISTRY_BUCKET_ID ayarlıysa varsayılan olarak bu değer kullanılır.

Bu artefakt sürümünü bir kayıt defteri koleksiyonuna bağlayın.

Bağlantı, bu sürüme bir işaretçidir: dosyalar kopyalanmaz. Tam anlambilim için (sürümleme, takma adlar ve döndürülen bağlantılı artefakt) Run.link_artifact işlevine bakın.

Artefakt zaten kaydedilmiş veya alınmış olmalıdır; Run.link_artifact'in aksine bu, sizin için bir taslak artefakt kaydetmez ve bağlantı bir yayınlama çalışması kaydetmez. Bir Space'ten veya kendi barındırdığınız bir sunucudan alınan bir artefakt, yalnızca bir varlık kovası destekli kayıt defterine bağlanabilir, çünkü yerel bir kayıt defteri, artefaktın baytlarının bulunduğu yerden erişilebilir değildir.

bağlantısını kaldır

< >

( )

Bu kayıt defteri bağlantısını kaldırın.

Bu işlemi, link veya Run.link_artifact tarafından döndürülen bağlantılı artefakt üzerinde çağırın; kaynak artefakt sürümü üzerinde değil. Kaynak artefakt ve dosyaları dokunulmadan kalır; yalnızca koleksiyon üyeliği kaldırılır. Bağlantıya işaret eden takma adlar da onunla birlikte gider ve koleksiyon sürüm numarası asla yeniden kullanılmaz. Sürüm latest tutuyorsa, bu takma ad en yüksek kalan sürüme taşınır.

bekle

< >

( timeout: int | None = None )

No-op: trackio, artefaktleri senkron olarak kaydeder, bu nedenle artefakt, log_artifact döndüğünde zaten taahhüt edilmiştir.

Kayıt Defteri

sınıf trackio.Registry

< >

( name: strbucket_id: str | None = None )

Parametreler

  • name (str) — Kayıt defteri adı, örn. "models". ^[A-Za-z0-9_-]+$ ile eşleşmelidir (harfler, rakamlar, alt çizgi, tire).
  • bucket_id (str, isteğe bağlı) — Kaydı (registry) barındıran Hugging Face bucket'ı, örn. "my-org/models-registry". Yerel bir kayıt için atlayın. Bu ayarlıysa varsayılan olarak TRACKIO_REGISTRY_BUCKET_ID kullanılır.

Bir artefakt kayıt defteriyle bağlantı.

Registry, koleksiyonlar halinde organize edilen artefakt sürümlerinin paylaşılan kataloğudur. Run.link_artifact ile içerisine yayın yapar ve "staging" veya "production" gibi takma adları taşıyarak sürümleri ilerletirsiniz. Genel bakış için Registry kılavuzuna bakın.

Registry nesnesini kendiniz oluşturamazsınız. Bir kayıt defteri oluşturmak için trackio.Api().create_registry(name) veya mevcut birini almak için trackio.Api().registry(name) kullanın; her ikisi de bu işleyiciyi döndürür.

Örnek:

import trackio

registry = trackio.Api().create_registry("models")
registry.create_collection(
    "my-model", artifact_type="model", description="My favorite model"
)

run = trackio.init(project="my-experiments")
artifact = trackio.log_artifact("model.pt", name="resnet", type="model")
run.link_artifact(artifact, "registry-models/my-model", aliases=["staging"])
trackio.finish()

registry.collection("my-model").links

koleksiyonu

< >

( name: str )

Bir koleksiyonu tanımlayın.

Kayıt defteri veya koleksiyon mevcut değilse None döndürür.

koleksiyonlar

< >

( )

Kayıt defterinin koleksiyonlarını, bağlantılar dahil listele.

Kayıt defteri (registry) yoksa boş bir liste döndürür.

create_collection

< >

( name: strartifact_type: strdescription: str | None = None )

Parametreler

  • name (str) — Koleksiyon adı, kayıt defteri içinde benzersiz olmalıdır. ^[A-Za-z0-9._-]+$ ile eşleşmelidir.
  • artifact_type (str) — Koleksiyonun kabul ettiği artefakt türü, örn. "model" veya "dataset". Tür, oluşturulma anında sabitlenir; farklı bir türde artefakt bağlanmaya çalışılırsa hata fırlatılır.
  • description (str, isteğe bağlı) — Koleksiyonun insan tarafından okunabilir açıklaması.

Bu kayıt defterinde bir koleksiyon oluşturun.

Koleksiyonlar ilk bağlantıda otomatik olarak oluşturulduğundan, bu özellik esas olarak bir açıklamayı önceden ayarlamak için kullanışlıdır. Koleksiyon zaten mevcutsa, olduğu gibi döndürülür ve None olmayan bir description uygulanır.

olaylar

< >

( )

En eski olaydan başlayarak kayıt defterinin denetim günlüğünü döndürür.

Her olayın bir id, bir ts zaman damgası, bir kind ("create", "link", "promote", "update" veya "unlink") ve mutasyonu açıklayan bir payload vardır. collection anahtarı içermeyen bir create payload'ı, kayıt deflinin kendisinin oluşturulmasını kaydeder.

Koleksiyon

sınıf trackio.Collection

< >

( name: strtype: strdescription: str | Nonecreated_at: strnum_links: intlatest_version: int | Nonelinks: list[dict] )

Bir kayıt defteri koleksiyonunun salt okunur anlık görüntüsü.

Registry.create_collection, Registry.collection ve Registry.collections tarafından döndürülür.

Görsel

sınıf trackio.TrackioImage

< >

( value: str | pathlib.Path | numpy.ndarray | PIL.Image.Imagecaption: str | None = None )

Parametreler

  • value (str, Path, numpy.ndarray veya PIL.Image, isteğe bağlı) — Bir görüntüye giden yol, bir PIL Image veya (height, width, channels) biçiminde bir numpy dizisi. Eğer numpy dizisi ise, np.uint8 tipi olmalı ve RGB değerleri [0, 255] aralığında olmalıdır.
  • caption (str, isteğe bağlı) — Görsel için bir metin açıklaması.

Bir Image nesnesi başlatır.

Örnek:

import trackio
import numpy as np
from PIL import Image

# Create an image from numpy array
image_data = np.random.randint(0, 255, (64, 64, 3), dtype=np.uint8)
image = trackio.Image(image_data, caption="Random image")
trackio.log({"my_image": image})

# Create an image from PIL Image
pil_image = Image.new('RGB', (100, 100), color='red')
image = trackio.Image(pil_image, caption="Red square")
trackio.log({"red_image": image})

# Create an image from file path
image = trackio.Image("path/to/image.jpg", caption="Photo from file")
trackio.log({"file_image": image})

Video

sınıf trackio.TrackioVideo

< >

( value: str | pathlib.Path | numpy.ndarraycaption: str | None = Nonefps: int | None = Noneformat: typing.Optional[typing.Literal['gif', 'mp4', 'webm']] = None )

Parametreler

  • value (str, Path veya numpy.ndarray, isteğe bağlı) — Bir video dosyasına giden yol veya bir numpy dizisi. Numpy dizisi ise, np.uint8 tipinde olmalı ve RGB değerleri [0, 255] aralığında olmalıdır. Şeklinin (frames, channels, height, width) veya (batch, frames, channels, height, width) olması beklenir. İkinci durumda, videolar bir ızgaraya yerleştirilir.
  • caption (str, isteğe bağlı) — Video için bir metin açıklaması.
  • fps (int, isteğe bağlı) — Video için saniye başına kare sayısı. Değer bir ndarray olduğunda kullanılır. Varsayılan değer 24'tür.
  • format (Literal["gif", "mp4", "webm"], isteğe bağlı) — Video biçimi (“gif”, “mp4” veya “webm”). Yalnızca değer bir ndarray olduğunda kullanılır. Varsayılan değer “gif”tir.

Bir Video nesnesi başlatır.

Örnek:

import trackio
import numpy as np

# Create a simple video from numpy array
frames = np.random.randint(0, 255, (10, 3, 64, 64), dtype=np.uint8)
video = trackio.Video(frames, caption="Random video", fps=30)

# Create a batch of videos
batch_frames = np.random.randint(0, 255, (3, 10, 3, 64, 64), dtype=np.uint8)
batch_video = trackio.Video(batch_frames, caption="Batch of videos", fps=15)

# Create video from file path
video = trackio.Video("path/to/video.mp4", caption="Video from file")

write_video

< >

( file_path: str | pathlib.Pathvideo: ndarrayfps: floatcodec: typing.Literal['h264', 'vp9', 'gif'] )

Sadece RGB uint8, şekil (F, H, W, 3).

Ses

sınıf trackio.TrackioAudio

< >

( value: str | pathlib.Path | numpy.ndarraycaption: str | None = Nonesample_rate: int | None = Noneformat: typing.Optional[typing.Literal['wav', 'mp3']] = None )

Parametreler

  • value (str, Path veya numpy.ndarray, isteğe bağlı) — Bir ses dosyasına giden yol veya bir numpy dizisi. Dizi, mono için (samples,) veya stereo için (samples, 2) şeklinde şekillendirilmelidir. Float dizileri tepe normalizasyonu uygulanarak 16-bit PCM'ye dönüştürülür; tamsayı dizileri gerektiğinde 16-bit PCM'ye dönüştürülür.
  • caption (str, isteğe bağlı) — Ses için bir dize açıklaması.
  • sample_rate (int, isteğe bağlı) — Hz cinsinden örneklem hızı. value bir numpy dizisi olduğunda zorunludur.
  • format (Literal["wav", "mp3"], isteğe bağlı) — value bir numpy dizisi olduğunda kullanılan ses formatı. Varsayılan değer “wav”dır.

Bir Audio nesnesi başlatır.

Örnek:

import trackio
import numpy as np

# Generate a 1-second 440 Hz sine wave (mono)
sr = 16000
t = np.linspace(0, 1, sr, endpoint=False)
wave = 0.2 * np.sin(2 * np.pi * 440 * t)
audio = trackio.Audio(wave, caption="A4 sine", sample_rate=sr, format="wav")
trackio.log({"tone": audio})

# Stereo from numpy array (shape: samples, 2)
stereo = np.stack([wave, wave], axis=1)
audio = trackio.Audio(stereo, caption="Stereo", sample_rate=sr, format="mp3")
trackio.log({"stereo": audio})

# From an existing file
audio = trackio.Audio("path/to/audio.wav", caption="From file")
trackio.log({"file_audio": audio})

ensure_int16_pcm

< >

( data: ndarray )

Girdi ses dizisini sürekli int16 PCM'ye dönüştürür. Yüzen noktalı girdilere tepe normalizasyonu uygulanır.

Object3D

sınıf trackio.TrackioObject3D

< >

( path_or_array: str | pathlib.Path | numpy.ndarraycaption: str | None = None )

Html

sınıf trackio.TrackioHtml

< >

( data: typing.Anyinject: bool = Truedata_is_not_path: bool = Falsecaption: str | None = None )

Parametreler

  • data (str, Path, dosya benzeri, Plotly şekli veya Matplotlib şekli) — Ham HTML, bir .html dosyasına yol, dosya benzeri bir nesne veya bir Plotly veya Matplotlib şekli.
  • inject (bool, isteğe bağlı) — HTML parçacıklarını biçimlendirilmiş bir belgeye sarar. Varsayılan değer True'dür.
  • data_is_not_path (bool, isteğe bağlı) — wandb.Html uyumluluğu için kabul edilir ancak yok sayılır.
  • caption (str, isteğe bağlı) — HTML için bir dize başlık.

Bir Html nesnesi başlatır.

Örnek:

import trackio

trackio.init(project="my-project")

# Raw HTML
trackio.log({"report": trackio.Html("<h1>Results</h1>")})

# Plotly figure
import plotly.express as px

fig = px.line(x=[1, 2, 3], y=[4, 5, 6])
trackio.log({"plot": trackio.Html(fig)})

# Matplotlib figure
import matplotlib.pyplot as plt

plt.plot([1, 2, 3, 4])
trackio.log({"chart": trackio.Html(plt)})

Tablo

sınıf trackio.Table

< >

( columns: list[str] | None = Nonedata: list[list[typing.Any]] | None = Nonedataframe: typing.Optional[typing.Any] = Nonerows: list[list[typing.Any]] | None = Noneoptional: bool | list[bool] = Trueallow_mixed_types: bool = Falselog_mode: typing.Optional[typing.Literal['IMMUTABLE', 'MUTABLE', 'INCREMENTAL']] = 'IMMUTABLE' )

Parametreler

  • columns (list[str], isteğe bağlı) — Tablodaki sütunların adları. data sağlanırsa isteğe bağlıdır. dataframe sağlanırsa beklenmez. Şu anda yok sayılır.
  • data (list[list[Any]], isteğe bağlı) — Değerlerin 2 boyutlu satır yönelimli dizisi. Her değer bir sayı, bir dize (Markdown olarak ele alınır ve çok uzunsa kısaltılır) veya bir Trackio.Image ya da Trackio.Image nesneleri listesi olabilir.
  • dataframe (pandas.DataFrame, isteğe bağlı) — Tabloyu oluşturmak için kullanılan DataFrame. Ayarlandığında data ve columns argümanları yok sayılır.
  • rows (list[list[Any]], isteğe bağlı) — Şu anda yok sayılır.
  • optional (bool veya list[bool], isteğe bağlı, varsayılan True) — Şu anda yok sayılıyor.
  • allow_mixed_types (bool, isteğe bağlı, varsayılan False) — Şu anda yok sayılır.
  • log_mode — (Literal["IMMUTABLE", "MUTABLE", "INCREMENTAL"] veya None, isteğe bağlı, varsayılan "IMMUTABLE"): Şu anda yok sayılır.

Bir Table nesnesini başlatır.

Tablolar, görüntüler, sayılar ve metinler dahil olmak üzere tabular verilerin kaydedilmesi için kullanılabilir.

to_display_format

< >

( table_data: list[dict] ) → list[dict]

Parametreler

  • table_data (list[dict]) — Tablo satırlarını temsil eden sözlük listesi (kaydedilmiş _value içinden).

Dönüş değeri

list[dict]

Görselleri markdown sözdizimine dönüştürülmüş ve uzun metinler kısaltılmış tablo verileri.

Depolanan tablo verilerini, arayüzün (UI) çizimi için görüntüleme biçimine dönüştürür.

Not: Bu, self.data özniteliğini kullanmaz; bunun yerine, arayüzün (UI) aldığı table_data parametresini kullanır.

İz

sınıf trackio.Trace

< >

( messages: list[dict[str, Any]]metadata: dict | None = Nonespans: list[dict[str, Any]] | None = None )

Parametreler

  • messages (list[dict[str, Any]]) — OpenAI tarzı mesajlar, örn. {"role": "user", "content": "..."}. Asistan mesajları tool_calls içerebilir ve araç sonuçları tool_call_id içerebilir; spans sağlanmadığında, gösterge panosu bunları araç işlemleri olarak eşleştirir.
  • metadata (dict, isteğe bağlı) — İzleme düzeyinde meta veriler, örn. session_id veya environment. status, duration_ms, latency_ms ve cost_usd anahtarları, span'ler bunları sağlamadığında panonun izleme düzeyinde yedek değerleri olarak kullanılır.
  • spans (list[dict[str, Any]], isteğe bağlı) — Yanıtı üreten şeyi açıklayan yürütme aralıkları. Her aralık, id, name ve kind ("span", "generation" veya "tool") anahtarlarına sahip bir sözlüktür; ayrıca isteğe bağlı parent_id, start_time, end_time, duration_ms, status, error, input, output, model, usage, cost_usd ve metadata alanları içerir.

Bir Trace nesnesi başlatır.

Traces, OpenAI tarzı mesajları, isteğe bağlı metadata'yı ve isteğe bağlı yürütme span'lerini içeren bir sohbet veya ajan tarzı isteği yakalar. Span'ler, model üretimlerini, araç çağrılarını veya diğer işlemleri tanımlayan sözlüklerdir. Mesajlar, metadata veya span'ler içindeki iç içe geçmiş Trackio medya nesneleri, trace ile birlikte kalıcı hale getirilir ve serialize edilir.

Histogram

sınıf trackio.Histogram

< >

( sequence: typing.Union[numpy.ndarray, typing.Sequence[float], typing.Sequence[int], NoneType] = Nonenp_histogram: tuple | None = Nonenum_bins: int = 64 )

Parametreler

  • sequence (np.ndarray veya Sequence[float] veya Sequence[int], isteğe bağlı) — Histogramı oluşturmak için kullanılan değer dizisi.
  • np_histogram (tuple, isteğe bağlı) — Önceden hesaplanmış NumPy histogramı, (hist, bins) demeti olarak.
  • num_bins (int, isteğe bağlı, varsayılan 64) — Histogram için kutu sayısı (en fazla 512).

Trackio için histogram veri tipi, wandb.Histogram ile uyumlu.

Örnek:

import trackio
import numpy as np

# Create histogram from sequence
data = np.random.randn(1000)
trackio.log({"distribution": trackio.Histogram(data)})

# Create histogram from numpy histogram
hist, bins = np.histogram(data, bins=30)
trackio.log({"distribution": trackio.Histogram(np_histogram=(hist, bins))})

# Specify custom number of bins
trackio.log({"distribution": trackio.Histogram(data, num_bins=50)})
Update on GitHub