Skip to content

Commit 14a5a62

Browse files
committed
added .gif example to readme
1 parent 999affe commit 14a5a62

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,36 @@ Topics of type [AudioTranscript.msg](whisper_idl/msg/AudioTranscript.msg) on `/w
6464

6565
Internally, the topic `/whisper/tokens` of type [WhisperTokens.msg](whisper_idl/msg/WhisperTokens.msg) is used to transfer the model output between nodes.
6666

67+
## Example
68+
69+
This example shows live transcription of first minute of the 6'th chapter in ***Harry Potter and the Philosopher's Stone*** from Audible:
70+
71+
![harry_potter_sample](./doc/harry_potter_sample.gif)
72+
73+
To run this example, first download the (~4MB) file using [Git Large File Storage (LFS)](https://git-lfs.com/):
74+
75+
```shell
76+
git lfs pull
77+
```
78+
79+
Then launch the bringup with the audio listener component disabled:
80+
81+
```shell
82+
ros2 launch whisper_bringup replay.launch.py
83+
```
84+
85+
Start the stream demo:
86+
87+
```shell
88+
ros2 run whisper_demos stream
89+
```
90+
91+
And play the sample:
92+
93+
```shell
94+
ros2 bag play src/ros2_whisper/samples/HarryPotter_Book1_Chapter6/
95+
```
96+
6797
## Troubleshoot
6898

6999
- Encoder inference time: https://github.com/ggerganov/whisper.cpp/issues/10#issuecomment-1302462960

doc/harry_potter_sample.gif

1.92 MB
Loading

0 commit comments

Comments
 (0)