Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed #993 #1003

Merged
merged 3 commits into from
Nov 24, 2017
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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. (See the release notes to find which GPU's are supported.) This is done by instead installing the GPU specific package:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also mention that it's Linux only.


```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 (See the release notes to find which GPU's are supported.), you can install the GPU specific package as follows:

```
pip install deepspeech-gpu
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Include the $ here for consistency.

```

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