Updated README

This commit is contained in:
Yuta Hayashibe 2022-09-24 09:38:40 +09:00
parent 7b21d53cbf
commit 38006d8257

View file

@ -5,7 +5,8 @@
[![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)
Streaming transcriber with [whisper](https://github.com/openai/whisper).
Transcribing in real time, enough machine power is needed.
## Example
@ -19,6 +20,7 @@ poetry install --only main
poetry run whisper_streaming --language en --model base -n 20
```
- ``--help`` shows full options
- ``--language`` sets the language to transcribe. The list of languages are shown with ``poetry run whisper_streaming -h``
- ``-n`` sets interval of parsing. Larger values can improve accuracy but consume more memory.
- ``--debug`` outputs logs for debug