commit 6ae571f4d854b39ff89f6c3c6feeaa6015a078ff
parent fc0c070f4f428296a5c2c62c30a24a8d3571a7ea
Author: umhau <umhau@users.noreply.github.com>
Date: Tue, 1 Nov 2016 17:48:12 -0400
Delete README
Diffstat:
| D | README | | | 129 | ------------------------------------------------------------------------------- |
1 file changed, 0 insertions(+), 129 deletions(-)
diff --git a/README b/README
@@ -1,129 +0,0 @@
-Voice model creator for CMU Sphinx
-===============================================================================
-
-This tool contains basic tools for creating a custom domain voice model for use
-with the PocketSphinx decoder. It is also possible to use the voice models
-created by this tool as the basis for a test-to-speech engine.
-
-Note this tool has only been tested with Linux Mint 17.3 & 18.
-
-**Please see the LICENSE file for terms of use.**
-
-Linux/Unix installation
--------------------------------------------------------------------------------
-
-vmc is generally run from within its top-level folder, and the voice model it
-creates is generated within that folder. i.e.:
-
- $ ~/vmc
- $ ~/vmc/new-voice-model
-
-two of the vmc dependencies, sphinxbase and sphinxtrain, are compiled in a
-location of the user's choice. To install the vmc dependencies with the
-provided script, this location must be provided. It is assumed that the
-location is a direct subdirectory of the user's home directory:
-
- $ mkdir ~/tools
-
-To install vmc's dependencies, run:
-
- $ sudo bash install.sh [install location]
-
-For example:
-
- $ sudo bash install.sh tools
-
-Full installation on an AMD64 computer running Mint 18 would look like this:
-
- $ cd ~/
- $ git clone https://github.com/umhau/vmc.git
- $ mkdir tools
- $ cd vmc
- $ sudo bash install.sh tools
-
-See use examples in the next section.
-
-Usage instructions
--------------------------------------------------------------------------------
-
-This tools brings together a number of disparate data files that are needed for
-creating a voice model. This graph illustrates the data process involved:
-
- word domain
- +
- |
- v
- +-------+ sentence list+----------+
- | + |
- | | |
- v v v
- dictionary grammar: LM voice samples
- + + +
- | | |
- | v |
- +--------> voice model <----------+
- training
- +
- |
- v
- voice model
-
-Each of these steps, starting with the sentence list (given) and ending with the
-voice model are contained within this tool.
-
-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
-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.
-
-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.
-
-If VTI is > 0, the user will be prompted to read each entry in the
-sentence list.
-
-The output of the command will be found at:
-
- $ ~/vmc/new-voice-model
-
-This folder will contain all necessary files to run PocketSphinx with a custom
-voice model.
-
-
-Non-association
--------------------------------------------------------------------------------
-
-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.
-