Skip to content

Commit

Permalink
v1.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
xuchen committed May 24, 2016
1 parent a5d4df1 commit f761bb1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/lib/libsnowboy-detect.a
snowboy-detect-swig.cc
snowboydetect.py
.DS_Store

*.pyc
*.o
Expand Down
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ by [KITT.AI](http://kitt.ai).
[Full Documentation](https://snowboy.kitt.ai/docs)


Version: 1.0.1 (5/16/2016)
Version: 1.0.2 (5/24/2016)

Snowboy is a customizable hotword detection engine for you to create your own
hotword like "OK Google" or "Alexa". It is powered by deep neural networks and has the following properties:
Expand All @@ -32,11 +32,11 @@ It ships in the form of a **C library** with **Python** wrappers generated by SW
If you want support on other hardware/OS, please send your request to [[email protected]](mailto:snowboy.kitt.ai)

## Precompiled Binaries
* 64 bit Ubuntu [12.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1204-x86_64-1.0.1.tar.bz2)
/ [14.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1404-x86_64-1.0.1.tar.bz2)
* [MacOS X](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/osx-x86_64-1.0.1.tar.bz2)
* 64 bit Ubuntu [12.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1204-x86_64-1.0.2.tar.bz2)
/ [14.04](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/ubuntu1404-x86_64-1.0.2.tar.bz2)
* [MacOS X](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/osx-x86_64-1.0.2.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.0.1.tar.bz2))
([1/2/3/Zero](https://s3-us-west-2.amazonaws.com/snowboy/snowboy-releases/rpi-arm-raspbian-8.0-1.0.2.tar.bz2))

If you want to compile a version against your own environment/language, read on.

Expand Down Expand Up @@ -76,17 +76,17 @@ If you need extra setup on your audio (especially on a Raspberry Pi), please see

## Compile a Python Wrapper

cd swig/python
cd swig/Python
make

SWIG will generate a `_snowboydetect.so` file and a simple (but hard-to-read) python wrapper `snowboydetect.py`. We have provided a higher level python wrapper `snowboydecoder.py` on top of that.

Feel free to adapt the `Makefile` in `swig/python` to your own system's setting if you cannot `make` it.
Feel free to adapt the `Makefile` in `swig/Python` to your own system's setting if you cannot `make` it.


## Quick Start

Go to the `swig/python` folder and open your python console:
Go to the `examples/Python` folder and open your python console:

In [1]: import snowboydecoder

Expand Down Expand Up @@ -120,11 +120,16 @@ See [Full Documentation](https://snowboy.kitt.ai/docs).

## Change Log

**v1.0.2, 5/24/2016**

* Updated universal `snowboy.umdl` model
* added C++ examples, docs will come in next release.

**v1.0.1, 5/16/2016**

* VAD now returns -2 on silence, -1 on error, 0 on voice and >0 on triggered models
* added static library for Raspberry Pi in case people want to compile themselves instead of using the binary version

**v1.0.0, 5/10/2016**

* initial release
* initial release

0 comments on commit f761bb1

Please sign in to comment.