changes

Author: abidlabs

README.md

@@ -1,6 +1,51 @@
-# trackio
+# Trackio
 
-A Python library for tracking and analytics.
+Trackio is a drop-in replacement for `wandb` that uses Hugging Face Datasets for experiment logging and Gradio for visualization.
+
+## Features
+- **API compatible** with `wandb.init`, `wandb.log`, and `wandb.finish` (use `trackio` instead)
+- Stores logs in a Hugging Face Datasets-compatible format (Parquet)
+- Visualize experiments with a Gradio dashboard
+
+## Example Usage
+```python
+import random
+import math
+import trackio
+
+# Launch 5 simulated experiments
+total_runs = 5
+for run in range(total_runs):
+    trackio.init(
+        project="basic-intro",
+        name=f"experiment_{run}",
+        config={
+            "learning_rate": 0.02,
+            "architecture": "CNN",
+            "dataset": "CIFAR-100",
+            "epochs": 10,
+        },
+    )
+
+    epochs = 10
+    offset = random.random() / 5
+    for epoch in range(2, epochs):
+        acc = 1 - 2 ** -epoch - random.random() / epoch - offset
+        loss = 2 ** -epoch + random.random() / epoch + offset
+        trackio.log({"acc": acc, "loss": loss})
+
+    trackio.finish()
+
+# To launch the Gradio UI:
+trackio.ui()
+```
+
+## Data Storage
+- Logs are saved in `./trackio/{project}/{run_name}/run.parquet`
+- Config is saved as `config.json` in the same directory
+
+## Visualization
+- Run `trackio.ui()` to launch the Gradio dashboard and explore your experiments
 
 ## Installation
 

requirements.txt

@@ -1 +1,4 @@
- 
+datasets
+pandas
+gradio
+plotly 

tests/test_basic.py

@@ -2,4 +2,4 @@
 
 
 def test_version():
-    assert trackio.__version__ == "0.1.0"
+    assert trackio.__version__ == "0.0.2"

trackio/__init__.py

@@ -1,3 +1,39 @@
 from pathlib import Path
+import os
+from .storage import TrackioStorage
+from .ui import launch_ui
 
 __version__ = Path(__file__).parent.joinpath("version.txt").read_text().strip()
+
+_current_run = None
+
+class Run:
+    def __init__(self, project, name, config):
+        self.project = project
+        self.name = name
+        self.config = config
+        self.storage = TrackioStorage(project, name, config)
+    def log(self, metrics):
+        self.storage.log(metrics)
+    def finish(self):
+        self.storage.finish()
+
+def init(project, name=None, config=None):
+    global _current_run
+    _current_run = Run(project, name, config)
+    return _current_run
+
+def log(metrics):
+    if _current_run is None:
+        raise RuntimeError("Call trackio.init() before log().")
+    _current_run.log(metrics)
+
+def finish():
+    if _current_run is None:
+        raise RuntimeError("Call trackio.init() before finish().")
+    _current_run.finish()
+    global _current_run
+    _current_run = None
+
+def ui():
+    launch_ui()

trackio/storage.py

@@ -0,0 +1,25 @@
+import os
+from datasets import Dataset
+import pandas as pd
+
+class TrackioStorage:
+    def __init__(self, project, name, config):
+        self.project = project
+        self.name = name or "unnamed_run"
+        self.config = config or {}
+        self.logs = []
+        self.dir = os.path.join("trackio", project, self.name)
+        os.makedirs(self.dir, exist_ok=True)
+        self.run_path = os.path.join(self.dir, "run.parquet")
+        self.config_path = os.path.join(self.dir, "config.json")
+        # Save config immediately
+        import json
+        with open(self.config_path, "w") as f:
+            json.dump(self.config, f, indent=2)
+    def log(self, metrics):
+        self.logs.append(metrics)
+    def finish(self):
+        if self.logs:
+            df = pd.DataFrame(self.logs)
+            ds = Dataset.from_pandas(df)
+            ds.to_parquet(self.run_path) 

trackio/ui.py

@@ -0,0 +1,7 @@
+import gradio as gr
+
+def launch_ui():
+    with gr.Blocks() as demo:
+        gr.Markdown("# Trackio Dashboard\n(Placeholder UI)")
+        gr.Markdown("This will show your tracked experiments.")
+    demo.launch()