1This is Sphinx 3.7 (s3.7), one of Carnegie Mellon University's open 2source large vocabulary, speaker-independent continuous speech 3recognition engine. Please see the LICENSE file for terms of use. 4 5There has always been confusion of the versioning of Sphinx-3. Here 6is a brief description. 7 8Over the course of development, Sphinx-3 had branched into two major 9versions. They are the flat lexicon decoder, (or aka "s3-slow") and 10the tree lexicon decoder (or aka "s3-fast"). Performance wise, 11s3-slow is ~10% relative better than s3-fast empirically. However, 12s3-fast could be around 10 times faster than s3-slow. From sphinx 3.0 13to Sphinx 3.4. The two code-bases were separated. 14 15During the development of Sphinx 3.5, conscious decision were made to 16merge the two branches together. This merging is stabilized in Sphinx 173.6. Internally, both the fast decoder and slow decoder share over 1870% of the codebase. From the user perspective though, the old 19sphinx3_decode_anytopo (s3-slow) and sphinx3_decode (s3-fast) exist as 20two separate interface of the decoding engine. This will allow 21backward compatibility to the past. 22 23In 3.7, we did a site-wide change that allow sphinx3 and pocketsphinx 24(and perhaps later SphinxTrain) to share the same codebase. 25 26THIS IS A RESEARCH SYSTEM. After several extensions and upgrade, we 27 still find that Sphinx is better regarded as an early release of a 28research system. We know the APIs and function names are likely to 29change, and that several tools need to be made available to make this 30all complete. With your help and contributions, this can progress in 31response to the needs and patches provided. 32 33If you install the distribution in the default location, you can 34access the documentation here: 35 36 file://localhost/usr/local/share/sphinx3/doc/ 37 38There are couple of useful documents you could find in the ./doc 39directory. These include: 40 41s3_codework.html : Code review document prepared by Ravi Mosur. 42s3_description.html : Code review document prepared by Ravi Mosur. 43s3_overview.html : Code review document prepared by Ravi Mosur. 44s3.2.ppt : The powerpoint presentation prepared by Ravi Mosur. 45FAQ.html : Frequently asked question page prepared by Rita Singh 46sphinxman_manual.html : Manual for training prepared by Rita Singh. 47sphinxman_FAQ.html : FAQ for training prepared by Rita Singh. 48sphinxman_misc.html : Miscellaneous information for training prepared by Rita Singh. 49models.html : Description of the default broad cast news model 50 51(Obsolete) cmdhelp.txt : Sphinx 3.3 command line arguments. 52 53For up-to-date information, please see the web site at 54 55 http://cmusphinx.org 56 57 58A brief note of the API: From s3.5, the live mode API of the decoder 59is stabilized. The decoder routine is stored in a library called 60libs3decoder.a. The decoder function takes blocks of speech samples 61and returns partial hypotheses for the blocks decoded during 62runtime. Examples of its use are given in main_live_example.c and 63main_live_pretend.c 64 65This directory contains the scripts and instructions necessary for 66decoding speech input using the CMU Sphinx Recognizer. 67 68This distribution is free software, see LICENSE for license. 69 70 71Installation Guide: 72^^^^^^^^^^^^^^^^^^^ 73This sections contain installation guide for various platforms. 74 75Linux/Unix Installation: 76^^^^^^^^^^^^^^^^^^^^^^^^ 77Starting from Sphinx 3.7, you need to compile sphinxbase before 78compilation of sphinx3. The layout of the directory should look 79like this: 80 sphinx3/ 81 sphinxbase/ 82 83By default, sphinx3 will search for ../sphinxbase/ as the path of the 84include files and libraries. You need to compile sphinxbase FIRST 85before compiling sphinx3. Please read the README in the sphinxbase 86package for details. 87 88This distribution now uses GNU autoconf to find out basic information 89about your system, and should compile on most Unix and Unix-like 90systems, and certainly on Linux. 91 92If you downloaded directly from the Subversion repository, you need to 93create the "configure" file 94 95 >./autogen.sh 96 >./autogen.sh 97 98(Make sure you do this twice.) 99 100If you downloaded a release version, or if you have already run 101"autogen.sh", you can build simply by running 102 103 >./configure 104 >make 105 106(Or whatever you call GNU Make). This should configure everything 107automatically. After a successful compilation, you may test the system 108by running 109 110 >make check 111 112and then install it with 113 114 >make install 115 116This defaults to installing Sphinx-3 under /usr/local. You may 117customize it by running ./configure with an argument, as in 118 119 >./configure --prefix=/my/own/installation/directory 120 121Windows Installation: 122^^^^^^^^^^^^^^^^^^^^^ 123Starting from sphinx 3.7, you need to install sphinxbase before 124installation of sphinx. The general layout looks like this 125 126 sphinx3/ 127 sphinxbase/ 128 129To compile the sphinx 3.7 in Visual C++ 6.0, 1301, unzip the file. 1312, click sphinx3.dsw 1323, build the application projects by clicking "Build" at the tool bar. 133 134Step 3 can be done easily in VC6.0 by clicking the "Build" menu at 135the top bar, and selecting "Batch Build...". Make sure all projects 136are selected, preferably the "Release" version of each. You can also 137run with the "Debug" version, but this version is usually slower. To 138run the executable, please remember to set the corresponding active 139project. 140 141If you are using cygwin, the installation procedure is very similar to 142the Unix installation. However, there is no audio driver support in 143cygwin currently so one can only use the batch mode recognzier. 144 145 146Acknowldegments 147^^^^^^^^^^^^^^^ 148 149This work was built over a long years at CMU by most of the people in 150the Sphinx Group. Some code goes back to 1986. The most recent wor for 151release after sphinx 3.0 includes the following, listed 152alphabetically. 153 154Alan W Black (awb@cs.cmu.edu) 155Arthur Chan (archan@cs.cmu.edu) 156Evandro Gouvea (egouvea+@cs.cmu.edu) 157Ricky Houghton (ricky.houghton@cs.cmu.edu) 158David Huggins-Daines (dhuggins@cs.cmu.edu) 159Kevin Lenzo (lenzo@cs.cmu.edu) 160Ravi Mosur 161Rita Singh (rsingh+@cs.cmu.edu) 162Yitao Sun (yitao@cs.cmu.edu) 163Eric Thayer 164 165 166 167 168