Merge pull request #5 from gradio-app/print-proj

Now includes a direct link to the project when run:

Author: abidlabs

README.md

@@ -11,48 +11,8 @@
 - *Local-first* design: dashboard runs locally by default. You can also host it on Spaces by changing a single parameter.
 - Everything here, including hosting on Spaces, is **free**!
 
-## Example Usage
-```python
-import random
-import math
-import trackio
-import time
-
-sleep_time = 0.5
-
-# Launch 5 simulated experiments
-total_runs = 5
-for run in range(total_runs):
-    
-    trackio.init(
-        project="basic-intro-4",
-        name=f"experiment_{run}",
-        config={
-            "learning_rate": 0.02,
-            "architecture": "CNN",
-            "dataset": "CIFAR-100",
-            "epochs": 10,
-        },
-    )
-    time.sleep(sleep_time)
-
-    epochs = 10
-    offset = random.random() / 5
-    for epoch in range(2, epochs):
-        time.sleep(sleep_time)
-        acc = 1 - 2**-epoch - random.random() / epoch - offset
-        loss = 2**-epoch + random.random() / epoch + offset
-        trackio.log({"acc": acc, "loss": loss})
-```
-
 Trackio is designed to be lightweight (<500 lines of code total), not fully-featured. It is designed in a modular way so that developers can easily fork the repository and add functionality that they care about.
 
-## 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
 

tests/test_basic.py

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

trackio/__init__.py

@@ -22,8 +22,9 @@
 
 def init(project, name=None, config=None):
     if not current_server.get():
-        url = launch_gradio()
+        url = launch_gradio(show_api=False, inline=False, quiet=True)
         print(f"* Trackio server launched at: {url}")
+        print(f"** View project dashboard at: {url}?project={project}")
         current_server.set(url)
     else:
         url = current_server.get()

trackio/examples/fake-training.py

@@ -0,0 +1,54 @@
+import random
+
+from tqdm import tqdm
+
+import trackio as wandb
+
+wandb.init(
+    project="fake-training",
+    name="test-run",
+    config=dict(
+        epochs=5,
+        learning_rate=0.001,
+        batch_size=32,
+    ),
+)
+
+EPOCHS = 5
+NUM_TRAIN_BATCHES = 100
+NUM_VAL_BATCHES = 20
+
+for epoch in range(EPOCHS):
+    train_loss = 0
+    train_accuracy = 0
+    val_loss = 0
+    val_accuracy = 0
+
+    for _ in tqdm(range(NUM_TRAIN_BATCHES), desc=f"Epoch {epoch + 1} - Training"):
+        loss = random.uniform(0.2, 1.0)
+        accuracy = random.uniform(0.6, 0.95)
+        train_loss += loss
+        train_accuracy += accuracy
+
+    for _ in tqdm(range(NUM_VAL_BATCHES), desc=f"Epoch {epoch + 1} - Validation"):
+        loss = random.uniform(0.2, 0.9)
+        accuracy = random.uniform(0.65, 0.98)
+        val_loss += loss
+        val_accuracy += accuracy
+
+    train_loss /= NUM_TRAIN_BATCHES
+    train_accuracy /= NUM_TRAIN_BATCHES
+    val_loss /= NUM_VAL_BATCHES
+    val_accuracy /= NUM_VAL_BATCHES
+
+    wandb.log(
+        {
+            "epoch": epoch + 1,
+            "train_loss": train_loss,
+            "train_accuracy": train_accuracy,
+            "val_loss": val_loss,
+            "val_accuracy": val_accuracy,
+        }
+    )
+
+wandb.finish()

trackio/ui.py

@@ -7,11 +7,18 @@
 from trackio.utils import RESERVED_KEYS
 
 
-def get_projects():
+def get_projects(request: gr.Request):
     storage = SQLiteStorage("", "", {})
     projects = storage.get_projects()
+    if project := request.query_params.get("project"):
+        pass
+    else:
+        project = projects[0] if projects else None
     return gr.Dropdown(
-        label="Project", choices=projects, value=projects[0] if projects else None
+        label="Project",
+        choices=projects,
+        value=project,
+        allow_custom_value=True,
     )
 
 
@@ -55,70 +62,71 @@ def log(project: str, run: str, metrics: dict[str, Any]) -> None:
     storage.log(metrics)
 
 
