Re-structured the model path

Author: chenguoguo

README.md

@@ -163,11 +163,10 @@ environment.
 
 Here is the list of the models, and the parameters that you have to use for them:
 
-* **resources/snowboy.umdl**: Universal model for the hotword "Snowboy". Set
-SetSensitivity to 0.5 for better performance.
-* **resources/alexa/alexa-avs-sample-app/alexa.umdl**: Universal model for the hotword "Alexa" optimized for [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app).
-Set SetSensitivity to 0.6, and set ApplyFrontend to true. This is so far the best "Alexa" model we released publicly, when ApplyFrontend is set to true.
-* **resources/models/jarvis.umdl**: Universal model for the hotword "Jarvis" (https://snowboy.kitt.ai/hotword/29). It has two different models for the hotword Jarvis, so you have to use two sensitivites. The suggested sensitivities are "0.8,0.80". Please also set ApplyFrontend to true.
+* **resources/alexa/alexa-avs-sample-app/alexa.umdl**: Universal model for the hotword "Alexa" optimized for [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app). Set SetSensitivity to 0.6, and set ApplyFrontend to true. This is so far the best "Alexa" model we released publicly, when ApplyFrontend is set to true.
+* **resources/models/snowboy.umdl**: Universal model for the hotword "Snowboy". Set SetSensitivity to 0.5 and ApplyFrontend to false.
+* **resources/models/jarvis.umdl**: Universal model for the hotword "Jarvis" (https://snowboy.kitt.ai/hotword/29). It has two different models for the hotword Jarvis, so you have to use two sensitivites. Set sensitivities to "0.8,0.80" and ApplyFrontend to true.
+* **resources/models/smart_mirror.umdl**: Universal model for the hotword "Smart Mirror" (https://snowboy.kitt.ai/hotword/47). Set sensitivity to Sensitivity to 0.5.
 
 ## Precompiled node module
 
@@ -375,11 +374,13 @@ See [Full Documentation](http://docs.kitt.ai/snowboy).
 
 ## Change Log
 
-**v1.3.0, 2/14/2018**
+**v1.3.0, 2/19/2018**
 
-* Added Frontend processing
+* Added Frontend processing for all platforms
 * Added `resources/smart_mirror.umdl` for https://snowboy.kitt.ai/hotword/47
 * Added `resources/jarvis.umdl` for https://snowboy.kitt.ai/hotword/29
+* Cleaned up the supported platforms
+* Re-structured the model path
 
 **v1.2.0, 3/25/2017**
 

examples/C++/demo.cc

@@ -200,10 +200,11 @@ int main(int argc, char* argv[]) {
   // Parameter section.
   // If you have multiple hotword models (e.g., 2), you should set
   // <model_filename> and <sensitivity_str> as follows:
-  //   model_filename = "resources/snowboy.umdl,resources/alexa.pmdl";
-  //   sensitivity_str = "0.4,0.4";
+  //   model_filename =
+  //     "resources/models/snowboy.umdl,resources/models/smart_mirror.umdl";
+  //   sensitivity_str = "0.5,0.5";
   std::string resource_filename = "resources/common.res";
-  std::string model_filename = "resources/snowboy.umdl";
+  std::string model_filename = "resources/models/snowboy.umdl";
   std::string sensitivity_str = "0.5";
   float audio_gain = 1;
 

examples/C++/demo2.cc

@@ -3,7 +3,7 @@
 #include "portaudio.h"
 
 #define resource_filename "resources/common.res"
-#define model_filename "resources/snowboy.umdl"
+#define model_filename "resources/models/snowboy.umdl"
 #define sensitivity_str "0.5"
 
 struct wavHeader { //44 byte HEADER only

examples/C/demo.c

@@ -183,10 +183,11 @@ int main(int argc, char* argv[]) {
   // Parameter section.
   // If you have multiple hotword models (e.g., 2), you should set
   // <model_filename> and <sensitivity_str> as follows:
-  //   model_filename = "resources/snowboy.umdl,resources/alexa.pmdl";
-  //   sensitivity_str = "0.4,0.4";
+  //   model_filename =
+  //     "resources/models/snowboy.umdl,resources/models/smart_mirror.umdl";
+  //   sensitivity_str = "0.5,0.5";
   const char resource_filename[] = "resources/common.res";
-  const char model_filename[] = "resources/snowboy.umdl";
+  const char model_filename[] = "resources/models/snowboy.umdl";
   const char sensitivity_str[] = "0.5";
   float audio_gain = 1;
 

examples/Go/detect/readme.md

@@ -22,7 +22,7 @@ go build -o snowboy main.go
 
 ### Examples
 Cmd:
-`./snowboy ../../../resources/snowboy.umdl ../../../resources/snowboy.wav`
+`./snowboy ../../../resources/models/snowboy.umdl ../../../resources/snowboy.wav`
 
 Output:
 ```
@@ -37,4 +37,4 @@ Output:
 ```
 Snowboy detecting keyword in ../../resources/snowboy.wav
 Snowboy detected nothing
-```
+```

examples/Go/listen/README.md

@@ -23,7 +23,7 @@ go build -o listen main.go
 
 ### Examples
 Cmd:
-`./listen ../../../resources/common.res ../../../resources/snowboy.umdl`
+`./listen ../../../resources/common.res ../../../resources/models/snowboy.umdl`
 
 Output:
 ```

examples/Java/Demo.java

@@ -21,7 +21,7 @@ public static void main(String[] args) {
 
     // Sets up Snowboy.
     SnowboyDetect detector = new SnowboyDetect("resources/common.res",
-                                               "resources/snowboy.umdl");
+                                               "resources/models/snowboy.umdl");
     detector.SetSensitivity("0.5");
     detector.SetAudioGain(1);
 

examples/Node/file.js

@@ -6,7 +6,7 @@ const Models = require('../../').Models;
 const models = new Models();
 
 models.add({
-  file: 'resources/snowboy.umdl',
+  file: 'resources/models/snowboy.umdl',
   sensitivity: '0.5',
   hotwords : 'snowboy'
 });

examples/Node/microphone.js

@@ -5,7 +5,7 @@ const Models = require('../../').Models;
 const models = new Models();
 
 models.add({
-  file: 'resources/snowboy.umdl',
+  file: 'resources/models/snowboy.umdl',
   sensitivity: '0.5',
   hotwords : 'snowboy'
 });

examples/Perl/snowboy_googlevoice.pl

@@ -3,9 +3,9 @@
 # This script first uses Snowboy to wake up, then collects audio and sends to
 # Google Speech API for further recognition. It works with both personal and
 # universal models. By default, it uses the Snowboy universal model at
-# resources/snowboy.umdl, you can change it to other universal models, or your
-# own personal models. You also have to provide your Google API key in order to
-# use it.
+# resources/models/snowboy.umdl, you can change it to other universal models, or
+# your own personal models. You also have to provide your Google API key in
+# order to use it.
 
 use Snowboy;
 
@@ -23,16 +23,16 @@
 This script first uses Snowboy to wake up, then collects audio and sends to
 Google Speech API for further recognition. It works with both personal and
 universal models. By default, it uses the Snowboy universal model at
-resources/snowboy.umdl, you can change it to other universal models, or your own
-personal models. You also have to provide your Google API key in order to use
-it.
+resources/models/snowboy.umdl, you can change it to other universal models, or
+your own personal models. You also have to provide your Google API key in order
+to use it.
 
 Note: Google is now moving to Google Cloud Speech API, so we will have to update
       the API query later.
 
 Usage: ./snowboy_googlevoice.pl <Google_API_Key> [Hotword_Model]
  e.g.: ./snowboy_googlevoice.pl \
-           abcdefghijklmnopqrstuvwxyzABC0123456789 resources/snowboy.umdl
+           abcdefghijklmnopqrstuvwxyzABC0123456789 resources/models/snowboy.umdl
 
 Allowed options:
   --language    : Language for speech recognizer.   (string, default="en")
@@ -48,9 +48,9 @@
 
 # Gets parameters.
 my $api_key = shift @ARGV;
-my $model = shift @ARGV || 'resources/snowboy.umdl';
+my $model = shift @ARGV || 'resources/models/snowboy.umdl';
 
-if ($model eq 'resources/snowboy.umdl') {
+if ($model eq 'resources/models/snowboy.umdl') {
   $hotword = "Snowboy";
 } else {
   $hotword = "your hotword";

examples/Perl/snowboy_unit_test.pl

@@ -12,7 +12,7 @@
 close WAV;
 
 $sb = new Snowboy::SnowboyDetect('resources/common.res',
-                                 'resources/snowboy.umdl');
+                                 'resources/models/snowboy.umdl');
 
 $sb->SetSensitivity ("0.5");
 $sb->SetAudioGain (1);

examples/Python/demo3.py

@@ -4,11 +4,11 @@
 
 # Demo code for detecting hotword in a .wav file
 # Example Usage:
-#  $ python demo3.py resources/snowboy.wav resources/snowboy.umdl
+#  $ python demo3.py resources/snowboy.wav resources/models/snowboy.umdl
 # Should print:
 #  Hotword Detected!
 #
-#  $ python demo3.py resources/ding.wav resources/snowboy.umdl
+#  $ python demo3.py resources/ding.wav resources/models/snowboy.umdl
 # Should print:
 #  Hotword Not Detected!
 

examples/Python3/demo3.py

@@ -4,11 +4,11 @@
 
 # Demo code for detecting hotword in a .wav file
 # Example Usage:
-#  $ python demo3.py resources/snowboy.wav resources/snowboy.umdl
+#  $ python demo3.py resources/snowboy.wav resources/models/snowboy.umdl
 # Should print:
 #  Hotword Detected!
 #
-#  $ python demo3.py resources/ding.wav resources/snowboy.umdl
+#  $ python demo3.py resources/ding.wav resources/models/snowboy.umdl
 # Should print:
 #  Hotword Not Detected!