Permalink
Browse files

Update the docs a little bit

  • Loading branch information...
Uberi committed Dec 20, 2016
1 parent 16111ff commit a48e7f99cbe2d52dd5f6b64720ac327cc94e1a13
Showing with 11 additions and 7 deletions.
  1. +2 −0 .github/ISSUE_TEMPLATE.md
  2. +8 −6 README.rst
  3. +1 −1 reference/pocketsphinx.rst
@@ -28,6 +28,8 @@ My **system** is <INSERT SYSTEM HERE>. (For example, "Ubuntu 16.04 LTS x64", "Wi
My **Python version** is <INSERT VERSION HERE>. (You can check this by running `python -V`.)
+My **Pip version** is <INSERT VERSION HERE>. (You can check this by running `pip -V`.)
+
My **SpeechRecognition library version** is <INSERT VERSION HERE>. (You can check this by running `python -c "import speech_recognition as sr;print(sr.__version__)"`.)
My **PyAudio library version** is <INSERT VERSION HERE> / I don't have PyAudio installed. (You can check this by running `python -c "import pyaudio as p;print(p.__version__)"`.)
View
@@ -154,13 +154,15 @@ To install, use `Pip <https://pip.readthedocs.org/>`__: execute ``pip install mo
Troubleshooting
---------------
-The recognizer tries to recognize speech even when I'm not speaking.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The recognizer tries to recognize speech even when I'm not speaking, or after I'm done speaking.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Try increasing the ``recognizer_instance.energy_threshold`` property. This is basically how sensitive the recognizer is to when recognition should start. Higher values mean that it will be less sensitive, which is useful if you are in a loud room.
This value depends entirely on your microphone or audio data. There is no one-size-fits-all value, but good values typically range from 50 to 4000.
+Also, check on your microphone volume settings. If it is too sensitive, the microphone may be picking up a lot of ambient noise. If it is too insensitive, the microphone may be rejecting speech as just noise.
+
The recognizer can't recognize speech right after it starts listening for the first time.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -245,9 +247,9 @@ To hack on this library, first make sure you have all the requirements listed in
To install/reinstall the library locally, run ``python setup.py install`` in the project `root directory <https://github.com/Uberi/speech_recognition>`__.
-Before a release, version tags are created using ``git config --global user.signingkey DB45F6C431DE7C2DCD99FF7904882258A4063489 && git tag -s VERSION_GOES_HERE -m VERSION_GOES_HERE``.
+Before a release, version tags are created using ``git config user.signingkey DB45F6C431DE7C2DCD99FF7904882258A4063489 && git tag -s VERSION_GOES_HERE -m "Version VERSION_GOES_HERE"``.
-Releases are done by running either ``build.sh`` or ``build.bat``. These are bash and batch scripts, respectively, that automatically build Python source packages and `Python Wheels <http://pythonwheels.com/>`__, then upload them to PyPI.
+Releases are done by running ``build.sh`` to build the Python source packages, sign them, and upload them to PyPI.
Testing
~~~~~~~
@@ -256,9 +258,9 @@ To run all the tests:
.. code:: bash
- python -m unittest discover
+ python -m unittest discover --verbose
-Testing is also done automatically by TravisCI. To set up the environment for offline/local Travis-like testing on a Debian-like system:
+Testing is also done automatically by TravisCI, upon every push. To set up the environment for offline/local Travis-like testing on a Debian-like system:
.. code:: bash
@@ -30,7 +30,7 @@ Once installed, you can simply specify the language using the ``language`` param
Building PocketSphinx-Python from source
----------------------------------------
-For Windows, it is recommended to install the precompiled Wheel packages. These are provided because building Pocketsphinx on Windows requires a lot of work, and can take hours to download and install all the surrounding software.
+For Windows, it is recommended to install the precompiled Wheel packages in the ``third-party`` directory. These are provided because building Pocketsphinx on Windows requires a lot of work, and can take hours to download and install all the surrounding software.
For Linux and other POSIX systems (like OS X), you'll want to build from source. It should take less than two minutes on a fast machine.

0 comments on commit a48e7f9

Please sign in to comment.