whispering/README.md

37 lines
1.2 KiB
Markdown
Raw Normal View History

2022-09-23 10:20:11 +00:00
# whisper_streaming
[![CI](https://github.com/shirayu/whisper_streaming/actions/workflows/ci.yml/badge.svg)](https://github.com/shirayu/whisper_streaming/actions/workflows/ci.yml)
[![CodeQL](https://github.com/shirayu/whisper_streaming/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shirayu/whisper_streaming/actions/workflows/codeql-analysis.yml)
[![Typos](https://github.com/shirayu/whisper_streaming/actions/workflows/typos.yml/badge.svg)](https://github.com/shirayu/whisper_streaming/actions/workflows/typos.yml)
Streaming transcriber with [whisper](https://github.com/openai/whisper)
## Example
```bash
2022-09-23 13:19:53 +00:00
# Setup
2022-09-23 10:20:11 +00:00
git clone https://github.com/shirayu/whisper_streaming.git
cd whisper_streaming
poetry install --only main
2022-09-23 13:19:53 +00:00
# Run!
poetry run whisper_streaming --language ja --model base -n 20
2022-09-23 10:20:11 +00:00
```
2022-09-23 13:19:53 +00:00
- ``-n`` sets interval of parsing. Larger values can improve accuracy but consume more memory.
2022-09-23 10:20:11 +00:00
## Tips
If you get ``OSError: PortAudio library not found``: Install ``portaudio``
```bash
# Ubuntu
sudo apt-get install portaudio19-dev
```
## License
- [MIT License](LICENSE)
- Some codes are ported from the original whisper. Its license is also [MIT License](LICENSE.whisper)