Skip to content

Commit

Permalink
added .gif example to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NathanCorral committed Nov 19, 2024
1 parent 999affe commit 14a5a62
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,36 @@ Topics of type [AudioTranscript.msg](whisper_idl/msg/AudioTranscript.msg) on `/w

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

## Example

This example shows live transcription of first minute of the 6'th chapter in ***Harry Potter and the Philosopher's Stone*** from Audible:

![harry_potter_sample](./doc/harry_potter_sample.gif)

To run this example, first download the (~4MB) file using [Git Large File Storage (LFS)](https://git-lfs.com/):

```shell
git lfs pull
```

Then launch the bringup with the audio listener component disabled:

```shell
ros2 launch whisper_bringup replay.launch.py
```

Start the stream demo:

```shell
ros2 run whisper_demos stream
```

And play the sample:

```shell
ros2 bag play src/ros2_whisper/samples/HarryPotter_Book1_Chapter6/
```

## Troubleshoot

- Encoder inference time: https://github.com/ggerganov/whisper.cpp/issues/10#issuecomment-1302462960
Binary file added doc/harry_potter_sample.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 14a5a62

Please sign in to comment.