kaldi README

The project's README from github.com/kaldi-asr/kaldi. As one markdown file: README.md.

Build Status Gitpod Ready-to-Code Kaldi Speech Recognition Toolkit

To build the toolkit: see ./INSTALL. These instructions are valid for UNIX systems including various flavors of Linux; Darwin; and Cygwin (has not been tested on more "exotic" varieties of UNIX). For Windows installation instructions (excluding Cygwin), see windows/INSTALL.

To run the example system builds, see egs/README.txt

If you encounter problems (and you probably will), please do not hesitate to contact the developers (see below). In addition to specific questions, please let us know if there are specific aspects of the project that you feel could be improved, that you find confusing, etc., and which missing features you most wish it had.

Kaldi information channels

For HOT news about Kaldi see the project site.

Documentation of Kaldi:

Kaldi forums and mailing lists:

We have two different lists

To sign up to any of those mailing lists, go to http://kaldi-asr.org/forums.html:

Development pattern for contributors

  1. Create a personal fork of the main Kaldi repository in GitHub.
  2. Make your changes in a named branch different from master, e.g. you create a branch my-awesome-feature.
  3. Generate a pull request through the Web interface of GitHub.
  4. As a general rule, please follow Google C++ Style Guide. There are a few exceptions in Kaldi. You can use the Google's cpplint.py to verify that your code is free of basic mistakes.

Platform specific notes

Fedora 41 (and later)

In order to build it on Fedora 41 using the libraries that are provided by the distro, you need to install the development libraries and dependencies with

sudo dnf install lapack-devel openfst-devel

then build the package as follows:

cmake -S ./ -Bbuild/Release -DFETCHCONTENT_FULLY_DISCONNECTED=ON -DBuildForFedora=ON
cmake --build /home/gerhard/workspace/kaldi/build/Release

PowerPC 64bits little-endian (ppc64le)

Android

Web Assembly

kaldi (kaldi-asr/kaldi)

Searching Database…

15.5K ·GitHub
What is this?Kaldi is an open-source speech recognition toolkit: C++ code plus example recipes for building speech-to-text, speaker-ID and speaker-verification systems.
How do I get it running?Clone the repo and follow ./INSTALL for UNIX systems; native Windows builds are documented separately in windows/INSTALL, and the example system builds are described in egs/README.txt.
What has to be on my machine before the build?Standard UNIX build tools (make, a compiler) and a BLAS library such as OpenBLAS or ATLAS. On Fedora 41 you first install the distro's development libraries and dependencies.
Is it beginner-friendly, or should I expect a bumpy ride?Expect some friction: the README itself warns that you will probably encounter problems and points users to the developers and the kaldi-help mailing list for support.
Is Linux the only OS it actually works on?No — it targets various Linux flavors, macOS (Darwin) and Windows via Cygwin, and there are also notes for PowerPC 64-bit little-endian systems (RHEL 7+, Ubuntu 16.04+).
Do I need an NVIDIA GPU to use it?No — CPU-only builds are fully supported via OpenBLAS or ATLAS; CUDA is mentioned as an optional third alternative, not a requirement.
What can I build with it besides plain speech-to-text?Speaker identification and verification are first-class use cases, so you can build systems that recognize who is speaking, not just what they say.
Can Kaldi run on Android or in the browser?Yes: it cross-compiles to Android with the Android NDK, clang++ and OpenBLAS, and to WebAssembly with emscripten and OpenBLAS for in-browser execution.
Where should I start once I have it built?Build one of the example systems in egs/ (see egs/README.txt), then work through the docs, which include a techniques tutorial, a C++ coding guide and a Doxygen reference.
Do I need to write C++ to use it?Not for basic use — the example systems are shell scripts driving the compiled tools. C++ matters mainly if you want to extend Kaldi itself.
Creator
kaldi-asr
Size
122.6 MB
Stars
15.5K
Updated
CommitSep 22
Age
11y
Commits · 90 Days