Refactor hotwords，support loading hotwords from file (#296)

python-api-examples/speech-recognition-from-microphone.py

@@ -11,7 +11,6 @@ import sys
 from pathlib import Path
 
 from typing import List
-import sentencepiece as spm
 
 try:
     import sounddevice as sd
@@ -90,49 +89,29 @@ def get_args():
     )
 
     parser.add_argument(
-        "--bpe-model",
+        "--hotwords-file",
         type=str,
         default="",
         help="""
-        Path to bpe.model, it will be used to tokenize contexts biasing phrases.
-        Used only when --decoding-method=modified_beam_search
+        The file containing hotwords, one words/phrases per line, and for each
+        phrase the bpe/cjkchar are separated by a space. For example:
+
+        ▁HE LL O ▁WORLD
+        你 好 世 界
         """,
     )
 
     parser.add_argument(
-        "--modeling-unit",
-        type=str,
-        default="char",
-        help="""
-        The type of modeling unit, it will be used to tokenize contexts biasing phrases.
-        Valid values are bpe, bpe+char, char.
-        Note: the char here means characters in CJK languages.
-        Used only when --decoding-method=modified_beam_search
-        """,
-    )
-
-    parser.add_argument(
-        "--contexts",
-        type=str,
-        default="",
-        help="""
-        The context list, it is a string containing some words/phrases separated
-        with /, for example, 'HELLO WORLD/I LOVE YOU/GO AWAY".
-        Used only when --decoding-method=modified_beam_search
-        """,
-    )
-
-    parser.add_argument(
-        "--context-score",
+        "--hotwords-score",
         type=float,
         default=1.5,
         help="""
-        The context score of each token for biasing word/phrase. Used only if
-        --contexts is given.
-        Used only when --decoding-method=modified_beam_search
+        The hotword score of each token for biasing word/phrase. Used only if
+        --hotwords-file is given.
         """,
     )
 
+
     return parser.parse_args()
 
 
@@ -155,32 +134,12 @@ def create_recognizer(args):
         decoding_method=args.decoding_method,
         max_active_paths=args.max_active_paths,
         provider=args.provider,
-        context_score=args.context_score,
+        hotwords_file=args.hotwords_file,
+        hotwords_score=args.hotwords_score,
     )
     return recognizer
 
 
-def encode_contexts(args, contexts: List[str]) -> List[List[int]]:
-    sp = None
-    if "bpe" in args.modeling_unit:
-        assert_file_exists(args.bpe_model)
-        sp = spm.SentencePieceProcessor()
-        sp.load(args.bpe_model)
-    tokens = {}
-    with open(args.tokens, "r", encoding="utf-8") as f:
-        for line in f:
-            toks = line.strip().split()
-            assert len(toks) == 2, len(toks)
-            assert toks[0] not in tokens, f"Duplicate token: {toks} "
-            tokens[toks[0]] = int(toks[1])
-    return sherpa_onnx.encode_contexts(
-        modeling_unit=args.modeling_unit,
-        contexts=contexts,
-        sp=sp,
-        tokens_table=tokens,
-    )
-
-
 def main():
     args = get_args()
 
@@ -193,12 +152,6 @@ def main():
     default_input_device_idx = sd.default.device[0]
     print(f'Use default device: {devices[default_input_device_idx]["name"]}')
 
-    contexts_list = []
-    contexts = [x.strip().upper() for x in args.contexts.split("/") if x.strip()]
-    if contexts:
-        print(f"Contexts list: {contexts}")
-        contexts_list = encode_contexts(args, contexts)
-
     recognizer = create_recognizer(args)
     print("Started! Please speak")
 
@@ -207,10 +160,7 @@ def main():
     sample_rate = 48000
     samples_per_read = int(0.1 * sample_rate)  # 0.1 second = 100 ms
     last_result = ""
-    if contexts_list:
-        stream = recognizer.create_stream(contexts_list=contexts_list)
-    else:
-        stream = recognizer.create_stream()
+    stream = recognizer.create_stream()
     with sd.InputStream(channels=1, dtype="float32", samplerate=sample_rate) as s:
         while True:
             samples, _ = s.read(samples_per_read)  # a blocking read