Overload constructor of recognizer, maximal debug configuration

.gitignore

@@ -7,4 +7,3 @@ libarchive
 clapack-wasm
 openfst
 emsdk
-devel/index.html

devel/BrowserRecognizer.worker.js

@@ -1 +1,163 @@
-"use strict";var Module={};var initializedJS=false;function threadPrintErr(...args){var text=args.join(" ");console.error(text)}function threadAlert(...args){var text=args.join(" ");postMessage({cmd:"alert",text:text,threadId:Module["_pthread_self"]()})}var err=threadPrintErr;self.alert=threadAlert;Module["instantiateWasm"]=(info,receiveInstance)=>{var module=Module["wasmModule"];Module["wasmModule"]=null;var instance=new WebAssembly.Instance(module,info);return receiveInstance(instance)};self.onunhandledrejection=e=>{throw e.reason||e};function handleMessage(e){try{if(e.data.cmd==="load"){let messageQueue=[];self.onmessage=e=>messageQueue.push(e);self.startWorker=instance=>{Module=instance;postMessage({"cmd":"loaded"});for(let msg of messageQueue){handleMessage(msg)}self.onmessage=handleMessage};Module["wasmModule"]=e.data.wasmModule;for(const handler of e.data.handlers){Module[handler]=(...args)=>{postMessage({cmd:"callHandler",handler:handler,args:args})}}Module["wasmMemory"]=e.data.wasmMemory;Module["buffer"]=Module["wasmMemory"].buffer;Module["ENVIRONMENT_IS_PTHREAD"]=true;if(typeof e.data.urlOrBlob=="string"){importScripts(e.data.urlOrBlob)}else{var objectUrl=URL.createObjectURL(e.data.urlOrBlob);importScripts(objectUrl);URL.revokeObjectURL(objectUrl)}loadBR(Module)}else if(e.data.cmd==="run"){Module["__emscripten_thread_init"](e.data.pthread_ptr,0,0,1);Module["__emscripten_thread_mailbox_await"](e.data.pthread_ptr);Module["establishStackSpace"]();Module["PThread"].receiveObjectTransfer(e.data);Module["PThread"].threadInitTLS();if(!initializedJS){Module["__embind_initialize_bindings"]();initializedJS=true}try{Module["invokeEntryPoint"](e.data.start_routine,e.data.arg)}catch(ex){if(ex!="unwind"){throw ex}}}else if(e.data.cmd==="cancel"){if(Module["_pthread_self"]()){Module["__emscripten_thread_exit"](-1)}}else if(e.data.target==="setimmediate"){}else if(e.data.cmd==="checkMailbox"){if(initializedJS){Module["checkMailbox"]()}}else if(e.data.cmd){err(`worker.js received unknown command ${e.data.cmd}`);err(e.data)}}catch(ex){Module["__emscripten_thread_crashed"]?.();throw ex}}self.onmessage=handleMessage;
+/**
+ * @license
+ * Copyright 2015 The Emscripten Authors
+ * SPDX-License-Identifier: MIT
+ */
+
+// Pthread Web Worker startup routine:
+// This is the entry point file that is loaded first by each Web Worker
+// that executes pthreads on the Emscripten application.
+
+'use strict';
+
+var Module = {};
+
+// Thread-local guard variable for one-time init of the JS state
+var initializedJS = false;
+
+function assert(condition, text) {
+  if (!condition) abort('Assertion failed: ' + text);
+}
+
+function threadPrintErr(...args) {
+  var text = args.join(' ');
+  console.error(text);
+}
+function threadAlert(...args) {
+  var text = args.join(' ');
+  postMessage({cmd: 'alert', text, threadId: Module['_pthread_self']()});
+}
+// We don't need out() for now, but may need to add it if we want to use it
+// here. Or, if this code all moves into the main JS, that problem will go
+// away. (For now, adding it here increases code size for no benefit.)
+var out = () => { throw 'out() is not defined in worker.js.'; }
+var err = threadPrintErr;
+self.alert = threadAlert;
+var dbg = threadPrintErr;
+
+Module['instantiateWasm'] = (info, receiveInstance) => {
+  // Instantiate from the module posted from the main thread.
+  // We can just use sync instantiation in the worker.
+  var module = Module['wasmModule'];
+  // We don't need the module anymore; new threads will be spawned from the main thread.
+  Module['wasmModule'] = null;
+  var instance = new WebAssembly.Instance(module, info);
+  // TODO: Due to Closure regression https://github.com/google/closure-compiler/issues/3193,
+  // the above line no longer optimizes out down to the following line.
+  // When the regression is fixed, we can remove this if/else.
+  return receiveInstance(instance);
+}
+
+// Turn unhandled rejected promises into errors so that the main thread will be
+// notified about them.
+self.onunhandledrejection = (e) => {
+  throw e.reason || e;
+};
+
+function handleMessage(e) {
+  try {
+    if (e.data.cmd === 'load') { // Preload command that is called once per worker to parse and load the Emscripten code.
+
+    // Until we initialize the runtime, queue up any further incoming messages.
+    let messageQueue = [];
+    self.onmessage = (e) => messageQueue.push(e);
+
+    // And add a callback for when the runtime is initialized.
+    self.startWorker = (instance) => {
+      Module = instance;
+      // Notify the main thread that this thread has loaded.
+      postMessage({ 'cmd': 'loaded' });
+      // Process any messages that were queued before the thread was ready.
+      for (let msg of messageQueue) {
+        handleMessage(msg);
+      }
+      // Restore the real message handler.
+      self.onmessage = handleMessage;
+    };
+
+      // Module and memory were sent from main thread
+      Module['wasmModule'] = e.data.wasmModule;
+
+      // Use `const` here to ensure that the variable is scoped only to
+      // that iteration, allowing safe reference from a closure.
+      for (const handler of e.data.handlers) {
+        Module[handler] = (...args) => {
+          postMessage({ cmd: 'callHandler', handler, args: args });
+        }
+      }
+
+      Module['wasmMemory'] = e.data.wasmMemory;
+
+      Module['wasmOffsetData'] = e.data.wasmOffsetConverter;
+
+      Module['buffer'] = Module['wasmMemory'].buffer;
+
+      Module['workerID'] = e.data.workerID;
+
+      Module['ENVIRONMENT_IS_PTHREAD'] = true;
+
+      if (typeof e.data.urlOrBlob == 'string') {
+        importScripts(e.data.urlOrBlob);
+      } else {
+        var objectUrl = URL.createObjectURL(e.data.urlOrBlob);
+        importScripts(objectUrl);
+        URL.revokeObjectURL(objectUrl);
+      }
+      loadBR(Module);
+    } else if (e.data.cmd === 'run') {
+      // Pass the thread address to wasm to store it for fast access.
+      Module['__emscripten_thread_init'](e.data.pthread_ptr, /*is_main=*/0, /*is_runtime=*/0, /*can_block=*/1);
+
+      // Await mailbox notifications with `Atomics.waitAsync` so we can start
+      // using the fast `Atomics.notify` notification path.
+      Module['__emscripten_thread_mailbox_await'](e.data.pthread_ptr);
+
+      assert(e.data.pthread_ptr);
+      // Also call inside JS module to set up the stack frame for this pthread in JS module scope
+      Module['establishStackSpace']();
+      Module['PThread'].receiveObjectTransfer(e.data);
+      Module['PThread'].threadInitTLS();
+
+      if (!initializedJS) {
+        // Embind must initialize itself on all threads, as it generates support JS.
+        // We only do this once per worker since they get reused
+        Module['__embind_initialize_bindings']();
+        initializedJS = true;
+      }
+
+      try {
+        Module['invokeEntryPoint'](e.data.start_routine, e.data.arg);
+      } catch(ex) {
+        if (ex != 'unwind') {
+          // The pthread "crashed".  Do not call `_emscripten_thread_exit` (which
+          // would make this thread joinable).  Instead, re-throw the exception
+          // and let the top level handler propagate it back to the main thread.
+          throw ex;
+        }
+      }
+    } else if (e.data.cmd === 'cancel') { // Main thread is asking for a pthread_cancel() on this thread.
+      if (Module['_pthread_self']()) {
+        Module['__emscripten_thread_exit'](-1);
+      }
+    } else if (e.data.target === 'setimmediate') {
+      // no-op
+    } else if (e.data.cmd === 'checkMailbox') {
+      if (initializedJS) {
+        Module['checkMailbox']();
+      }
+    } else if (e.data.cmd) {
+      // The received message looks like something that should be handled by this message
+      // handler, (since there is a e.data.cmd field present), but is not one of the
+      // recognized commands:
+      err(`worker.js received unknown command ${e.data.cmd}`);
+      err(e.data);
+    }
+  } catch(ex) {
+    err(`worker.js onmessage() captured an uncaught exception: ${ex}`);
+    if (ex?.stack) err(ex.stack);
+    Module['__emscripten_thread_crashed']?.();
+    throw ex;
+  }
+};
+
+self.onmessage = handleMessage;

