## Please edit system and help pages ONLY in the moinmaster wiki! For more
## information, please see MoinMaster:MoinPagesEditorGroup.
##master-page:FrontPage
#format wiki
#language en
#pragma section-numbers off
This page contains collaboratively developed documentation for the CMU Sphinx speech recognition engines.   See HelpForBeginners for an explanation of how this site works, or HelpContents for all help pages.  If you are new to Wikis, you can try editing things in WikiSandbox.

= User Documentation =
This section contains links to documents which describe how to use Sphinx to recognize speech.  Currently, we have very little in the way of end-user tools, so it may be a bit sparse for the forseeable future.

 * [[http://sphinx.subwiki.com/sphinx/index.php/Main_Page|Sphinx SubWiki]] contains various entry-level information
 * LanguageModelHowto: How to build a simple language model to recognize a list of phrases
 * AcousticModelAdaptation: How to adapt the default acoustic model to your voice
 * DecoderTuning: How to tune SphinxThree to be fast (or rather, not horribly slow)
 * AsteriskDetails: How to use pocketsphinx in Asterisk.
 * PhonemeRecognition: How to use Sphinx3 for phoneme recognition.

== Walkthroughs and HOWTOs ==
These documents either describe some particular aspect of the Sphinx codebase in detail, or they serve as a developer's guide to accomplishing some particular task.

 * [[http://cmusphinx.org/tutorial.html|Sphinx Tutorial]]: Covers the basics of model training
 * SphinxTrainWalkthrough: An overview of the SphinxTrain source code for researchers and developers
 * InstallingPythonStuff: How to install Python and necessary modules for SphinxTrain development
 * [[LDAMLLT]]: How to train acoustic models with LDA and MLLT feature transforms
 * [[GStreamer]]: How to use PocketSphinx with [[http://gstreamer.freedesktop.org/|GStreamer]] and [[http://python.org|Python]]
 * PocketSphinxMigration: PocketSphinx 0.5 API migration guide.
 * [[CMUCLMTKDevelopment|CMUCLMTK development]]: Development guide for the CMU-Cambridge Language Modeling Toolkit.
 * [[SphinxInAction|Projects that use Sphinx]]: These projects, both commercial and free, use Sphinx in one form or another.
 * [[PocketsphinxHandhelds| Pocketsphinx optimizations for embedded devices]].

= Developer Documentation =
This section contains links to documents which describe how to build systems using Sphinx, as well as how to contribute to the Sphinx code.

== Reference ==
These documents describe the excruciating detail of APIs, or provide other useful background information for Sphinx developers.

 * CodingStyle for SphinxBase, SphinxThree, and SphinxTrain
 * [[http://www.speech.cs.cmu.edu/sphinx/doc/doxygen/pocketsphinx/|Doxygen documentation for PocketSphinx]]
 * [[http://www.speech.cs.cmu.edu/sphinx/doc/doxygen/sphinxbase/|Doxygen documentation for SphinxBase]]
 * [[http://www.speech.cs.cmu.edu/sphinx/doc/doxygen/sphinx3/|Doxygen documentation for Sphinx3]]
 * [[http://lima.lti.cs.cmu.edu/pydoc/SphinxTrain/|ePyDoc documentation for SphinxTrain Python Modules]]
 * [[http://cmusphinx.sourceforge.net/sphinx4/javadoc/index.html|JavaDocs for Sphinx4]]