From ead3dc32a3aca9826a8d603eb3b9cca33a2e6670 Mon Sep 17 00:00:00 2001 From: chenguoguo Date: Fri, 24 Mar 2017 10:29:07 -0700 Subject: [PATCH 1/4] Preparing v1.1.1 --- README.md | 72 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 44 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 05391255..c1260689 100644 --- a/README.md +++ b/README.md @@ -10,26 +10,55 @@ by [KITT.AI](http://kitt.ai). (The discussion group is new since September 2016 as we are getting many messages every day. Please send general questions there. For bugs, use Github issues.) -Version: 1.1.0 (9/20/2016) +Version: 1.1.1 (3/24/2017) -## New! - -### Alexa support +## Alexa support Snowboy now brings hands-free experience to the [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app) on Raspberry Pi! Here is how you can use other Snowboy models **Personal model** * Create your personal hotword model through our [website](https://snowboy.kitt.ai) or [hotword API](https://snowboy.kitt.ai/api/v1/train/) * Replace the hotword model in [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app) (after installation) with your personal model -* Set `APPLY_FRONTEND` to `false` in the [Alexa AVS sample app code](https://github.com/alexa/alexa-avs-sample-app/blob/master/samples/wakeWordAgent/src/KittAiSnowboyWakeWordEngine.cpp) and re-compile + + # Please replace YOUR_PERSONAL_MODEL.pmdl with the personal model you just + # created, and $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you + # cloned the Alexa AVS sample app repository. + cp YOUR_PERSONAL_MODEL.pmdl $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/ext/resources/alexa.umdl + +* Set `APPLY_FRONTEND` to `false` and update `SENSITIVITY` in the [Alexa AVS sample app code](https://github.com/alexa/alexa-avs-sample-app/blob/master/samples/wakeWordAgent/src/KittAiSnowboyWakeWordEngine.cpp) and re-compile + + # Please replace $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you + # cloned the Alexa AVS sample app repository. + cd $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/src/ + + # Modify KittAiSnowboyWakeWordEngine.cpp and update SENSITIVITY at line 28. + # Modify KittAiSnowboyWakeWordEngine.cpp and set APPLY_FRONTEND to false at + # line 30. + make + * Run the wake word agent with engine set to `kitt_ai`! **Universal model** * Replace the hotword model in [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app) (after installation) with your universal model + + # Please replace YOUR_UNIVERSAL_MODEL.umdl with the personal model you just + # created, and $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you + # cloned the Alexa AVS sample app repository. + cp YOUR_UNIVERSAL_MODEL.umdl $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/ext/resources/alexa.umdl + +* Update `SENSITIVITY` in the [Alexa AVS sample app code](https://github.com/alexa/alexa-avs-sample-app/blob/master/samples/wakeWordAgent/src/KittAiSnowboyWakeWordEngine.cpp) and re-compile + + # Please replace $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you + # cloned the Alexa AVS sample app repository. + cd $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/src/ + + # Modify KittAiSnowboyWakeWordEngine.cpp and update SENSITIVITY at line 28. + make + * Run the wake word agent with engine set to `kitt_ai`! -### Hotword as a Service +## Hotword as a Service Snowboy now offers **Hotword as a Service** through the ``https://snowboy.kitt.ai/api/v1/train/`` endpoint. Check out the [Full Documentation](http://docs.kitt.ai/snowboy) and example [Python/Bash script](examples/REST_API) (other language contributions are very welcome). @@ -141,12 +170,12 @@ dependencies like `fs`, `wav` or `node-record-lpcm16` depending on which script you use. ## Precompiled Binaries with Python Demo -* 64 bit Ubuntu [12.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1204-x86_64-1.1.0.tar.bz2) - / [14.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1404-x86_64-1.1.0.tar.bz2) -* [MacOS X](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/osx-x86_64-1.1.0.tar.bz2) +* 64 bit Ubuntu [12.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1204-x86_64-1.1.1.tar.bz2) + / [14.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1404-x86_64-1.1.1.tar.bz2) +* [MacOS X](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/osx-x86_64-1.1.1.tar.bz2) * Raspberry Pi with Raspbian 8.0, all versions - ([1/2/3/Zero](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/rpi-arm-raspbian-8.0-1.1.0.tar.bz2)) -* Intel Edison (Ubilinux based on Debian Wheezy 7.8) ([download](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/edison-ubilinux-1.1.0.tar.bz2)) + ([1/2/3/Zero](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/rpi-arm-raspbian-8.0-1.1.1.tar.bz2)) +* Intel Edison (Ubilinux based on Debian Wheezy 7.8) ([download](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/edison-ubilinux-1.1.1.tar.bz2)) If you want to compile a version against your own environment/language, read on. @@ -334,30 +363,17 @@ See [Full Documentation](http://docs.kitt.ai/snowboy). ## Change Log -**3/3/2017** +**v1.1.1, 3/24/2017** +* Added Android demo +* Added iOS demos * Added Samsung Artik support - -**2/27/2017** - * Added Go support - -**2/24/2017** - * Added Intel Edison support - -**2/21/2017** - * Added Pine64 support - -**2/9/2017** - * Added a more robust "Alexa" model (umdl) - -**9/28/2016** - * Offering Hotword as a Service through ``/api/v1/train`` endpoint. -* No version bump since decoder is not changed. +* Decoder is not changed. **v1.1.0, 9/20/2016** From 03d43870b310de4058d37f9ea44858a6f20028b8 Mon Sep 17 00:00:00 2001 From: chenguoguo Date: Fri, 24 Mar 2017 10:32:06 -0700 Subject: [PATCH 2/4] Fixed code block in README --- README.md | 50 +++++++++++++++++++++++++++++--------------------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index c1260689..452a7db3 100644 --- a/README.md +++ b/README.md @@ -20,40 +20,48 @@ Snowboy now brings hands-free experience to the [Alexa AVS sample app](https://g * Create your personal hotword model through our [website](https://snowboy.kitt.ai) or [hotword API](https://snowboy.kitt.ai/api/v1/train/) * Replace the hotword model in [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app) (after installation) with your personal model - # Please replace YOUR_PERSONAL_MODEL.pmdl with the personal model you just - # created, and $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you - # cloned the Alexa AVS sample app repository. - cp YOUR_PERSONAL_MODEL.pmdl $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/ext/resources/alexa.umdl +``` +# Please replace YOUR_PERSONAL_MODEL.pmdl with the personal model you just +# created, and $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you +# cloned the Alexa AVS sample app repository. +cp YOUR_PERSONAL_MODEL.pmdl $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/ext/resources/alexa.umdl +``` * Set `APPLY_FRONTEND` to `false` and update `SENSITIVITY` in the [Alexa AVS sample app code](https://github.com/alexa/alexa-avs-sample-app/blob/master/samples/wakeWordAgent/src/KittAiSnowboyWakeWordEngine.cpp) and re-compile - # Please replace $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you - # cloned the Alexa AVS sample app repository. - cd $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/src/ - - # Modify KittAiSnowboyWakeWordEngine.cpp and update SENSITIVITY at line 28. - # Modify KittAiSnowboyWakeWordEngine.cpp and set APPLY_FRONTEND to false at - # line 30. - make +``` +# Please replace $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you +# cloned the Alexa AVS sample app repository. +cd $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/src/ + +# Modify KittAiSnowboyWakeWordEngine.cpp and update SENSITIVITY at line 28. +# Modify KittAiSnowboyWakeWordEngine.cpp and set APPLY_FRONTEND to false at +# line 30. +make +``` * Run the wake word agent with engine set to `kitt_ai`! **Universal model** * Replace the hotword model in [Alexa AVS sample app](https://github.com/alexa/alexa-avs-sample-app) (after installation) with your universal model - # Please replace YOUR_UNIVERSAL_MODEL.umdl with the personal model you just - # created, and $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you - # cloned the Alexa AVS sample app repository. - cp YOUR_UNIVERSAL_MODEL.umdl $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/ext/resources/alexa.umdl +``` +# Please replace YOUR_UNIVERSAL_MODEL.umdl with the personal model you just +# created, and $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you +# cloned the Alexa AVS sample app repository. +cp YOUR_UNIVERSAL_MODEL.umdl $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/ext/resources/alexa.umdl +``` * Update `SENSITIVITY` in the [Alexa AVS sample app code](https://github.com/alexa/alexa-avs-sample-app/blob/master/samples/wakeWordAgent/src/KittAiSnowboyWakeWordEngine.cpp) and re-compile - # Please replace $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you - # cloned the Alexa AVS sample app repository. - cd $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/src/ +``` +# Please replace $ALEXA_AVS_SAMPLE_APP_PATH with the actual path where you +# cloned the Alexa AVS sample app repository. +cd $ALEXA_AVS_SAMPLE_APP_PATH/samples/wakeWordAgent/src/ - # Modify KittAiSnowboyWakeWordEngine.cpp and update SENSITIVITY at line 28. - make +# Modify KittAiSnowboyWakeWordEngine.cpp and update SENSITIVITY at line 28. +make +``` * Run the wake word agent with engine set to `kitt_ai`! From 499906173d89042504d533b2223188f661e871ba Mon Sep 17 00:00:00 2001 From: chenguoguo Date: Fri, 24 Mar 2017 10:43:10 -0700 Subject: [PATCH 3/4] Bumped node version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 2c7ffb68..1b760296 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "snowboy", - "version": "1.1.0", + "version": "1.1.1", "description": "Snowboy is a customizable hotword detection engine", "main": "lib/node/index.js", "binary": { From 8d255425e367f0c50c7480355e3fc9aede3d77b1 Mon Sep 17 00:00:00 2001 From: chenguoguo Date: Fri, 24 Mar 2017 11:20:15 -0700 Subject: [PATCH 4/4] Added Pine64 download link --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 452a7db3..0fe632f9 100644 --- a/README.md +++ b/README.md @@ -183,6 +183,7 @@ you use. * [MacOS X](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/osx-x86_64-1.1.1.tar.bz2) * Raspberry Pi with Raspbian 8.0, all versions ([1/2/3/Zero](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/rpi-arm-raspbian-8.0-1.1.1.tar.bz2)) +* Pine64 (Debian Jessie 8.5 (3.10.102)) ([download](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/pine64-debian-jessie-1.1.1.tar.bz2)) * Intel Edison (Ubilinux based on Debian Wheezy 7.8) ([download](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/edison-ubilinux-1.1.1.tar.bz2)) If you want to compile a version against your own environment/language, read on.