From 658bc8f945459394d65e0d28e3d421f159284e27 Mon Sep 17 00:00:00 2001
From: Keith Bloemer <32459398+GuitarML@users.noreply.github.com>
Date: Fri, 29 Jan 2021 08:40:00 -0600
Subject: [PATCH 1/3] Update README.md
---
README.md | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 404375b..e7e2414 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,9 @@
Guitar plugin made with JUCE that uses neural network models to emulate real world hardware.
This plugin uses a LSTM model to recreate the sound of real amps and pedals. You can record
samples and train models from the plugin. Tone models are saved in .json format. Model training
-is accomplished using Tensorflow/Keras. The main improvement from the original SmartAmp is
-training takes less than five minutes on CPU (vs. GPU) for comparable sound quality. Training has
-also been integrated into the plugin.
+is accomplished using Tensorflow/Keras. The main improvement from the original SmartAmp is that
+training takes less than five minutes on CPU (vs. 8 hours on GPU) for comparable sound quality.
+Training has also been integrated into the plugin.
@@ -98,6 +98,9 @@ for the tone training to work.
Note: You can modify the train.py script to test different parameters, but it may produce undesired results in the plugin. Recommended to only
modify the number of epochs, learning rate, or the number of hidden units of the LSTM layer.
+See the GuitarLSTM repo for more information on how training works, and tips for creating sample recordings:
+https://github.com/GuitarML/GuitarLSTM
+
## Build Instructions
@@ -121,6 +124,11 @@ Dev Note: The above dependencies were chosen to facilitate rapid prototyping. It
Note: Make sure to build in Release mode unless actually debugging. Debug mode will not keep up with real time playing.
+
+**Colab Notebook**:
+Use Google Colab notebook (train_colab.ipynb) for training
+SmartAmpPro models in the cloud. See notebook comments for instructions.
+
## Future Work
This plugin is designed to showcase the speed at which the guitar models can be trained. Using models with larger
From 3b9698359eef3deb2a44b432304af037e2748630 Mon Sep 17 00:00:00 2001
From: Keith Bloemer <32459398+GuitarML@users.noreply.github.com>
Date: Fri, 29 Jan 2021 08:42:49 -0600
Subject: [PATCH 2/3] Update README.md
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index e7e2414..0000aa9 100644
--- a/README.md
+++ b/README.md
@@ -66,7 +66,7 @@ directory to the chosen location.
Note: The original SmartAmp/PedalNetRT .json files are not compatible with this plugin because it is a
different machine learning model. Only use tone files trained from SmartAmpPro.
-### Capturing .wav samples for model training:
+### "Start Capture" button:
1. Click the "Start Capture" button and enter a model name to save. Ensure this name contains no spaces.
2. After saving, the plugin will begin a 10 second coundown followed by a 3 minute recording session.
@@ -78,7 +78,7 @@ different machine learning model. Only use tone files trained from SmartAmpPro.
Note: The playing prompts such as "Play loud!" that appear while training are suggestions, and don't need to be
followed exactly to successfully train a model.
-### Training .json models from recorded .wav samples.
+### "Train Tone" button:
The Python dependencies from the ```requirements.txt``` file must be installed on your system (not a virtual env)
for the tone training to work.
From 88fb26a59eaee43cdeb07a761d16506e3ac63259 Mon Sep 17 00:00:00 2001
From: Keith Bloemer <32459398+GuitarML@users.noreply.github.com>
Date: Fri, 29 Jan 2021 08:45:23 -0600
Subject: [PATCH 3/3] Update README.md
---
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 0000aa9..9d0d27d 100644
--- a/README.md
+++ b/README.md
@@ -101,6 +101,10 @@ Note: You can modify the train.py script to test different parameters, but it ma
See the GuitarLSTM repo for more information on how training works, and tips for creating sample recordings:
https://github.com/GuitarML/GuitarLSTM
+**Colab Notebook**:
+Use Google Colab notebook (train_colab.ipynb) for training
+SmartAmpPro models in the cloud. See notebook comments for instructions.
+
## Build Instructions
@@ -125,10 +129,6 @@ Dev Note: The above dependencies were chosen to facilitate rapid prototyping. It
Note: Make sure to build in Release mode unless actually debugging. Debug mode will not keep up with real time playing.
-**Colab Notebook**:
-Use Google Colab notebook (train_colab.ipynb) for training
-SmartAmpPro models in the cloud. See notebook comments for instructions.
-
## Future Work
This plugin is designed to showcase the speed at which the guitar models can be trained. Using models with larger