expanded the examples

waikato-llm · Jun 4, 2024 · 307f4d2 · 307f4d2
1 parent c3c1410
commit 307f4d2
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 3 deletions.
diff --git a/docs/img/LJ001-0001-mel.png b/docs/img/LJ001-0001-mel.png
diff --git a/docs/img/LJ001-0001-mfcc.png b/docs/img/LJ001-0001-mfcc.png
diff --git a/docs/img/LJ001-0001-stft.png b/docs/img/LJ001-0001-stft.png
diff --git a/docs/visualization.md b/docs/visualization.md
@@ -4,6 +4,61 @@ Requires the [audio-dataset-converter-visualization](https://github.com/waikato-
 
 # Plugins
 
-* `to-mel-spectrogram` - outputs Mel spectrogram images
-* `to-mfcc-spectrogram` - outputs Mel-frequency cepstral coefficients images
-* `to-stft-spectrogram` - outputs short time fourier transform (STFT) spectrogram images
+For the following examples, data from the [LJ Speech Dataset](https://keithito.com/LJ-Speech-Dataset/) was used.
+
+
+## Mel spectrogram
+
+`to-mel-spectrogram` - outputs Mel spectrogram images
+
+```bash
+adc-convert \
+  -l INFO \
+    from-data \
+      -l INFO \
+      -i "./input/*.wav" \
+      -t sp \
+    to-mel-spectrogram \
+      -l INFO \
+      -o ./output
+```
+
+![Mel spectrogram example plot](img/LJ001-0001-mel.png)
+
+
+## MFCC spectrogram
+
+`to-mfcc-spectrogram` - outputs Mel-frequency cepstral coefficients images
+
+```bash
+adc-convert \
+  -l INFO \
+    from-data \
+      -l INFO \
+      -i "./input/*.wav" \
+      -t sp \
+    to-mfcc-spectrogram \
+      -l INFO \
+      -o ./output
+```
+
+![MFCC spectrogram example plot](img/LJ001-0001-mfcc.png)
+
+
+## STFT spectrogram
+
+`to-stft-spectrogram` - outputs short time fourier transform (STFT) spectrogram images
+
+```bash
+adc-convert \
+  -l INFO \
+    from-data \
+      -l INFO \
+      -i "./input/*.wav" \
+      -t sp \
+    to-stft-spectrogram \
+      -l INFO \
+      -o ./output
+```
+
+![STFT spectrogram example plot](img/LJ001-0001-stft.png)