commit 60c18dfe1e17cb51e33667b710b24b33c9a18140
parent baa37374e48f07810b9003692e28f898f68df5e7
Author: umhau <umhau@users.noreply.github.com>
Date: Thu, 27 Oct 2016 17:31:31 -0400
updated readme for new command syntax
Diffstat:
| M | README | | | 24 | ++++++++++++++++++++++-- |
1 file changed, 22 insertions(+), 2 deletions(-)
diff --git a/README b/README
@@ -75,6 +75,8 @@ To use vmc, it is necessary to provide a few perameters. These are:
- the model name
- the file containing the sentence list
- an integer called 'voice training iterations' (VTI)
+ - the location of an audio folder for importing
+ - the name of the corresponding sentence file to imported audio
The tool requests recordings of each sentence provided in the file. The user is
able to specify the number of times each sentence is used is making recordings
@@ -82,11 +84,27 @@ with the input perameter 'voice training iterations'. If the value is 0, no
voice samples will be requested, and the tool will to as much as it can without
them. Note for brevity's sake the variable is abbreviated VTI.
-Example usage:
+Also note there are three use cases - when audio is to be added in the course of
+running the script, when it is to be imported, and when I already have it and
+want to ignore it for the time being. The parameters system I used admittedly
+needs a lot of help. Learning as I go, all that. First program to use CLI
+parameters.
+
+Example usage, recording new audio:
$ cd ~/vmc
$ sudo bash vmc.sh new-voice-model ../Downloads/sentence-list.txt 2
+Example usage, importing previous audio:
+
+ $ cd ~/vmc
+ $ bash vmc.sh voice-model foo -1 old_audio_folder old_audio_sentences.txt
+
+Example usage, ignoring audio files:
+
+ $ cd ~/vmc
+ $ bash vmc.sh voice-model3 arctic_data.txt 0
+
Note that dependencies are not checked when running vmc.sh. To check
dependencies, see the section above.
@@ -104,5 +122,7 @@ voice model.
Non-association
-------------------------------------------------------------------------------
-This tool was not created in conjunction with the CMU Sphinx developers.
+This tool was not created in conjunction with the CMU Sphinx developers. Code
+was not reused except in the case of quick_lm.pl, in which case the original
+lisence was retained in the script.