Skip to main content

Whisper for your microphone

Project description

Whisper Mic

This repo is based on the work done here by OpenAI. This repo allows you use use a mic as demo. This repo copies some of the README from the original project.

Video Tutorial

The latest video tutorial for this repo can be seen here

An older video tutorial for this repo can be seen here

Professional Assistance

If are in need of paid professional help, that is available through this email

Setup

Now a pip package!

  1. Create a venv of your choice.
  2. Run pip install whisper-mic

Available models and languages

There are five model sizes, four with English-only versions, offering speed and accuracy tradeoffs. Below are the names of the available models and their approximate memory requirements and relative speed.

Size Parameters English-only model Multilingual model Required VRAM Relative speed
tiny 39 M tiny.en tiny ~1 GB ~32x
base 74 M base.en base ~1 GB ~16x
small 244 M small.en small ~2 GB ~6x
medium 769 M medium.en medium ~5 GB ~2x
large 1550 M N/A large ~10 GB 1x

For English-only applications, the .en models tend to perform better, especially for the tiny.en and base.en models. We observed that the difference becomes less significant for the small.en and medium.en models.

Microphone Demo

You can use the model with a microphone using the whisper_mic program. Use -h to see flag options.

Some of the more important flags are the --model and --english flags.

Transcribing To A File

Using the command: whisper_mic --loop --dictate will type the words you say on your active cursor.

Usage In Other Projects

You can use this code in other projects rather than just use it for a demo. You can do this with the listen method.

from whisper_mic import WhisperMic

mic = WhisperMic()
result = mic.listen()
print(result)

Check out what the possible arguments are by looking at the cli.py file

Troubleshooting

If you are having issues, try the following:

sudo apt install portaudio19-dev python3-pyaudio

Contributing

Some ideas that you can add are:

  1. Supporting different implementations of Whisper
  2. Adding additional optional functionality.
  3. Use Pyaudio to get the audio for the listen method to speed things up

License

The model weights of Whisper are released under the MIT License. See their repo for more information.

This code under this repo is under the MIT license. See LICENSE for further details.

Thanks

Until recently, access to high performing speech to text models was only available through paid serviecs. With this release, I am excited for the many applications that will come.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whisper_mic-1.4.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

whisper_mic-1.4.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file whisper_mic-1.4.0.tar.gz.

File metadata

  • Download URL: whisper_mic-1.4.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for whisper_mic-1.4.0.tar.gz
Algorithm Hash digest
SHA256 b2f513749bfbfc081432a3594ea3ba1c66d41f41e098e32a2c822b5c5a765373
MD5 5e82af84c238ec9ebe17842b4b59fc01
BLAKE2b-256 6aa2d03f4e9ac3561265ce23de7a7d25b6f98fa3e4e4dd3b3b3a457861548eec

See more details on using hashes here.

File details

Details for the file whisper_mic-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: whisper_mic-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for whisper_mic-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee1f90c71363215ebdd4e3f98e4c6800597bb25cc9bbed1223af134570348e4b
MD5 3384e10e1d55492df618112ee2042ec8
BLAKE2b-256 1ac3270707733591f9bb1518d5fb3bc918c3b5b98f391af66d8268900b6c0a33

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page