Transition to workspace_name as it is clearer

Author: jannick-schroeer

nerfstudio/configs/experiment_config.py

@@ -75,8 +75,8 @@ class ExperimentConfig(InstantiateConfig):
     """Relative path to save all checkpoints."""
     load_scheduler: bool = True
     """Whether to load the scheduler state_dict to resume training, if it exists."""
-    entity_name: Optional[str] = None
-    """WandB entity name. If None, will use the default entity name set in WandB config."""
+    workspace_name: Optional[str] = None
+    """Comet Workspace or WandB entity name. If None, will use the default workspace/entity."""
 
     def is_viewer_legacy_enabled(self) -> bool:
         """Checks if the legacy viewer is enabled."""

nerfstudio/engine/trainer.py

@@ -213,7 +213,7 @@ def setup(self, test_mode: Literal["test", "val", "inference"] = "val") -> None:
             log_dir=writer_log_path,
             experiment_name=self.config.experiment_name,
             project_name=self.config.project_name,
-            entity_name=self.config.entity_name,
+            workspace_name=self.config.workspace_name,
         )
         writer.setup_local_writer(
             self.config.logging, max_iter=self.config.max_num_iterations, banner_messages=banner_messages

nerfstudio/utils/writer.py

@@ -207,7 +207,7 @@ def setup_event_writer(
     log_dir: Path,
     experiment_name: str,
     project_name: str = "nerfstudio-project",
-    entity_name: str = None,
+    workspace_name: str = None,
 ) -> None:
     """Initialization of all event writers specified in config
     Args:
@@ -218,11 +218,11 @@ def setup_event_writer(
     using_event_writer = False
 
     if is_comet_enabled:
-        curr_writer = CometWriter(log_dir=log_dir, experiment_name=experiment_name, project_name=project_name)
+        curr_writer = CometWriter(log_dir=log_dir, experiment_name=experiment_name, project_name=project_name, workspace_name=workspace_name)
         EVENT_WRITERS.append(curr_writer)
         using_event_writer = True
     if is_wandb_enabled:
-        curr_writer = WandbWriter(log_dir=log_dir, experiment_name=experiment_name, project_name=project_name, entity_name=entity_name)
+        curr_writer = WandbWriter(log_dir=log_dir, experiment_name=experiment_name, project_name=project_name, workspace_name=workspace_name)
         EVENT_WRITERS.append(curr_writer)
         using_event_writer = True
     if is_tensorboard_enabled:
@@ -306,7 +306,7 @@ def __exit__(self, *args):
 class WandbWriter(Writer):
     """WandDB Writer Class"""
 
-    def __init__(self, log_dir: Path, experiment_name: str, project_name: str = "nerfstudio-project", entity_name: str = None):
+    def __init__(self, log_dir: Path, experiment_name: str, project_name: str = "nerfstudio-project", workspace_name: str = None):
         import wandb  # wandb is slow to import, so we only import it if we need it.
 
         opt_args = {
@@ -316,8 +316,8 @@ def __init__(self, log_dir: Path, experiment_name: str, project_name: str = "ner
             "reinit": True,
         }
 
-        if entity_name is not None:
-            opt_args["entity"] = os.environ.get("WANDB_ENTITY", entity_name)
+        if workspace_name is not None:
+            opt_args["entity"] = os.environ.get("WANDB_ENTITY", workspace_name)
 
         wandb.init(**opt_args)