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(link is external).

Documentation of Kaldi(link is external):

• Info about the project, description of techniques, tutorial for C++ coding.
• Doxygen reference of the C++ code.

Kaldi forums and mailing lists(link is external):

We have two different lists

• User list kaldi-help
• Developer list kaldi-developers:

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

Development pattern for contributors

1. Create a personal fork(link is external)
   of the main Kaldi repository(link is external) 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(link is external)
   through the Web interface of GitHub.
4. As a general rule, please follow Google C++ Style Guide(link is external).
   There are a few exceptions in Kaldi(link is external).
   You can use the Google's cpplint.py(link is external)
   to verify that your code is free of basic mistakes.

Platform specific notes

PowerPC 64bits little-endian (ppc64le)

• Kaldi is expected to work out of the box in RHEL >= 7 and Ubuntu >= 16.04 with
  OpenBLAS, ATLAS, or CUDA.
• CUDA drivers for ppc64le can be found at https://developer.nvidia.com/cuda-downloads(link is external).
• An IBM Redbook(link is external) is
  available as a guide to install and configure CUDA.

Android

• Kaldi supports cross compiling for Android using Android NDK, clang++ and
  OpenBLAS.
• See this blog post(link is external)
  for details.

Web Assembly

• Kaldi supports cross compiling for Web Assembly for in-browser execution
  using emscripten(link is external) and CLAPACK.
• See this post(link is external)
  for a step-by-step description of the build process.