From be74a8c35b67e375212998501fc6c645b375bf61 Mon Sep 17 00:00:00 2001
From: Aidan Pine <hello@aidanpine.ca>
Date: Thu, 7 Sep 2023 14:26:25 -0700
Subject: [PATCH] refactor(config): change default log dir from logs to
 logs_and_checkpoints

fixes https://github.com/roedoejet/EveryVoice/issues/39
---
 .gitignore                                                | 1 +
 docs/guides/custom.md                                     | 4 ++--
 everyvoice/config/base/base_shared.yaml                   | 6 +++---
 everyvoice/config/default/aligner.yaml                    | 2 +-
 everyvoice/config/default/fastspeech2.yaml                | 2 +-
 everyvoice/config/default/hifigan.yaml                    | 2 +-
 everyvoice/config/default/istft.yaml                      | 2 +-
 everyvoice/config/shared_types.py                         | 2 +-
 everyvoice/model/aligner/DeepForcedAligner                | 2 +-
 everyvoice/model/e2e/config/lj_training.yaml              | 6 +++---
 everyvoice/model/e2e/config/training.yaml                 | 2 +-
 everyvoice/model/feature_prediction/FastSpeech2_lightning | 2 +-
 everyvoice/model/vocoder/HiFiGAN_iSTFT_lightning          | 2 +-
 everyvoice/tests/test_wizard.py                           | 3 +++
 everyvoice/wizard/basic.py                                | 3 ++-
 15 files changed, 23 insertions(+), 18 deletions(-)

diff --git a/.gitignore b/.gitignore
index 9324eb86..d47888d4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,7 @@
 __pycache__
 .coverage
 logs
+logs_and_checkpoints
 *.ckpt
 .vscode
 *egg-info
diff --git a/docs/guides/custom.md b/docs/guides/custom.md
index 1ed1eab8..8973ae88 100644
--- a/docs/guides/custom.md
+++ b/docs/guides/custom.md
@@ -80,7 +80,7 @@ Which would use the GPU accelerator and specify 1 device/chip.
 
 To generate audio when you train your feature prediction network, you need to add your vocoder checkpoint to the `config/feature_prediction.yaml`
 
-At the bottom of that file you'll find a key called vocoder_path. Add the absolute path to your trained vocder (here it would be `/path/to/test/logs/VocoderExperiment/base/checkpoints/last.ckpt` where `/path/to` would be the actual path to it on your computer.)
+At the bottom of that file you'll find a key called vocoder_path. Add the absolute path to your trained vocder (here it would be `/path/to/test/logs_and_checkpoints/VocoderExperiment/base/checkpoints/last.ckpt` where `/path/to` would be the actual path to it on your computer.)
 
 Once you've replaced the vocoder_path key, you can train your feature prediction network:
 
@@ -93,7 +93,7 @@ everyvoice fs2 train -p config/feature_prediction.yaml
 You can synthesize by pointing the CLI to your trained feature prediction network and passing in the text. You can export to wav, npy, or pt files.
 
 ```bash
-everyvoice fs2 synthesize logs/FeaturePredictionExperiment/base/checkpoints/last.ckpt -t "මෙදා සැරේ සාකච්ඡාවක් විදියට නෙවෙයි නේද පල කරල තියෙන්නෙ" -a gpu -d 1 -O wav
+everyvoice fs2 synthesize logs_and_checkpoints/FeaturePredictionExperiment/base/checkpoints/last.ckpt -t "මෙදා සැරේ සාකච්ඡාවක් විදියට නෙවෙයි නේද පල කරල තියෙන්නෙ" -a gpu -d 1 -O wav
 ```
 
 <!-- % Step 10 (optional): Finetune your vocoder
diff --git a/everyvoice/config/base/base_shared.yaml b/everyvoice/config/base/base_shared.yaml
index 78482a93..923107e3 100644
--- a/everyvoice/config/base/base_shared.yaml
+++ b/everyvoice/config/base/base_shared.yaml
@@ -23,7 +23,7 @@ aligner:
     filelist_loader: "everyvoice.utils.generic_dict_loader"
     logger:
       name: "BaseExperiment"
-      save_dir: "./logs"
+      save_dir: "./logs_and_checkpoints"
       sub_dir: "everyvoice.utils.get_current_time"
       version: "base"
     val_data_workers: 0
