Rename save_visualizations to view_visualizations for clarity

talmolab · Jun 21, 2024 · d949fda · d949fda
1 parent 36cdba2
commit d949fda
Show file tree

Hide file tree

Showing 28 changed files with 152 additions and 232 deletions.
diff --git a/sleap/nn/config/outputs.py b/sleap/nn/config/outputs.py
@@ -148,7 +148,7 @@ class OutputsConfig:
         tags: A list of strings to use as "tags" that can be used to organize multiple
             runs. These are not used for anything during training or inference, so they
             can be used to store arbitrary user-specified metadata.
-        save_visualizations: If True, will render and save visualizations of the model
+        view_visualizations: If True, will render and save visualizations of the model
             predictions as PNGs to "{run_folder}/viz/{split}.{epoch:04d}.png", where the
             split is one of "train", "validation", "test".
         delete_viz_images: If True, delete the saved visualizations after training
@@ -169,7 +169,7 @@ class OutputsConfig:
     run_name_suffix: Optional[Text] = None
     runs_folder: Text = "models"
     tags: List[Text] = attr.ib(factory=list)
-    save_visualizations: bool = True
+    view_visualizations: bool = True
     delete_viz_images: bool = True
     zip_outputs: bool = False
     log_to_csv: bool = True

diff --git a/sleap/nn/training.py b/sleap/nn/training.py
@@ -515,7 +515,7 @@ def setup_visualization(
             "This probably means Qt is running headless."
         )
 
-    if config.save_visualizations and config.save_outputs:
+    if config.view_visualizations and config.save_outputs:
         callbacks.append(
             MatplotlibSaver(
                 save_folder=os.path.join(run_path, "viz"), plot_fn=viz_fn, prefix=name
@@ -945,7 +945,7 @@ def train(self):
         # Run post-training actions.
         if self.config.outputs.save_outputs:
             if (
-                self.config.outputs.save_visualizations
+                self.config.outputs.view_visualizations
                 and self.config.outputs.delete_viz_images
             ):
                 self.cleanup()
@@ -1948,7 +1948,7 @@ def create_trainer_using_cli(args: Optional[List] = None):
         job_config.outputs.run_name_prefix = args.prefix
     if args.suffix != "":
         job_config.outputs.run_name_suffix = args.suffix
-    job_config.outputs.save_visualizations |= args.save_viz
+    job_config.outputs.view_visualizations |= args.save_viz
     if args.labels_path == "":
         args.labels_path = None
     args.video_paths = args.video_paths.split(",")

diff --git a/sleap/training_profiles/baseline.centroid.json b/sleap/training_profiles/baseline.centroid.json
@@ -90,10 +90,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 5,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -104,7 +104,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 20
         }
     },
@@ -115,7 +115,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -139,4 +139,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}
diff --git a/sleap/training_profiles/baseline_large_rf.bottomup.json b/sleap/training_profiles/baseline_large_rf.bottomup.json
@@ -99,10 +99,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 8,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -113,7 +113,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 10
         }
     },
@@ -124,7 +124,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -148,4 +148,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}
diff --git a/sleap/training_profiles/baseline_large_rf.single.json b/sleap/training_profiles/baseline_large_rf.single.json
@@ -90,10 +90,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-05,
+            "plateau_min_delta": 1e-5,
             "plateau_patience": 5,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -104,7 +104,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 10
         }
     },
@@ -115,7 +115,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -139,4 +139,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}
diff --git a/sleap/training_profiles/baseline_large_rf.topdown.json b/sleap/training_profiles/baseline_large_rf.topdown.json
@@ -91,10 +91,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 5,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -105,7 +105,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 10
         }
     },
@@ -116,7 +116,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -140,4 +140,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}
diff --git a/sleap/training_profiles/baseline_medium_rf.bottomup.json b/sleap/training_profiles/baseline_medium_rf.bottomup.json
@@ -99,10 +99,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 8,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -113,7 +113,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 10
         }
     },
@@ -124,7 +124,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -148,4 +148,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}
diff --git a/sleap/training_profiles/baseline_medium_rf.single.json b/sleap/training_profiles/baseline_medium_rf.single.json
@@ -90,10 +90,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 5,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -104,7 +104,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 10
         }
     },
@@ -115,7 +115,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -139,4 +139,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}
diff --git a/sleap/training_profiles/baseline_medium_rf.topdown.json b/sleap/training_profiles/baseline_medium_rf.topdown.json
@@ -91,10 +91,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 5,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -105,7 +105,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 10
         }
     },
@@ -116,7 +116,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -140,4 +140,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}
diff --git a/sleap/training_profiles/pretrained.bottomup.json b/sleap/training_profiles/pretrained.bottomup.json
@@ -96,10 +96,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 8,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -110,7 +110,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 10
         }
     },
@@ -121,7 +121,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -145,4 +145,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}
diff --git a/sleap/training_profiles/pretrained.centroid.json b/sleap/training_profiles/pretrained.centroid.json
@@ -87,10 +87,10 @@
         "learning_rate_schedule": {
             "reduce_on_plateau": true,
             "reduction_factor": 0.5,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 5,
             "plateau_cooldown": 3,
-            "min_learning_rate": 1e-08
+            "min_learning_rate": 1e-8
         },
         "hard_keypoint_mining": {
             "online_mining": false,
@@ -101,7 +101,7 @@
         },
         "early_stopping": {
             "stop_training_on_plateau": true,
-            "plateau_min_delta": 1e-08,
+            "plateau_min_delta": 1e-8,
             "plateau_patience": 10
         }
     },
@@ -112,7 +112,7 @@
         "run_name_suffix": null,
         "runs_folder": "models",
         "tags": [],
-        "save_visualizations": true,
+        "view_visualizations": true,
         "log_to_csv": true,
         "checkpointing": {
             "initial_model": false,
@@ -136,4 +136,4 @@
             "publish_address": "tcp://127.0.0.1:9001"
         }
     }
-}
+}