Improvements to trackio.sync() (#358)

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>

Author: abidlabs

.changeset/open-plants-shop.md

@@ -0,0 +1,5 @@
+---
+"trackio": minor
+---
+
+feat:Improvements to `trackio.sync()`

trackio/__init__.py

@@ -163,9 +163,12 @@ def init(
                 favicon_path=TRACKIO_LOGO_DIR / "trackio_logo_light.png",
                 allowed_paths=[TRACKIO_LOGO_DIR, TRACKIO_DIR],
             )
+            context_vars.current_space_id.set(None)
         else:
             url = space_id
             share_url = None
+            context_vars.current_space_id.set(space_id)
+
         context_vars.current_server.set(url)
         context_vars.current_share_server.set(share_url)
     if (

trackio/context_vars.py

@@ -13,6 +13,9 @@
 current_server: contextvars.ContextVar[str | None] = contextvars.ContextVar(
     "current_server", default=None
 )
+current_space_id: contextvars.ContextVar[str | None] = contextvars.ContextVar(
+    "current_space_id", default=None
+)
 current_share_server: contextvars.ContextVar[str | None] = contextvars.ContextVar(
     "current_share_server", default=None
 )

trackio/deploy.py

@@ -1,6 +1,7 @@
 import importlib.metadata
 import io
 import os
+import threading
 import time
 from importlib.resources import files
 from pathlib import Path
@@ -13,7 +14,7 @@
 
 import trackio
 from trackio.sqlite_storage import SQLiteStorage
-from trackio.utils import preprocess_space_and_dataset_ids
+from trackio.utils import get_or_create_project_hash, preprocess_space_and_dataset_ids
 
 SPACE_HOST_URL = "https://{user_name}-{space_name}.hf.space/"
 SPACE_URL = "https://huggingface.co/spaces/{space_id}"
@@ -294,25 +295,52 @@ def upload_db_to_space(project: str, space_id: str, force: bool = False) -> None
 
 
 def sync(
-    project: str, space_id: str, private: bool | None = None, force: bool = False
-) -> None:
+    project: str,
+    space_id: str | None = None,
+    private: bool | None = None,
+    force: bool = False,
+    run_in_background: bool = False,
+) -> str:
     """
     Syncs a local Trackio project's database to a Hugging Face Space.
     If the Space does not exist, it will be created.
 
     Args:
         project (`str`): The name of the project to upload.
-        space_id (`str`): The ID of the Space to upload to (e.g., `"username/space_id"`).
+        space_id (`str`, *optional*): The ID of the Space to upload to (e.g., `"username/space_id"`).
+            If not provided, a random space_id (e.g. "username/project-2ac3z2aA") will be used.
         private (`bool`, *optional*):
             Whether to make the Space private. If None (default), the repo will be
             public unless the organization's default is private. This value is ignored
             if the repo already exists.
         force (`bool`, *optional*, defaults to `False`):
             If `True`, overwrite the existing database without prompting for confirmation.
             If `False`, prompt the user before overwriting an existing database.
+        run_in_background (`bool`, *optional*, defaults to `False`):
+            If `True`, the Space creation and database upload will be run in a background thread.
+            If `False`, all the steps will be run synchronously.
+    Returns:
+        `str`: The Space ID of the synced project.
     """
+    if space_id is None:
+        space_id = f"{project}-{get_or_create_project_hash(project)}"
     space_id, _ = preprocess_space_and_dataset_ids(space_id, None)
-    create_space_if_not_exists(space_id, private=private)
-    wait_until_space_exists(space_id)
-    upload_db_to_space(project, space_id, force=force)
-    print(f"Synced successfully to space: {SPACE_URL.format(space_id=space_id)}")
+
+    def space_creation_and_upload(
+        space_id: str, private: bool | None = None, force: bool = False
+    ):
+        print(
+            f"* Syncing local Trackio project to: {SPACE_URL.format(space_id=space_id)} (please wait...)"
+        )
+        create_space_if_not_exists(space_id, private=private)
+        wait_until_space_exists(space_id)
+        upload_db_to_space(project, space_id, force=force)
+        print(f"* Synced successfully to space: {SPACE_URL.format(space_id=space_id)}")
+
+    if run_in_background:
+        threading.Thread(
+            target=space_creation_and_upload, args=(space_id, private, force)
+        ).start()
+    else:
+        space_creation_and_upload(space_id, private, force)
+    return space_id

trackio/ui/main.py

@@ -25,7 +25,7 @@
     from trackio.ui.components.colored_checkbox import ColoredCheckboxGroup
     from trackio.ui.files import files_page
     from trackio.ui.helpers.run_selection import RunSelection
-    from trackio.ui.media import media_page
+    from trackio.ui.media_page import media_page
     from trackio.ui.run_detail import run_detail_page
     from trackio.ui.runs import run_page
 except ImportError:
@@ -42,7 +42,7 @@
     from ui.components.colored_checkbox import ColoredCheckboxGroup
     from ui.files import files_page
     from ui.helpers.run_selection import RunSelection
-    from ui.media import media_page
+    from ui.media_page import media_page
     from ui.run_detail import run_detail_page
     from ui.runs import run_page
 

trackio/ui/media.py trackio/ui/media_page.pytrackio/ui/media.py renamed to trackio/ui/media_page.py

@@ -1,6 +1,7 @@
 import math
 import os
 import re
+import secrets
 import time
 from datetime import datetime, timezone
 from functools import lru_cache
@@ -140,6 +141,16 @@ def _get_trackio_dir() -> Path:
 FILES_DIR = TRACKIO_DIR / "files"
 
 
+def get_or_create_project_hash(project: str) -> str:
+    hash_path = TRACKIO_DIR / f"{project}.hash"
+    if hash_path.exists():
+        return hash_path.read_text().strip()
+    hash_value = secrets.token_urlsafe(8)
+    TRACKIO_DIR.mkdir(parents=True, exist_ok=True)
+    hash_path.write_text(hash_value)
+    return hash_value
+
+
 def generate_readable_name(used_names: list[str], space_id: str | None = None) -> str:
     """
     Generates a random, readable name like "dainty-sunset-0".