pyctcdecode
A fast and feature-rich CTC beam search decoder for speech recognition written in Python, providing n-gram (kenlm) language model support similar to PaddlePaddle's decoder, but incorporating many new features such as byte pair encoding and real-time decoding to support models like Nvidia's Conformer-CTC or Facebook's Wav2Vec2.
pip install pyctcdecode
Main Features:
-
🔥 hotword boosting -
🤖 handling of BPE vocabulary -
👥 multi-LM support for 2+ models -
🕒 stateful LM for real-time decoding -
✨ native frame index annotation of words -
💨 fast runtime, comparable to C++ implementation -
🐍 easy-to-modify Python code
Quick Start:
import kenlm
from pyctcdecode import build_ctcdecoder
# load trained kenlm model
kenlm_model = kenlm.Model("/my/dir/kenlm_model.binary")
# specify alphabet labels as they appear in logits
labels = [
" ", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l",
"m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z",
]
# prepare decoder and decode logits via shallow fusion
decoder = build_ctcdecoder(
labels,
kenlm_model,
alpha=0.5, # tuned on a val set
beta=1.0, # tuned on a val set
)
text = decoder.decode(logits)
If the vocabulary is BPE-based, adjust the labels and set the is_bpe flag (merging of tokens for the LM is handled automatically):
labels = ["<unk>", "▁bug", "s", "▁bunny"]
decoder = build_ctcdecoder(
labels,
kenlm_model,
is_bpe=True,
)
text = decoder.decode(logits)
Improve domain specificity by adding important contextual words ("hotwords") during inference:
hotwords = ["looney tunes", "anthropomorphic"]
text = decoder.decode(
logits,
hotwords=hotwords,
hotword_weight=10.0,
)
Batch support via multiprocessing:
from multiprocessing import Pool
with Pool() as pool:
text_list = decoder.decode_batch(logits_list, pool)
Use pyctcdecode for a pretrained Conformer-CTC model:
import nemo.collections.asr as nemo_asr
asr_model = nemo_asr.models.EncDecCTCModelBPE.from_pretrained(
model_name='stt_en_conformer_ctc_small'
)
logits = asr_model.transcribe(["my_file.wav"], logprobs=True)[0].cpu().detach().numpy()
decoder = build_ctcdecoder(asr_model.decoder.vocabulary, is_bpe=True)
decoder.decode(logits)
The tutorials folder contains many well documented notebook examples on how to run speech recognition using pretrained models from Nvidia's NeMo and Huggingface/Facebook's Wav2Vec2.
For more details on how to use all of pyctcdecode's features, have a look at our main tutorial.
Why pyctcdecode?
In scientific computing, there’s often a tension between a language’s performance and its ease of use for prototyping and experimentation. Although C++ is the conventional choice for CTC decoders, we decided to try building one in Python. This choice allowed us to easily implement experimental features, while keeping runtime competitive through optimizations like caching and beam pruning. We compare the performance of pyctcdecode to an industry standard C++ decoder at various beam widths (shown as inline annotations), allowing us to visualize the trade-off of word error rate (y-axis) vs runtime (x-axis). For beam widths of 10 or greater, pyctcdecode yields strictly superior performance, with lower error rates in less time, see code here.
The use of Python allows us to easily implement features like hotword support with only a few lines of code.
pyctcdecode can return either a single transcript, or the full results of the beam search algorithm. The latter provides the language model state to enable real-time inference as well as word-based logit indices (frames) to enable word-based timing and confidence score calculations natively through the decoding process.
Additional features such as BPE vocabulary, as well as examples of pyctcdecode as part of a full speech recognition pipeline, can be found in the tutorials section.
Resources:
- NeMo and Wav2Vec2
- CTC blog post
- Beam search by Andrew Ng
License:
Licensed under the Apache 2.0 License. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2021-present Kensho Technologies, LLC. The present date is determined by the timestamp of the most recent commit in the repository.
2 Sep 20, 2022
61 Dec 13, 2022
26 Dec 05, 2022
220 Dec 11, 2022
21 Dec 11, 2022
129 Jan 06, 2023
334 Jan 08, 2023
251 Jan 01, 2023
76 Nov 12, 2022
25 Dec 04, 2022
83 Jan 09, 2023
9 Dec 28, 2022
4 Jul 20, 2022
2 Jan 17, 2022
1 Dec 03, 2021
29 Oct 23, 2022
4 Dec 09, 2021
319 Dec 20, 2022
29 Nov 17, 2022
335 Jan 04, 2023