-
Notifications
You must be signed in to change notification settings - Fork 175
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(docs) Updated README for convergence.
- Loading branch information
Showing
2 changed files
with
115 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,122 +1,112 @@ | ||
| JuliusJS | ||
| ==== | ||
|
|
||
| > A speech recognition library for the web | ||
| ### This is in progress and not fully implemented! | ||
|
|
||
| - You may need to read the code to use it in its current state | ||
| - The README documents eventual behavior, and is not currently accurate | ||
| - Emscripted code is not yet committed - you'll need to run `emscripten.sh` | ||
| - After running the script, a use example can be found in `js/index.html` | ||
| - This project is in active development - expect __frequent breaking changes__ | ||
|
|
||
| --- | ||
|
|
||
| JuliusJS is an opinionated port of Julius to JavaScript. <br> | ||
| It __actively listens to the user to transcribe what they are saying__ through a callback. | ||
|
|
||
| ```js | ||
| // bootstrap JuliusJS | ||
| var julius = new Julius(); | ||
|
|
||
| julius.onrecognition = function(sentence) { | ||
| console.log(sentence); | ||
| }; | ||
|
|
||
| // say "Hello, world!" | ||
| // console logs: `> HELLO WORLD` | ||
| ``` | ||
|
|
||
| ###### Features: | ||
|
|
||
| - Real-time transcription | ||
| - Use the provided grammar, or write your own | ||
| - 100% JavaScript implementation | ||
| - All recognition is done in-browser through a `Worker` | ||
| - Familiar event-inspired API | ||
| - No external server calls | ||
|
|
||
| ## Quickstart | ||
|
|
||
| ##### Using Express 4.0 | ||
|
|
||
| 1. Grab the latest version with bower | ||
| - `bower install juliusjs --save` | ||
| 1. Include `julius.js` in your html | ||
| - `<script src="julius.js"></script>` | ||
| 1. Make the scripts available to the client through your server | ||
| ```js | ||
| var express = require('express'), | ||
| app = express(); | ||
|
|
||
| app.use(express.static('path/to/dist')); | ||
| ``` | ||
| 1. In your main script, bootstrap JuliusJS and register an event listener for recognition events | ||
| ```js | ||
| // bootstrap JuliusJS | ||
| var julius = new Julius(); | ||
|
|
||
| // register listener | ||
| julius.onrecognition = function(sentence) { | ||
| // ... | ||
| console.log(sentence); | ||
| }; | ||
| ``` | ||
|
|
||
| - Your site now has real-time speech recognition baked in! | ||
|
|
||
| ### Configure your own recognition grammar | ||
|
|
||
| In order for JuliusJS to use it, your grammar must follow the [Julius grammar specification](http://julius.sourceforge.jp/en_index.php?q=en_grammar.html). The site includes a tutorial on writing grammars.<br> | ||
| By default, phonemes are defined in `bin/hmmdefs`, though you might find [other sites](http://www.boardman.k12.oh.us/bdms/phonological/44Phonemes.pdf) more useful as reference. | ||
|
|
||
| - Building your own grammar requires the `mkdfa.pl` script and associated binaries, distributed with Julius. | ||
| - _On Mac OS X_ | ||
| - Use `./bin/mkdfa.pl`, included with this repo | ||
| - _On other OS_ | ||
| - Run `emscripten.sh` to populate `bin` with the necessary files | ||
|
|
||
| 1. Write a `yourGrammar.voca` file with words to be recognized | ||
| - The `.voca` file defines "word candidates" and their pronunciations. | ||
| 1. Write a `yourGrammar.grammar` file with phrases composed of those words | ||
| - The `.grammar` file defines "category-level syntax, i.e. allowed connection of words by their category name." | ||
| 1. Compile the grammar using `./bin/mkdfa.pl yourGrammar` | ||
| - The `.voca` and `.grammar` must be prefixed with the same name | ||
| - This will generate `yourGrammar.dfa` and `yourGrammar.dict` | ||
| 1. Give the new `.dfa` and `.dict` files to the `Julius` constructor | ||
|
|
||
| ```js | ||
| // when bootstrapping JuliusJS | ||
| var julius = new Julius('path/to/dfa', 'path/to/dict'); | ||
| ``` | ||
|
|
||
| ## Motivation | ||
|
|
||
| ## Advanced Use | ||
|
|
||
| ### Configuring the engine | ||
|
|
||
| ### Build from source | ||
|
|
||
| ## Developers | ||
|
|
||
| #### Emscripten | ||
|
|
||
| ### Implementation goals | ||
|
|
||
| ### Contributing | ||
|
|
||
| - Contributions are welcome! See `CONTRIBUTING.md` for guidelines. | ||
|
|
||
|
|
||
| ## In the wild | ||
|
|
||
| _If you use `JuliusJS` let me know, and I'll add your project to this list._ | ||
|
|
||
| 1. Coming soon... | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| *JuliusJS is a port of the "Large Vocabulary Continuous Speech Recognition Engine Julius" to JavaScript* | ||
| JuliusJS | ||
| ==== | ||
|
|
||
| > A speech recognition library for the web | ||
| JuliusJS is an opinionated port of Julius to JavaScript. <br> | ||
| It __actively listens to the user to transcribe what they are saying__ through a callback. | ||
|
|
||
| ```js | ||
| // bootstrap JuliusJS | ||
| var julius = new Julius(); | ||
|
|
||
| julius.onrecognition = function(sentence) { | ||
| console.log(sentence); | ||
| }; | ||
|
|
||
| // say "Hello, world!" | ||
| // console logs: `> HELLO WORLD` | ||
| ``` | ||
|
|
||
| ###### Features: | ||
|
|
||
| - Real-time transcription | ||
| - Use the provided grammar, or write your own | ||
| - 100% JavaScript implementation | ||
| - All recognition is done in-browser through a `Worker` | ||
| - Familiar event-inspired API | ||
| - No external server calls | ||
|
|
||
| ## Quickstart | ||
|
|
||
| ##### Using Express 4.0 | ||
|
|
||
| 1. Grab the latest version with bower | ||
| - `bower install juliusjs --save` | ||
| 1. Include `julius.js` in your html | ||
| - `<script src="julius.js"></script>` | ||
| 1. Make the scripts available to the client through your server | ||
| ```js | ||
| var express = require('express'), | ||
| app = express(); | ||
|
|
||
| app.use(express.static('path/to/dist')); | ||
| ``` | ||
| 1. In your main script, bootstrap JuliusJS and register an event listener for recognition events | ||
| ```js | ||
| // bootstrap JuliusJS | ||
| var julius = new Julius(); | ||
|
|
||
| // register listener | ||
| julius.onrecognition = function(sentence) { | ||
| // ... | ||
| console.log(sentence); | ||
| }; | ||
| ``` | ||
|
|
||
| - Your site now has real-time speech recognition baked in! | ||
|
|
||
| ### Configure your own recognition grammar | ||
|
|
||
| In order for JuliusJS to use it, your grammar must follow the [Julius grammar specification](http://julius.sourceforge.jp/en_index.php?q=en_grammar.html). The site includes a tutorial on writing grammars.<br> | ||
| By default, phonemes are defined in `bin/hmmdefs`, though you might find [other sites](http://www.boardman.k12.oh.us/bdms/phonological/44Phonemes.pdf) more useful as reference. | ||
|
|
||
| - Building your own grammar requires the `mkdfa.pl` script and associated binaries, distributed with Julius. | ||
| - _On Mac OS X_ | ||
| - Use `./bin/mkdfa.pl`, included with this repo | ||
| - _On other OS_ | ||
| - Run `emscripten.sh` to populate `bin` with the necessary files | ||
|
|
||
| 1. Write a `yourGrammar.voca` file with words to be recognized | ||
| - The `.voca` file defines "word candidates" and their pronunciations. | ||
| 1. Write a `yourGrammar.grammar` file with phrases composed of those words | ||
| - The `.grammar` file defines "category-level syntax, i.e. allowed connection of words by their category name." | ||
| 1. Compile the grammar using `./bin/mkdfa.pl yourGrammar` | ||
| - The `.voca` and `.grammar` must be prefixed with the same name | ||
| - This will generate `yourGrammar.dfa` and `yourGrammar.dict` | ||
| 1. Give the new `.dfa` and `.dict` files to the `Julius` constructor | ||
|
|
||
| ```js | ||
| // when bootstrapping JuliusJS | ||
| var julius = new Julius('path/to/dfa', 'path/to/dict'); | ||
| ``` | ||
|
|
||
| ## Motivation | ||
|
|
||
| ## Advanced Use | ||
|
|
||
| ### Configuring the engine | ||
|
|
||
| ### Build from source | ||
|
|
||
| ## Developers | ||
|
|
||
| #### Emscripten | ||
|
|
||
| ### Implementation goals | ||
|
|
||
| ### Contributing | ||
|
|
||
| - Contributions are welcome! See `CONTRIBUTING.md` for guidelines. | ||
|
|
||
|
|
||
| ## In the wild | ||
|
|
||
| _If you use `JuliusJS` let me know, and I'll add your project to this list._ | ||
|
|
||
| 1. Coming soon... | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| *JuliusJS is a port of the "Large Vocabulary Continuous Speech Recognition Engine Julius" to JavaScript* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters