Skip to content

Commit

Permalink
Merge pull request #1003 from mozilla/issue993
Browse files Browse the repository at this point in the history
Fixed #993
  • Loading branch information
reuben authored Nov 24, 2017
2 parents d686973 + bcf1b83 commit 10761d6
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,23 @@ Project DeepSpeech is an open source Speech-To-Text engine. It uses a model trai

![Usage](images/usage.gif)

Pre-built binaries that can be used for performing inference with a trained model can be installed with `pip`. Proper setup using virtual environment is recommended and you can find that documented [below](#using-the-python-package). You can then use the `deepspeech` binary to do speech-to-text on an audio file:
Pre-built binaries that can be used for performing inference with a trained model can be installed with `pip`. Proper setup using virtual environment is recommended and you can find that documented [below](#using-the-python-package).

Once installed you can then use the `deepspeech` binary to do speech-to-text on an audio file:

```bash
pip install deepspeech
deepspeech output_model.pb my_audio_file.wav alphabet.txt
```

See the output of `deepspeech -h` for more information.
Alternatively, quicker inference can be performed using a supported NVIDIA GPU on Linux. (See the release notes to find which GPU's are supported.) This is done by instead installing the GPU specific package:

```bash
pip install deepspeech-gpu
deepspeech output_model.pb my_audio_file.wav alphabet.txt
```

See the output of `deepspeech -h` for more information on the use of `deepspeech`.

**Table of Contents**

Expand Down Expand Up @@ -88,6 +97,17 @@ If it is already installed, you can also update it:
$ pip install --upgrade deepspeech
```

Alternatively, if you have a supported NVIDIA GPU on Linux (See the release notes to find which GPU's are supported.), you can install the GPU specific package as follows:

```
$ pip install deepspeech-gpu
```

or update it as folllows:
```
$ pip install --upgrade deepspeech-gpu
```

In both cases, it should take care of intalling all the required dependencies. Once it is done, you should be able to call the sample binary using `deepspeech` on your command-line.

```bash
Expand Down

0 comments on commit 10761d6

Please sign in to comment.