devel/test.sh

@@ -10,9 +10,9 @@ CLAPACK_WASM=$(realpath clapack-wasm) &&
 
 MAX_MEMORY=${MAX_MEMORY:-300mb} &&
 MAX_THREADS=${MAX_THREADS:-2} &&
-EMSDK=${EMSDK:-$(realpath ../emsdk)} &&
+EMSDK=${EMSDK:-$(realpath emsdk)} &&
 
-if [ ! -d $EMSDK_PATH ]; then
+if [ ! -d $EMSDK ]; then
   echo "Invalid EMSDK path"
   exit 1
 fi
@@ -24,21 +24,13 @@ if ! [[ $MAX_MEMORY =~ ^[0-9]+([kmgt]b)?$ ]]; then
   echo "MAX_MEMORY valid suffixes are kb, mb, gb, tb, none (bytes)" &&
   exit 1
 fi 
-if [ $EMSDK = ../emsdk ]; then
-  echo "EMSDK is current directory, installing emsdk and Emscripten..." &&
-  git clone --depth=1 https://github.com/emscripten-core/emsdk.git &&
-  cd emsdk &&
-  ./emsdk install 3.1.54 &&
-  ./emsdk activate 3.1.54 
-fi
 
 . $EMSDK/emsdk_env.sh &&
