Allow to choose private for Trackio Spaces (#236)

Author: qgallouedec

trackio/__init__.py

@@ -52,6 +52,7 @@ def init(
     config: dict | None = None,
     resume: str = "never",
     settings: Any = None,
+    private: bool | None = None,
 ) -> Run:
     """
     Creates a new Trackio project and returns a [`Run`] object.
@@ -89,6 +90,10 @@ def init(
               doesn't exist
             - `"allow"`: Resume the run if it exists, otherwise create a new run
             - `"never"`: Never resume a run, always create a new one
+        private (`bool` or `None`, *optional*, defaults to `None`):
+            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.
         settings (`Any`, *optional*, defaults to `None`):
             Not used. Provided for compatibility with `wandb.init()`.
 
@@ -133,7 +138,9 @@ def init(
             print(f"* Trackio metrics logged to: {TRACKIO_DIR}")
             utils.print_dashboard_instructions(project)
         else:
-            deploy.create_space_if_not_exists(space_id, space_storage, dataset_id)
+            deploy.create_space_if_not_exists(
+                space_id, space_storage, dataset_id, private
+            )
             print(
                 f"* View dashboard by going to: {deploy.SPACE_URL.format(space_id=space_id)}"
             )

trackio/deploy.py

@@ -47,6 +47,7 @@ def deploy_as_space(
     space_id: str,
     space_storage: huggingface_hub.SpaceStorage | None = None,
     dataset_id: str | None = None,
+    private: bool | None = None,
 ):
     if (
         os.getenv("SYSTEM") == "spaces"
@@ -60,6 +61,7 @@ def deploy_as_space(
     try:
         huggingface_hub.create_repo(
             space_id,
+            private=private,
             space_sdk="gradio",
             space_storage=space_storage,
             repo_type="space",
@@ -71,6 +73,7 @@ def deploy_as_space(
             huggingface_hub.login(add_to_git_credential=False)
             huggingface_hub.create_repo(
                 space_id,
+                private=private,
                 space_sdk="gradio",
                 space_storage=space_storage,
                 repo_type="space",
@@ -138,13 +141,17 @@ def create_space_if_not_exists(
     space_id: str,
     space_storage: huggingface_hub.SpaceStorage | None = None,
     dataset_id: str | None = None,
+    private: bool | None = None,
 ) -> None:
     """
     Creates a new Hugging Face Space if it does not exist. If a dataset_id is provided, it will be added as a space variable.
 
     Args:
         space_id: The ID of the Space to create.
         dataset_id: The ID of the Dataset to add to the Space.
+        private: 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.
     """
     if "/" not in space_id:
         raise ValueError(
@@ -175,7 +182,7 @@ def create_space_if_not_exists(
             raise ValueError(f"Failed to create Space: {e}")
 
     print(f"* Creating new space: {SPACE_URL.format(space_id=space_id)}")
-    deploy_as_space(space_id, space_storage, dataset_id)
+    deploy_as_space(space_id, space_storage, dataset_id, private)
 
 
 def wait_until_space_exists(

trackio/imports.py

@@ -13,6 +13,7 @@ def import_csv(
     name: str | None = None,
     space_id: str | None = None,
     dataset_id: str | None = None,
+    private: bool | None = None,
 ) -> None:
     """
     Imports a CSV file into a Trackio project. The CSV file must contain a `"step"`
@@ -50,6 +51,10 @@ def import_csv(
             SQLite database, unless a `space_id` is provided, in which case a Dataset
             will be automatically created with the same name as the Space but with the
             `"_dataset"` suffix.
+        private (`bool` or `None`, *optional*, defaults to `None`):
+            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.
     """
     if SQLiteStorage.get_runs(project):
         raise ValueError(
@@ -134,7 +139,9 @@ def import_csv(
     if space_id is None:
         utils.print_dashboard_instructions(project)
     else:
-        deploy.create_space_if_not_exists(space_id=space_id, dataset_id=dataset_id)
+        deploy.create_space_if_not_exists(
+            space_id=space_id, dataset_id=dataset_id, private=private
+        )
         deploy.wait_until_space_exists(space_id=space_id)
         deploy.upload_db_to_space(project=project, space_id=space_id)
         print(
@@ -148,6 +155,7 @@ def import_tf_events(
     name: str | None = None,
     space_id: str | None = None,
     dataset_id: str | None = None,
+    private: bool | None = None,
 ) -> None:
     """
     Imports TensorFlow Events files from a directory into a Trackio project. Each
@@ -180,6 +188,10 @@ def import_tf_events(
             SQLite database, unless a `space_id` is provided, in which case a Dataset
             will be automatically created with the same name as the Space but with the
             `"_dataset"` suffix.
+        private (`bool` or `None`, *optional*, defaults to `None`):
+            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.
     """
     try:
         from tbparse import SummaryReader
@@ -280,7 +292,9 @@ def import_tf_events(
     if space_id is None:
         utils.print_dashboard_instructions(project)
     else:
-        deploy.create_space_if_not_exists(space_id, dataset_id=dataset_id)
+        deploy.create_space_if_not_exists(
+            space_id, dataset_id=dataset_id, private=private
+        )
         deploy.wait_until_space_exists(space_id)
         deploy.upload_db_to_space(project, space_id)
         print(