Trackio documentation

Buku Log

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Buku Log

Logbook Trackio adalah notebook eksperimen yang dapat dibagikan untuk mencatat penalaran, perintah, hasil, gambar, artefak (checkpoint, dataset, dll.), dan jejak agen di balik sebuah eksperimen. Sebuah logbook disimpan secara lokal di direktori .trackio/logbook dari sebuah workspace dan dapat dipratinjau secara lokal atau dipublikasikan sebagai Hugging Face Space statis.

Disarankan untuk agen coding: Cara termudah untuk menggunakan Logbooks dengan agen coding (misalnya Codex, Claude Code, Pi, OpenCode) adalah dengan memberikan instruksi berikut kepada agen coding Anda:

trackio skills add
trackio logbook open
trackio logbook attach trace <path to current trace>

Work in this workspace's Trackio logbook. Before running any experiment or
script, create or select the relevant page with `trackio logbook page "..."`. Run every experiment command with `trackio logbook run -- <command>` ratherthan invoking it directly, which will log the code and its outputs into the logbook. 

Untuk detail lebih lanjut dan kontrol yang lebih rinci, lanjutkan membaca!

Mulai sesi agen dengan buku log

Cara termudah untuk menggunakan logbook adalah dengan membuatnya sebelum agen mulai membuat perubahan atau menjalankan eksperimen:

trackio logbook open --title "Learning-rate sweep"

Ini membuat logbook lokal dan membuka pratinjaunya. Gunakan --no-serve ketika Anda hanya ingin membuat atau menempelkan ke logbook lokal. Gunakan --no-browser untuk memulai pratinjau tanpa membuka browser, atau berikan --port untuk memilih port yang berbeda.

Beri agen keterampilan Trackio

Install skill Trackio untuk coding agent yang Anda gunakan. Untuk Codex:

trackio skills add --codex

Perintah ini menginstal skill di proyek dan menghubungkannya untuk Codex. Mulai sesi Codex baru setelah instalasi jika diperlukan agar skill dapat dimuat. Untuk agen lain yang didukung, ganti --codex dengan flag-nya, seperti --claude, --cursor, --opencode, atau --pi.

Skill memberi tahu agen untuk menjalankan kode dengan trackio logbook run -- ... alih-alih memanggil perintah eksperimen secara langsung. Wrapper tersebut mencatat perintah yang tepat, skrip dan file konfigurasi yang terdeteksi, output, kode keluar, durasi, dan artefak output yang didukung. Sebagai contoh:

trackio logbook page "Baseline"
trackio logbook run -- python train.py --learning-rate 0.001

Skrip pelatihan harus tetap menggunakan trackio.init(), trackio.log(), dan trackio.finish() secara normal. Dengan logbook di workspace, trackio.init() juga dapat menambahkan sel dashboard live untuk proyek Trackio yang aktif.

Lampirkan jejak sesi aktif

Lampirkan transkrip coding-agent saat ini di dekat awal sesi:

trackio logbook attach trace /absolute/path/to/current-session.jsonl --title "Agent session"

Runtime agen menentukan di mana transkripnya disimpan. Temukan file JSON atau JSONL untuk percakapan aktif menggunakan direktori sesi dari runtime tersebut, lalu lampirkan file yang timestamp dan metadatanya cocok dengan sesi. File JSONL aktif dapat dilampirkan sebelum sesi berakhir; Trackio memperbaruinya selama pratinjau lokal terbuka. Melampirkan juga menetapkan baseline Workspace, sehingga file model dan data yang didukung kemudian dapat dikaitkan dengan sesi.

Trackio secara default menghapus rahasia umum dari trace yang terlampir. Tinjau trace sebelum dipublikasikan karena masih dapat berisi prompt, input alat, output perintah, path, atau data pribadi. Gunakan --no-scrub hanya untuk sumber yang sudah disanitasi.

Buat halaman seiring dengan perkembangan pekerjaan

Membuka workspace yang sudah berisi logbook akan menempelkan ke logbook tersebut. Logbook terdiri dari halaman; buat atau pilih halaman dengan:

trackio logbook page "Baseline"

Tambahkan konten eksperimen

Tambahkan Markdown, kode, gambar, artefak, atau dashboard Trackio yang tertanam:

trackio logbook cell markdown "Baseline accuracy: 82.4%" --page "Baseline"
trackio logbook cell code --page "Baseline" --code-text "print(metrics)" --language python
trackio logbook cell figure --page "Baseline" --image plots/baseline.png
trackio logbook cell artifact "my-project/model:v1" --page "Baseline" --type model
trackio logbook cell dashboard my-project --page "Baseline"

Untuk menjalankan perintah eksperimen dan menangkap perintah, output, skrip, dan file outputnya dalam satu langkah:

trackio logbook run --page "Sweep" -- python train.py --learning-rate 0.001

File output model dan data direkam sebagai sel artifact secara default. Lewati --no-artifacts untuk menonaktifkan penangkapan tersebut.

Baca buku log secara programatik

trackio logbook read menghasilkan tampilan ringkas yang ramah agen. Perintah ini dapat membaca workspace lokal, ID Space yang dipublikasikan, atau URL logbook:

trackio logbook read
trackio logbook read pages
trackio logbook read page "Baseline"
trackio logbook read --json

Gunakan trackio logbook read cell <cell-id> --full ketika sebuah sel perlu diperiksa secara lengkap. Format JSON berguna untuk otomasi dan agen coding.

Publikasikan buku log

Publikasikan logbook saat ini ke Hugging Face Space:

trackio logbook publish username/learning-rate-logbook

Logbook yang dipublikasikan bersifat statis dan hanya-baca. Space menyimpan referensi ke dataset trace dan bucket artifact secara default; gunakan --public hanya jika sumber daya yang dirujuk tersebut juga harus bersifat publik. Gunakan --private untuk membuat Space menjadi privat.

Update on GitHub