changed name to tcae

README.md

@@ -1,31 +1,59 @@
-# Timbre Conditioned (Variational) Auto Encoder
-
-## Training
+# Timbre Conditioned Auto Encoder
 
 TBD
 
-## Dataset
+## Data Preparation
 
 TBD
 
+## Training
+
+Use a `LocalConfig` instance to control architecture and training parameters
+
+```python
+from tcae import localconfig, train
+
+conf = localconfig.LocalConfig()
+
+conf.batch_size = 8
+
+conf.simple_encoder = True
+conf.simple_decoder = True
+
+conf.mt_outputs["mag_env"]["enabled"] = True
+conf.mt_outputs["h_freq_shifts"]["enabled"] = True
+conf.mt_outputs["f0_shifts"]["enabled"] = True
+conf.mt_outputs["h_mag_dist"]["enabled"] = True
+conf.mt_outputs["h_phase_diff"]["enabled"] = False
+
+conf.save_config()
+
+train.train(conf)
+```
+
 ## Sound Generator
 
-Get audio prediction
+Deploy a trained model as a `SoundGenerator`
 
 ```python
 from sound_generator import SoundGenerator
 
 
 sg = SoundGenerator()
 
+sg.config_path = "/path/to/config"
+sg.checkpoint_path = "/path/to/checkpoint.h5"
+
 success, audio = sg.get_prediction({
     "input_pitch": 40,
     "pitch": 40,
     "velocity": 100,
     # A list of sg.conf.num_measures values between 0 and 1
     "heuristic_measures": [0.1] * sg.conf.num_measures,
     # A list of sg.conf.latent_dim values between 0 and 1
-    "latent_sample": [0.5] * sg.conf.latent_dim
+    "latent_sample": [0.5] * sg.conf.latent_dim,
+    # A list of words describing timbre qualities
+    "qualities": ["dark", "soft"]
 })
 
 ```
@@ -40,6 +68,8 @@ Required keys in the input dictionary:
 
 **latent_sample**: Values for z input to decoder
 
+**qualities**: Timbre qualities from use speech, used to find initial heuristic configurations
+
 **heuristic_measures**: List of values for following measures used in decoder in the sequence shown:
 ```python
 ['inharmonicity',

SOUND_GENERATOR.md

@@ -4,19 +4,17 @@ Requires python >= 3.6
 
 Clone repository
 
-`git clone https://github.com/TheSoundOfAIOSR/rg_sound_generation.git`
-
-Go to the right directory
-
-`cd rg_sound_generation\timbre_conditioned_vae`
+```
+git clone https://github.com/TheSoundOfAIOSR/rg_sound_generation.git
+cd rg_sound_generation
+```
 
 Create virtual environment
 
-`python -m venv env`
-
-Activate the environment
-
-`env\Scripts\activate`
+```
+python -m venv env
+env\Scripts\activate
+```
 
 Install required packages
 

heuristic_analysis.ipynb

@@ -11,7 +11,7 @@
     "import matplotlib.pyplot as plt\n",
     "import pandas as pd\n",
     "import numpy as np\n",
-    "from tcvae.compute_measures import heuristic_names\n",
+    "from tcae.compute_measures import heuristic_names\n",
     "\n",
     "plt.style.use(\"dark_background\")"
    ]

predict.ipynb

@@ -34,8 +34,8 @@
     "import numpy as np\n",
     "import soundfile as sf\n",
     "import tsms\n",
-    "from tcvae import dataset, localconfig, model, train\n",
-    "from tcvae.compute_measures import heuristic_names\n",
+    "from tcae import dataset, localconfig, model, train\n",
+    "from tcae.compute_measures import heuristic_names\n",
     "from IPython.display import Audio"
    ]
   },

predict.py

@@ -1,6 +1,6 @@
 import os
 os.environ["CUDA_VISIBLE_DEVICES"] = "-1"
-from tcvae import predict, dataset, localconfig
+from tcae import predict, dataset, localconfig
 from matplotlib import pyplot as plt
 
 conf = localconfig.LocalConfig()

sound_generator.py

@@ -7,8 +7,8 @@
 from pprint import pprint
 import warnings
 from typing import Dict, Any
-from tcvae import model, localconfig, train
-from tcvae.compute_measures import heuristic_names
+from tcae import model, localconfig, train
+from tcae.compute_measures import heuristic_names
 
 
 warnings.simplefilter("ignore")

train_from_cli.py

@@ -1,4 +1,4 @@
-from tcvae import localconfig, train
+from tcae import localconfig, train
 
 
 if __name__ == "__main__":

train_on_colab.ipynb

@@ -105,7 +105,7 @@
    },
    "source": [
     "import json\n",
-    "from tcvae import localconfig, train\n",
+    "from tcae import localconfig, train\n",
     "\n",
     "data_handler_type = \"data_handler\"\n",
     "conf = localconfig.LocalConfig(data_handler_type)"