-def launch_gradio() -> str:
-    with gr.Blocks(theme="citrus") as demo:
-        with gr.Sidebar():
-            gr.Markdown("# 🎯 Trackio Dashboard")
-            project_dd = gr.Dropdown(label="Project")
-            gr.Markdown("### ⚙️ Settings")
-            realtime_cb = gr.Checkbox(label="Refresh realtime", value=True)
-        with gr.Row():
-            run_dd = gr.Dropdown(label="Run", choices=[], multiselect=True)
-
-        timer = gr.Timer(value=1)
-
-        gr.on(
-            [demo.load, timer.tick],
-            fn=get_projects,
-            outputs=project_dd,
-            show_progress="hidden",
-        )
-        gr.on(
-            [demo.load, project_dd.change, timer.tick],
-            fn=update_runs,
-            inputs=project_dd,
-            outputs=run_dd,
-            show_progress="hidden",
-        )
-        realtime_cb.change(
-            fn=toggle_timer,
-            inputs=realtime_cb,
-            outputs=timer,
-            api_name="toggle_timer",
-        )
-
-        gr.api(
-            fn=log,
-            api_name="log",
-        )
-
-        @gr.render(
-            triggers=[run_dd.change, timer.tick],
-            inputs=[project_dd, run_dd],
-        )
-        def update_dashboard(project, runs):
-            dfs = []
-            for run in runs:
-                df = load_run_data(project, run)
-                if df is not None:
-                    df["run"] = run
-                    dfs.append(df)
-            if dfs:
-                master_df = pd.concat(dfs, ignore_index=True)
-            else:
-                master_df = pd.DataFrame()
-            numeric_cols = master_df.select_dtypes(include="number").columns
-            numeric_cols = [c for c in numeric_cols if c not in RESERVED_KEYS]
-            for col in numeric_cols:
-                gr.LinePlot(
-                    master_df,
-                    x="step",
-                    y=col,
-                    color="run" if "run" in master_df.columns else None,
-                    title=col,
-                )
-
-    _, url, _ = demo.launch(show_api=False, inline=False, quiet=True)
+with gr.Blocks(theme="citrus") as demo:
+    with gr.Sidebar():
+        gr.Markdown("# 🎯 Trackio Dashboard")
+        project_dd = gr.Dropdown(label="Project")
+        gr.Markdown("### ⚙️ Settings")
+        realtime_cb = gr.Checkbox(label="Refresh realtime", value=True)
+    with gr.Row():
+        run_dd = gr.Dropdown(label="Run", choices=[], multiselect=True)
+
+    timer = gr.Timer(value=1)
+
+    gr.on(
+        [demo.load, timer.tick],
+        fn=get_projects,
+        outputs=project_dd,
+        show_progress="hidden",
+    )
+    gr.on(
+        [demo.load, project_dd.change, timer.tick],
+        fn=update_runs,
+        inputs=project_dd,
+        outputs=run_dd,
+        show_progress="hidden",
+    )
+    realtime_cb.change(
+        fn=toggle_timer,
+        inputs=realtime_cb,
+        outputs=timer,
+        api_name="toggle_timer",
+    )
+
+    gr.api(
+        fn=log,
+        api_name="log",
+    )
+
+    @gr.render(
+        triggers=[run_dd.change, timer.tick],
+        inputs=[project_dd, run_dd],
+    )
+    def update_dashboard(project, runs):
+        dfs = []
+        for run in runs:
+            df = load_run_data(project, run)
+            if df is not None:
+                df["run"] = run
+                dfs.append(df)
+        if dfs:
+            master_df = pd.concat(dfs, ignore_index=True)
+        else:
+            master_df = pd.DataFrame()
+        numeric_cols = master_df.select_dtypes(include="number").columns
+        numeric_cols = [c for c in numeric_cols if c not in RESERVED_KEYS]
+        for col in numeric_cols:
+            gr.LinePlot(
+                master_df,
+                x="step",
+                y=col,
+                color="run" if "run" in master_df.columns else None,
+                title=col,
+            )
+
+
+def launch_gradio(**kwargs) -> str:
+    _, url, _ = demo.launch(**kwargs)
     return url
 
 

trackio/version.txt

@@ -1 +1 @@
-0.0.4
+0.0.5