Skip to content

Commit f457268

Browse files
authored
Merge pull request #121 from absadiki/fix/ui-freeze-gil-release
fix(bindings): release GIL to prevent blocking the Python thread #120
2 parents cf700a8 + e342cf2 commit f457268

File tree

4 files changed

+862
-30
lines changed

4 files changed

+862
-30
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Python bindings for [whisper.cpp](https://github.com/ggerganov/whisper.cpp) with
1717
* [Quick start](#quick-start)
1818
* [Examples](#examples)
1919
* [CLI](#cli)
20+
* [GUI](#gui)
2021
* [Assistant](#assistant)
2122
* [Advanced usage](#advanced-usage)
2223
* [Discussions and contributions](#discussions-and-contributions)
@@ -227,8 +228,26 @@ options:
227228

228229
```
229230

230-
## Assistant
231+
## GUI
232+
If you prefer a Graphical User Interface, you can use the `pwcpp-gui` command which will launch A simple graphical interface built with PyQt5.
233+
* First you need to install the GUI dependencies:
234+
```bash
235+
pip install pywhispercpp[gui]
236+
```
237+
238+
* Then you can run the GUI with:
239+
```bash
240+
pwcpp-gui
241+
```
231242

243+
The GUI provides a user-friendly way to:
244+
245+
- Select audio files
246+
- Choose models
247+
- Adjust basic transcription settings
248+
- View and export transcription results
249+
250+
## Assistant
232251
This is a simple example showcasing the use of `pywhispercpp` to create an assistant like example.
233252
The idea is to use a Voice Activity Detector (VAD) to detect speech (in this example, we used webrtcvad), and when some speech is detected, we run the transcription.
234253
It is inspired from the [whisper.cpp/examples/command](https://github.com/ggerganov/whisper.cpp/tree/master/examples/command) example.
@@ -284,4 +303,3 @@ If you have any feedback, or you want to share how you are using this project, f
284303
# License
285304

286305
This project is licensed under the same license as [whisper.cpp](https://github.com/ggerganov/whisper.cpp/blob/master/LICENSE) (MIT [License](./LICENSE)).
287-

0 commit comments

Comments
 (0)