-export PATH=:$PATH:$EMSDK/upstream/bin &&
 
 cd $SRC &&
-RELEASE=1 &&
+RELEASE=0 &&
 if [ $RELEASE = 0 ]; then
-  em++ -O0 global.cc genericModel.cc model.cc spkModel.cc recognizer.cc bindings.cc -sWASMFS -sWASM_BIGINT -sSINGLE_FILE -sMODULARIZE -sEMBIND_STD_STRING_IS_UTF8 -sPTHREAD_POOL_DELAY_LOAD -sSAFE_HEAP -sSTACK_OVERFLOW_CHECK=2 -sTEXTDECODER=2 -sPTHREAD_POOL_SIZE_STRICT=2 -sASSERTIONS=2 -sINITIAL_MEMORY=$MAX_MEMORY -sPTHREAD_POOL_SIZE=$MAX_THREADS -sPOLYFILL=0 -sSUPPORT_LONGJMP=0 -sINVOKE_RUN=0 -sEXPORTED_FUNCTIONS=_malloc -sEXPORT_NAME=loadBR -sMALLOC=emmalloc -sEXPORTED_RUNTIME_METHODS=UTF8ToString,stringToUTF8OnStack -sENVIRONMENT=web,worker -I. -I$LIBARCHIVE/include -I$VOSK/src -L$LIBARCHIVE/lib -larchive -L$KALDI/src -l:online2/kaldi-online2.a -l:decoder/kaldi-decoder.a -l:ivector/kaldi-ivector.a -l:gmm/kaldi-gmm.a -l:tree/kaldi-tree.a -l:feat/kaldi-feat.a -l:cudamatrix/kaldi-cudamatrix.a -l:lat/kaldi-lat.a -l:lm/kaldi-lm.a -l:rnnlm/kaldi-rnnlm.a -l:hmm/kaldi-hmm.a -l:nnet3/kaldi-nnet3.a -l:transform/kaldi-transform.a -l:matrix/kaldi-matrix.a -l:fstext/kaldi-fstext.a -l:util/kaldi-util.a -l:base/kaldi-base.a -L$OPENFST/lib -l:libfst.a -l:libfstngram.a -L$CLAPACK_WASM -l:CBLAS/lib/cblas.a -l:CLAPACK-3.2.1/lapack.a -l:CLAPACK-3.2.1/libcblaswr.a -l:f2c_BLAS-3.8.0/blas.a -l:libf2c/libf2c.a -L$VOSK/src -l:vosk.a -lopfs.js -lembind -pthread -flto -msimd128 --emit-symbol-map --pre-js pre.js  -o ../devel/BrowserRecognizer.js 
+  em++ -O0 global.cc genericModel.cc model.cc spkModel.cc recognizer.cc bindings.cc -sWASMFS -sWASM_BIGINT -sSINGLE_FILE -sMODULARIZE -sEMBIND_STD_STRING_IS_UTF8 -sPTHREAD_POOL_DELAY_LOAD -sSAFE_HEAP_LOG -sSAFE_HEAP -sSTACK_OVERFLOW_CHECK=2 -sTEXTDECODER=2 -sPTHREAD_POOL_SIZE_STRICT=2 -sASSERTIONS=2 -sINITIAL_MEMORY=$MAX_MEMORY -sPTHREAD_POOL_SIZE=$MAX_THREADS -sPOLYFILL=0 -sSUPPORT_LONGJMP=0 -sINVOKE_RUN=0 -sEXPORTED_FUNCTIONS=_malloc -sEXPORT_NAME=loadBR -sMALLOC=emmalloc -sEXPORTED_RUNTIME_METHODS=UTF8ToString,stringToUTF8OnStack -sENVIRONMENT=web,worker -I. -I$LIBARCHIVE/include -I$VOSK/src -L$LIBARCHIVE/lib -larchive -L$KALDI/src -l:online2/kaldi-online2.a -l:decoder/kaldi-decoder.a -l:ivector/kaldi-ivector.a -l:gmm/kaldi-gmm.a -l:tree/kaldi-tree.a -l:feat/kaldi-feat.a -l:cudamatrix/kaldi-cudamatrix.a -l:lat/kaldi-lat.a -l:lm/kaldi-lm.a -l:rnnlm/kaldi-rnnlm.a -l:hmm/kaldi-hmm.a -l:nnet3/kaldi-nnet3.a -l:transform/kaldi-transform.a -l:matrix/kaldi-matrix.a -l:fstext/kaldi-fstext.a -l:util/kaldi-util.a -l:base/kaldi-base.a -L$OPENFST/lib -l:libfst.a -l:libfstngram.a -L$CLAPACK_WASM -l:CBLAS/lib/cblas.a -l:CLAPACK-3.2.1/lapack.a -l:CLAPACK-3.2.1/libcblaswr.a -l:f2c_BLAS-3.8.0/blas.a -l:libf2c/libf2c.a -L$VOSK/src -l:vosk.a -lopfs.js -lembind -pthread -flto -msimd128 --emit-symbol-map --pre-js pre.js -fsanitize=undefined -o ../devel/BrowserRecognizer.js 
 else
   em++ -O3 global.cc genericModel.cc model.cc spkModel.cc recognizer.cc bindings.cc -sWASMFS -sWASM_BIGINT -sSINGLE_FILE -sMODULARIZE -sEMBIND_STD_STRING_IS_UTF8 -sPTHREAD_POOL_DELAY_LOAD -sTEXTDECODER=2 -sPTHREAD_POOL_SIZE_STRICT=2 -sINITIAL_MEMORY=$MAX_MEMORY -sPTHREAD_POOL_SIZE=$MAX_THREADS -sPOLYFILL=0 -sSUPPORT_LONGJMP=0 -sEXPORTED_FUNCTIONS=_malloc -sEXPORT_NAME=loadBR -sMALLOC=emmalloc -sEXPORTED_RUNTIME_METHODS=UTF8ToString,stringToUTF8OnStack -sENVIRONMENT=web,worker -I. -I$LIBARCHIVE/include -I$VOSK/src -L$LIBARCHIVE/lib -larchive -L$KALDI/src -l:online2/kaldi-online2.a -l:decoder/kaldi-decoder.a -l:ivector/kaldi-ivector.a -l:gmm/kaldi-gmm.a -l:tree/kaldi-tree.a -l:feat/kaldi-feat.a -l:cudamatrix/kaldi-cudamatrix.a -l:lat/kaldi-lat.a -l:lm/kaldi-lm.a -l:rnnlm/kaldi-rnnlm.a -l:hmm/kaldi-hmm.a -l:nnet3/kaldi-nnet3.a -l:transform/kaldi-transform.a -l:matrix/kaldi-matrix.a -l:fstext/kaldi-fstext.a -l:util/kaldi-util.a -l:base/kaldi-base.a -L$OPENFST/lib -l:libfst.a -l:libfstngram.a -L$CLAPACK_WASM -l:CBLAS/lib/cblas.a -l:CLAPACK-3.2.1/lapack.a -l:CLAPACK-3.2.1/libcblaswr.a -l:f2c_BLAS-3.8.0/blas.a -l:libf2c/libf2c.a -L$VOSK/src -l:vosk.a -lopfs.js -lembind -pthread -flto -msimd128 --pre-js pre.js -o ../devel/BrowserRecognizer.js 
 fi

