Renamed whisper_streaming to whispering

This commit is contained in:
Yuta Hayashibe 2022-09-26 00:29:20 +09:00
parent 683571e059
commit 807dd633b0
9 changed files with 20 additions and 19 deletions

View file

@ -1,7 +1,7 @@
all: lint_node lint_python all: lint_node lint_python
TARGET_DIRS:=./whisper_streaming TARGET_DIRS:=./whispering
flake8: flake8:
find $(TARGET_DIRS) | grep '\.py$$' | xargs flake8 find $(TARGET_DIRS) | grep '\.py$$' | xargs flake8

View file

@ -1,20 +1,21 @@
# whisper_streaming # Whispering
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](LICENSE) [![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](LICENSE)
[![Python Versions](https://img.shields.io/badge/Python-3.8%20--%203.10-blue)](https://pypi.org/project/bunkai/) [![Python Versions](https://img.shields.io/badge/Python-3.8%20--%203.10-blue)](https://pypi.org/project/bunkai/)
[![CI](https://github.com/shirayu/whisper_streaming/actions/workflows/ci.yml/badge.svg)](https://github.com/shirayu/whisper_streaming/actions/workflows/ci.yml) [![CI](https://github.com/shirayu/whispering/actions/workflows/ci.yml/badge.svg)](https://github.com/shirayu/whispering/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) [![CodeQL](https://github.com/shirayu/whispering/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shirayu/whispering/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) [![Typos](https://github.com/shirayu/whispering/actions/workflows/typos.yml/badge.svg)](https://github.com/shirayu/whispering/actions/workflows/typos.yml)
Streaming transcriber with [whisper](https://github.com/openai/whisper). Streaming transcriber with [whisper](https://github.com/openai/whisper).
Former name was "whisper_streaming".
Enough machine power is needed to transcribe in real time. Enough machine power is needed to transcribe in real time.
## Setup ## Setup
```bash ```bash
pip install -U git+https://github.com/shirayu/whisper_streaming.git pip install -U git+https://github.com/shirayu/whispering.git
# If you use GPU, install proper torch and torchaudio # If you use GPU, install proper torch and torchaudio
# Example : torch for CUDA 11.6 # Example : torch for CUDA 11.6
@ -25,11 +26,11 @@ pip install -U torch torchaudio --extra-index-url https://download.pytorch.org/w
```bash ```bash
# Run in English # Run in English
whisper_streaming --language en --model tiny whispering --language en --model tiny
``` ```
- ``--help`` shows full options - ``--help`` shows full options
- ``--language`` sets the language to transcribe. The list of languages are shown with ``whisper_streaming -h`` - ``--language`` sets the language to transcribe. The list of languages are shown with ``whispering -h``
- ``-t`` sets temperatures to decode. You can set several like (``-t 0.0 -t 0.1 -t 0.5``), but too many temperatures exhaust decoding time - ``-t`` sets temperatures to decode. You can set several like (``-t 0.0 -t 0.1 -t 0.5``), but too many temperatures exhaust decoding time
- ``--debug`` outputs logs for debug - ``--debug`` outputs logs for debug
@ -39,7 +40,7 @@ If you want quick response, set small ``-n`` and add ``--allow-padding``.
However, this may sacrifice the accuracy. However, this may sacrifice the accuracy.
```bash ```bash
whisper_streaming --language en --model tiny -n 20 --allow-padding whispering --language en --model tiny -n 20 --allow-padding
``` ```
## Example of web socket ## Example of web socket
@ -51,7 +52,7 @@ Run with ``--host`` and ``--port``.
### Host ### Host
```bash ```bash
whisper_streaming --language en --model tiny --host 0.0.0.0 --port 8000 whispering --language en --model tiny --host 0.0.0.0 --port 8000
``` ```
You can set ``--allow-padding`` and other options. You can set ``--allow-padding`` and other options.
@ -59,7 +60,7 @@ You can set ``--allow-padding`` and other options.
### Client ### Client
```bash ```bash
whisper_streaming --model tiny --host ADDRESS_OF_HOST --port 8000 --mode client whispering --model tiny --host ADDRESS_OF_HOST --port 8000 --mode client
``` ```
You can set ``-n`` and other options. You can set ``-n`` and other options.

View file

@ -25,5 +25,5 @@ requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api" build-backend = "poetry.core.masonry.api"
[tool.poetry.scripts] [tool.poetry.scripts]
whisper_streaming = "whisper_streaming.cli:main" whispering = "whisper_streaming.cli:main"

View file

@ -12,10 +12,10 @@ from whisper import available_models
from whisper.audio import N_FRAMES, SAMPLE_RATE from whisper.audio import N_FRAMES, SAMPLE_RATE
from whisper.tokenizer import LANGUAGES, TO_LANGUAGE_CODE from whisper.tokenizer import LANGUAGES, TO_LANGUAGE_CODE
from whisper_streaming.schema import WhisperConfig from whispering.schema import WhisperConfig
from whisper_streaming.serve import serve_with_websocket from whispering.serve import serve_with_websocket
from whisper_streaming.transcriber import WhisperStreamingTranscriber from whispering.transcriber import WhisperStreamingTranscriber
from whisper_streaming.websocket_client import run_websocket_client from whispering.websocket_client import run_websocket_client
logger = getLogger(__name__) logger = getLogger(__name__)

View file

@ -6,7 +6,7 @@ from logging import getLogger
import numpy as np import numpy as np
import websockets import websockets
from whisper_streaming.transcriber import WhisperStreamingTranscriber from whispering.transcriber import WhisperStreamingTranscriber
logger = getLogger(__name__) logger = getLogger(__name__)

View file

@ -17,7 +17,7 @@ from whisper.decoding import DecodingOptions, DecodingResult
from whisper.tokenizer import get_tokenizer from whisper.tokenizer import get_tokenizer
from whisper.utils import exact_div from whisper.utils import exact_div
from whisper_streaming.schema import ParsedChunk, WhisperConfig from whispering.schema import ParsedChunk, WhisperConfig
logger = getLogger(__name__) logger = getLogger(__name__)

View file

@ -7,7 +7,7 @@ import sounddevice as sd
import websockets import websockets
from whisper.audio import N_FRAMES, SAMPLE_RATE from whisper.audio import N_FRAMES, SAMPLE_RATE
from whisper_streaming.schema import ParsedChunk from whispering.schema import ParsedChunk
logger = getLogger(__name__) logger = getLogger(__name__)