Skip to content

Commit 6028f83

Browse files
authored
Enhance README content and formatting
Updated README to improve clarity and fix formatting issues.
1 parent 8cb883d commit 6028f83

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,20 @@
2222

2323
Welcome to `trackio`: a lightweight, <u>free</u> experiment tracking library built by Hugging Face for humans and AI agents 🤗.
2424

25-
Why Trackio when other experiment-tracking libraries exist? Trackio has a few qualities that make it particularly useful for agents:
25+
**Why Trackio when other experiment-tracking libraries exist?** Trackio has a few qualities that make it particularly useful for agents:
2626
* It is local-first, because you shouldn't need to make an account to log data
27-
* Logs are stored in SQLite database (with support for "freezing" logs to Parquet), which not only supports very high throughputs for many parallel experiments, but also
27+
* Logs are stored in SQLite database (with support for "freezing" logs to Parquet), which not only lets Trackio supports very high throughputs for parallel experiments, but also
2828
* provides an easy CLI interface for querying data (including directly on the SQL data), perfect for LLM-driven analysis.
2929

3030
So whether you are using agents to run entire research experiments autonomously or whether you are just using LLMs to analyze data, Trackio is for you.
3131

3232
For human users, Trackio _also_ ships with a Gradio-inspired dashboard so you can view metrics, media, tables, alerts, etc.:
3333

34-
![Screen Recording 2025-11-06 at 5 34 50 PM](https://github.com/user-attachments/assets/8c9c1b96-f17a-401c-83a4-26ac754f89c7)
34+
35+
36+
https://github.com/user-attachments/assets/2683cf27-7520-4fff-9ee9-bdc08a8ca404
37+
38+
3539

3640
### Trackio's main features:
3741

@@ -42,7 +46,7 @@ For human users, Trackio _also_ ships with a Gradio-inspired dashboard so you ca
4246
```
4347
and keep your existing logging code.
4448

45-
- **Local-first** design: dashboard runs locally by default. But note that you can also log metrics to a Hugging Face Space with `space_id` for free, which is useful for collaborative experiments.
49+
- **Local-first, cloud-optional** design: dashboard runs locally by default. But note that you can also log metrics to a Hugging Face Space with `space_id` which is _also_ free and useful for collaborative experiments.
4650
- **LLM-friendly**: Built with autonomous ML experiments in mind, Trackio includes a CLI for programmatic access and a Python API for run management, making it easy for LLMs to log metrics and query experiment data.
4751
- Use `trackio query project --project <name> --sql "SELECT ..."` for read-only SQL when `trackio list` and `trackio get` are not enough
4852
- See the storage schema and direct query reference at https://huggingface.co/docs/trackio/storage_schema

0 commit comments

Comments
 (0)