Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 2.22 KB

README.md

File metadata and controls

53 lines (40 loc) · 2.22 KB
Raw

[Build Status] (https://travis-ci.org/kaldi-asr/kaldi)

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:

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

Kaldi forums and mailing lists:

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:

Development pattern for contributors

  1. Create a personal fork of the [main Kaldi repository] (https://github.com/kaldi-asr/kaldi) 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] (https://google.github.io/styleguide/cppguide.html). There are a few exceptions in Kaldi. You can use the [Google's cpplint.py] (https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py) to verify that your code is free of basic mistakes.