@@ -135,7 +135,7 @@ feature_prediction:
     filelist_loader: "everyvoice.utils.generic_dict_loader"
     logger:
       name: "BaseExperiment"
-      save_dir: "./logs"
+      save_dir: "./logs_and_checkpoints"
       sub_dir: "everyvoice.utils.get_current_time"
       version: "base"
     val_data_workers: 0
@@ -176,7 +176,7 @@ vocoder:
     filelist_loader: "everyvoice.utils.generic_dict_loader"
     logger:
       name: "BaseExperiment"
-      save_dir: "./logs"
+      save_dir: "./logs_and_checkpoints"
       sub_dir: "everyvoice.utils.get_current_time"
       version: "base"
     val_data_workers: 0
diff --git a/everyvoice/config/default/aligner.yaml b/everyvoice/config/default/aligner.yaml
index 6a059e18..1c9f73e9 100644
--- a/everyvoice/config/default/aligner.yaml
+++ b/everyvoice/config/default/aligner.yaml
@@ -22,7 +22,7 @@ training:
   filelist_loader: "everyvoice.utils.generic_dict_loader"
   logger:
     name: "BaseExperiment"
-    save_dir: "./logs"
+    save_dir: "./logs_and_checkpoints"
     sub_dir: "everyvoice.utils.get_current_time"
     version: "base"
   val_data_workers: 0
diff --git a/everyvoice/config/default/fastspeech2.yaml b/everyvoice/config/default/fastspeech2.yaml
index a309bec3..8ad0df37 100644
--- a/everyvoice/config/default/fastspeech2.yaml
+++ b/everyvoice/config/default/fastspeech2.yaml
@@ -102,7 +102,7 @@ training:
   filelist_loader: "everyvoice.utils.generic_dict_loader"
   logger:
     name: "BaseExperiment"
-    save_dir: "./logs"
+    save_dir: "./logs_and_checkpoints"
     sub_dir: "everyvoice.utils.get_current_time"
     version: "base"
   val_data_workers: 0
diff --git a/everyvoice/config/default/hifigan.yaml b/everyvoice/config/default/hifigan.yaml
index cc82d586..30ed591a 100644
--- a/everyvoice/config/default/hifigan.yaml
+++ b/everyvoice/config/default/hifigan.yaml
@@ -31,7 +31,7 @@ training:
   filelist_loader: "everyvoice.utils.generic_dict_loader"
   logger:
     name: "BaseExperiment"
-    save_dir: "./logs"
+    save_dir: "./logs_and_checkpoints"
     sub_dir: "everyvoice.utils.get_current_time"
     version: "base"
   val_data_workers: 0
diff --git a/everyvoice/config/default/istft.yaml b/everyvoice/config/default/istft.yaml
index 92c6a30c..38c2b264 100644
--- a/everyvoice/config/default/istft.yaml
+++ b/everyvoice/config/default/istft.yaml
@@ -31,7 +31,7 @@ training:
   filelist_loader: "everyvoice.utils.generic_dict_loader"
   logger:
     name: "Base-iSTFT-Experiment"
-    save_dir: "./logs"
+    save_dir: "./logs_and_checkpoints"
     sub_dir: "everyvoice.utils.get_current_time"
     version: "base"
   val_data_workers: 0
diff --git a/everyvoice/config/shared_types.py b/everyvoice/config/shared_types.py
index 603ff427..be2cca5f 100644
--- a/everyvoice/config/shared_types.py
+++ b/everyvoice/config/shared_types.py
@@ -99,7 +99,7 @@ def __init__(self, **data) -> None:
 
 class LoggerConfig(ConfigModel):
     name: str = "BaseExperiment"
-    save_dir: DirectoryPath = Path("./logs")
+    save_dir: DirectoryPath = Path("./logs_and_checkpoints")
     sub_dir: str = "everyvoice.utils.get_current_time"
     version: str = "base"
 
diff --git a/everyvoice/model/aligner/DeepForcedAligner b/everyvoice/model/aligner/DeepForcedAligner
index faf0e4f2..15dc2253 160000
--- a/everyvoice/model/aligner/DeepForcedAligner
+++ b/everyvoice/model/aligner/DeepForcedAligner
@@ -1 +1 @@
-Subproject commit faf0e4f25b99e065cb0b639f32cf946cad691440
+Subproject commit 15dc22534a534d7c7c092239ccec2a68880750a9
diff --git a/everyvoice/model/e2e/config/lj_training.yaml b/everyvoice/model/e2e/config/lj_training.yaml
index b27a5d67..1baad7dd 100644
--- a/everyvoice/model/e2e/config/lj_training.yaml
+++ b/everyvoice/model/e2e/config/lj_training.yaml
@@ -5,13 +5,13 @@ ckpt_epochs: 1
 max_epochs: 1000
 seed: 1234
 finetune_checkpoint: null