src/bindings.cc

@@ -21,6 +21,8 @@ EMSCRIPTEN_BINDINGS() {
   
   class_<recognizer>("recognizer") 
   .constructor<model*, float, int>(allow_raw_pointers())
+  .constructor<model*, spkModel*, float, int>(allow_raw_pointers())
+  .constructor<model*, std::string, float, int, int>(allow_raw_pointers())
   .function("setWords", &recognizer::setWords, allow_raw_pointers())
   .function("setPartialWords", &recognizer::setPartialWords, allow_raw_pointers())
   .function("setGrm", &recognizer::setGrm, allow_raw_pointers())

src/pre.js

@@ -68,7 +68,7 @@ class Recognizer extends EventTarget {
     super()
     objs.push(this)
   }
-  static async _init(model, sampleRate) {
+  static async _init1(model, sampleRate) {
     let rec = new Recognizer()
     return new Promise((resolve, reject) => {
       rec.addEventListener("_continue", (ev) => {
@@ -82,6 +82,34 @@ class Recognizer extends EventTarget {
       rec.obj = new Module.recognizer(model, sampleRate, objs.length-1)  
     })
   }
+  static async _init2(model, spkModel, sampleRate) {
+    let rec = new Recognizer()
+    return new Promise((resolve, reject) => {
+      rec.addEventListener("_continue", (ev) => {
+        if(ev.detail == "0") {
+          rec.ptr = Module._malloc(512)
+          return resolve(rec)
+        }
+        rec.delete()
+        reject(ev.detail)
+      }, {once : true})
+      rec.obj = new Module.recognizer(model, spkModel, sampleRate, objs.length-1)  
+    })
+  }
+  static async _init3(model, grammar, sampleRate) {
+    let rec = new Recognizer()
+    return new Promise((resolve, reject) => {
+      rec.addEventListener("_continue", (ev) => {
+        if(ev.detail == "0") {
+          rec.ptr = Module._malloc(512)
+          return resolve(rec)
+        }
+        rec.delete()
+        reject(ev.detail)
+      }, {once : true})
+      rec.obj = new Module.recognizer(model, grammar, sampleRate, objs.length-1, 0)  
+    })
+  }
   async getNode(ctx, channelIndex = 0) {
     if(typeof this.node === "undefined") {
       let msgChannel = new MessageChannel()
@@ -123,6 +151,12 @@ class Recognizer extends EventTarget {
 Module.makeRecognizer = (model, sampleRate) => {
   return Recognizer._init(model.obj, sampleRate)
 }
+Module.makeRecognizerWithSpkModel = (model, spkModel, sampleRate) => {
+  return Recognizer._init2(model.obj, spkModel.obj, sampleRate)
+} 
+Module.makeRecognizerWithGrm = (model, grammar, sampleRate) => {
+  return Recognizer._init3(model.obj, grammar, sampleRate)
+} 
 let processorUrl = URL.createObjectURL(new Blob(['(',
   (() => {
     registerProcessor("BRProcessor", class extends AudioWorkletProcessor {

src/recognizer.cc

@@ -3,31 +3,23 @@
 recognizer::recognizer(model* mdl, float sampleRate, int index) : index(index) {
   auto main{[this, mdl, sampleRate](){
     rec = vosk_recognizer_new(mdl->mdl,sampleRate);
-    if(rec == nullptr) {
-      fireEv("_continue", "Unable to initialize recognizer", this->index);
-      return;
-    }
-    fireEv("_continue", nullptr, this->index);
-    while(!done.test(std::memory_order_relaxed)) {
-      controller.wait(!done.test(std::memory_order_relaxed), std::memory_order_relaxed);
-      controller.clear(std::memory_order_relaxed);
-      if(done.test(std::memory_order_relaxed)) continue;
-      switch(vosk_recognizer_accept_waveform_f(rec, dataPtr, 512)) {
-      case 0:
-      fireEv("result", vosk_recognizer_result(rec), this->index);
-      break;
-      case 1:
-      fireEv("partialResult", vosk_recognizer_partial_result(rec), this->index);
-      }
-    }
+    finishConstruction();
   }};
-  if(mdl->recognizerUsedThrd) {
-    mdl->thrd.addTask(main);
-    mdl->recognizerUsedThrd = true;
-    return;
-  }
-  std::thread t{main};
-  t.detach();
+  tryStealMdlThrd(main, mdl);
+}
+recognizer::recognizer(model* mdl, spkModel* spkMdl, float sampleRate, int index) {
+  auto main{[this, mdl, sampleRate, spkMdl](){
+    rec = vosk_recognizer_new_spk(mdl->mdl, sampleRate, spkMdl->mdl);
+    finishConstruction();
+  }};
+  tryStealMdlThrd(main, mdl);
+}
+recognizer::recognizer(model* mdl, const std::string& grm, float sampleRate, int index, int dummy) {
+  auto main{[this, mdl, sampleRate, grm](){
+    rec = vosk_recognizer_new_grm(mdl->mdl, sampleRate, grm.c_str());
+    finishConstruction();
+  }};
+  tryStealMdlThrd(main, mdl);
 }
 recognizer::~recognizer() {
   done.test_and_set(std::memory_order_relaxed);
@@ -37,7 +29,34 @@ recognizer::~recognizer() {
   vosk_recognizer_free(rec);
   free(dataPtr);
 }
-
+void recognizer::tryStealMdlThrd(std::function<void()>&& main, model* mdl) {
+  if(mdl->recognizerUsedThrd) {
+    mdl->thrd.addTask(std::move(main));
+    mdl->recognizerUsedThrd = true;
+    return;
+  }
+  std::thread t{main};
+  t.detach();
+}
+void recognizer::finishConstruction() {
+  if(rec == nullptr) {
+    fireEv("_continue", "Unable to initialize recognizer", this->index);
+    return;
+  }
+  fireEv("_continue", nullptr, this->index);
+  while(!done.test(std::memory_order_relaxed)) {
+    controller.wait(!done.test(std::memory_order_relaxed), std::memory_order_relaxed);
+    controller.clear(std::memory_order_relaxed);
+    if(done.test(std::memory_order_relaxed)) continue;
+    switch(vosk_recognizer_accept_waveform_f(rec, dataPtr, 512)) {
+      case 0:
+        fireEv("result", vosk_recognizer_result(rec), this->index);
+        break;
+      case 1:
+        fireEv("partialResult", vosk_recognizer_partial_result(rec), this->index);
+    }
+  }
+}
 void recognizer::acceptWaveForm() {
   controller.test_and_set(std::memory_order_relaxed);
   controller.notify_one();

src/recognizer.h

@@ -3,9 +3,6 @@
 #include "spkModel.h"
 #include "global.h"
 
-#include <filesystem>
-namespace fs = std::filesystem;
-
 struct recognizer {
   std::atomic_flag done{};
   std::atomic_flag controller{};
@@ -13,7 +10,11 @@ struct recognizer {
   int index{};
   VoskRecognizer* rec{};
   recognizer(model* model, float sampleRate, int index);
+  recognizer(model* model, spkModel* spkModel, float sampleRate, int index);
+  recognizer(model* model, const std::string& grm, float sampleRate, int index, int dummy);
   ~recognizer();
+  void finishConstruction();
+  void tryStealMdlThrd(std::function<void()>&& main, model* mdl);
   void acceptWaveForm();
   void setSpkModel(spkModel* model);
   void setGrm(const std::string& grm);

usage/README.md

@@ -1,5 +1,5 @@
 # API interface
-## JS ```window``` object
+## JS' ```window``` object
 | Function signature | Description |
 |---|---|
 |```Promise<Module> loadBR()``` | Load Emscripten's Module |
@@ -13,9 +13,9 @@
 | Function signature | Description |
 |---|---|
 | ```Promise<Model> makeModel(path: string, url: string, id: string)```<br><br>```Promise<SpkModel> makeSpkModel(path: string, url: string, id: string)``` | Make a ```Model``` or ```SpkModel```, model files must be directly under the model root, and compressed model must be in .tgz format. If:<br>- **path** contains valid model files and **id** is the same, there will not be a fetch from **url**.<br>- **path** doesn't contain valid model files, or if it contains valid model files but **id** is different, there will be a fetch from **url**, and the model is stored with **id**.  |
-| ```Promise<Recognizer> makeRecognizer(model: Model, sampleRate: float)``` | Make a ```Recognizer```, it will use **model**'s thread if it's the first user of **model**, else it will use a new thread.
+| ```Promise<Recognizer> makeRecognizer(model: Model, sampleRate: float)```<br><br>```Promise<Recognizer> makeRecognizerWithSpkModel(model: Model, spkModel: spkModel, sampleRate: float)```<br><br>```Promise<Recognizer> makeRecognizerWithGrm(model: Model, grammar: string, sampleRate: float)``` | Make a ```Recognizer```, it will use **model**'s thread if it's the first user of **model**, else it will use a new thread. |
 | ```setLogLevel(lvl: int)``` | Set Vosk's log level (default: ```0```: Info) <br>```-2```: Error<br>```-1```: Warning<br>```1```: Verbose<br>```2```: More verbose<br>```3```: Debug |
-| ```cleanUp()``` | A convenience function that call ```delete()``` on all objects and revoke all URLs. You should put this at the end of your program! |
+| ```cleanUp()``` | A convenience function that call ```delete()``` on all objects and revoke all URLs. **Put this at the end of your code!** |
 
 ## ```Recognizer``` object 
 | Function signature | Description |
@@ -26,7 +26,7 @@
 | ```setWords(words: bool)``` | Return words' information in a result event (default: false) |
 | ```setNLSML(nlsml: bool)``` | Return result and partialResult in NLSML form (default: false) |
 | ```setMaxAlternatives(alts: int)``` | Set the max number of alternatives for result event (default: false) |
-| ```setGrm(grm: string)``` | Add grammar to the recognizer (default: none) |
+| ```setGrm(grm: string)``` | Set the grammar of the recognizer, override (default: none) |
 | ```setSpkModel(mdl: SpkModel)``` | Set the speaker model of the recognizer (default: none) |
 
 | Event | Description |