]> git.djapps.eu Git - pkg/ggml/sources/whisper.cpp/commitdiff
command : add "guided-mode" video demo in the README.md
authorGeorgi Gerganov <redacted>
Fri, 6 Jan 2023 16:59:26 +0000 (18:59 +0200)
committerGitHub <redacted>
Fri, 6 Jan 2023 16:59:26 +0000 (18:59 +0200)
examples/command/README.md

index 551409201cac734f629e2b7213a290fd1e1d436d..d291d1aa6a3eef37e693a2e3bcec258cab7cb67c 100644 (file)
@@ -9,7 +9,19 @@ More info is available in [issue #171](https://github.com/ggerganov/whisper.cpp/
 \r
 # On Raspberry Pi, use tiny or base models + "-ac 768" for better performance\r
 ./command -m ./models/ggml-tiny.en.bin -ac 768 -t 3 -c 0\r
+```\r
+\r
+https://user-images.githubusercontent.com/1991296/204038393-2f846eae-c255-4099-a76d-5735c25c49da.mp4\r
+\r
+Web version: [examples/command.wasm](/examples/command.wasm)\r
+\r
+## Guided mode\r
 \r
+"Guided mode" allows you to specify a list of commands (i.e. strings) and the transcription will be guided to classify your command into one from the list. This can be useful in situations where a device is listening only for a small subset of commands.\r
+\r
+Initial tests show that this approach might be extremely efficient in terms of performance, since it integrates very well with the "partial Encoder" idea from #137.\r
+\r
+```bash\r
 # Run in guided mode, the list of allowed commands is in commands.txt\r
 ./command -m ./models/ggml-base.en.bin -cmd ./examples/command/commands.txt\r
 \r
@@ -17,9 +29,8 @@ More info is available in [issue #171](https://github.com/ggerganov/whisper.cpp/
 ./command -m ./models/ggml-tiny.en.bin -cmd ./examples/command/commands.txt -ac 128 -t 3 -c 0\r
 ```\r
 \r
-https://user-images.githubusercontent.com/1991296/204038393-2f846eae-c255-4099-a76d-5735c25c49da.mp4\r
+https://user-images.githubusercontent.com/1991296/207435352-8fc4ed3f-bde5-4555-9b8b-aeeb76bee969.mp4\r
 \r
-Web version: [examples/command.wasm](/examples/command.wasm)\r
 \r
 ## Building\r
 \r