-vocoder_checkpoint: "./logs/LJ/base-vocoder/checkpoints/last.ckpt"
-feature_prediction_checkpoint: "./logs/LJ/fastspeech2-base/checkpoints/last.ckpt"
+vocoder_checkpoint: "./logs_and_checkpoints/LJ/base-vocoder/checkpoints/last.ckpt"
+feature_prediction_checkpoint: "./logs_and_checkpoints/LJ/fastspeech2-base/checkpoints/last.ckpt"
 filelist: "./preprocessed/LJ/processed_filelist.psv"
 filelist_loader: "everyvoice.utils.generic_dict_loader"
 logger:
   name: "LJ"
-  save_dir: "./logs"
+  save_dir: "./logs_and_checkpoints"
   sub_dir: "everyvoice.utils.get_current_time"
   version: "e2e"
 val_data_workers: 0
diff --git a/everyvoice/model/e2e/config/training.yaml b/everyvoice/model/e2e/config/training.yaml
index 2917d9cd..07107405 100644
--- a/everyvoice/model/e2e/config/training.yaml
+++ b/everyvoice/model/e2e/config/training.yaml
@@ -11,7 +11,7 @@ filelist: "./preprocessed/LJ/processed_filelist.psv"
 filelist_loader: "everyvoice.utils.generic_dict_loader"
 logger:
   name: "BaseExperiment"
-  save_dir: "./logs"
+  save_dir: "./logs_and_checkpoints"
   sub_dir: "everyvoice.utils.get_current_time"
   version: "e2e"
 val_data_workers: 0
diff --git a/everyvoice/model/feature_prediction/FastSpeech2_lightning b/everyvoice/model/feature_prediction/FastSpeech2_lightning
index 88c145dd..9d3797e6 160000
--- a/everyvoice/model/feature_prediction/FastSpeech2_lightning
+++ b/everyvoice/model/feature_prediction/FastSpeech2_lightning
@@ -1 +1 @@
-Subproject commit 88c145dd20681195a431cc1cda7f15bf6a738941
+Subproject commit 9d3797e652ebb20d839ff5e0f4a85e2f2d6e06f1
diff --git a/everyvoice/model/vocoder/HiFiGAN_iSTFT_lightning b/everyvoice/model/vocoder/HiFiGAN_iSTFT_lightning
index 10672a7f..aa81653a 160000
--- a/everyvoice/model/vocoder/HiFiGAN_iSTFT_lightning
+++ b/everyvoice/model/vocoder/HiFiGAN_iSTFT_lightning
@@ -1 +1 @@
-Subproject commit 10672a7f6d0bc476bb716835b43fb6f0a32ca4e2
+Subproject commit aa81653aa3ec07fd16de2e99ee729fdda9745989
diff --git a/everyvoice/tests/test_wizard.py b/everyvoice/tests/test_wizard.py
index e213c644..153f55e4 100755
--- a/everyvoice/tests/test_wizard.py
+++ b/everyvoice/tests/test_wizard.py
@@ -55,6 +55,9 @@ def test_config_format_effect(self):
             ]
             config_step.state["dataset_test"]["sox_effects"] = []
             config_step.effect()
+            self.assertTrue(
+                (Path(tmpdirname) / config_step.name / "logs_and_checkpoints").exists()
+            )
 
     def test_access_response(self):
         root_step = Step(
diff --git a/everyvoice/wizard/basic.py b/everyvoice/wizard/basic.py
index 028d9d27..c98f3973 100644
--- a/everyvoice/wizard/basic.py
+++ b/everyvoice/wizard/basic.py
@@ -97,7 +97,8 @@ def effect(self):
         config_dir = (output_path / "config").absolute()
         config_dir.mkdir(exist_ok=True, parents=True)
         # log dir
-        log_dir = (output_path / "logs").absolute()
+        log_dir = LoggerConfig().save_dir.stem
+        log_dir = (output_path / log_dir).absolute()
         log_dir.mkdir(parents=True, exist_ok=True)
         datasets = []
         # Text Configuration