ggerganov commited on
Commit
c9dec6f
·
unverified ·
1 Parent(s): 2c3f7d4

command : add "guided-mode" video demo in the README.md

Browse files
Files changed (1) hide show
  1. examples/command/README.md +13 -2
examples/command/README.md CHANGED
@@ -9,7 +9,19 @@ More info is available in [issue #171](https://github.com/ggerganov/whisper.cpp/
9
 
10
  # On Raspberry Pi, use tiny or base models + "-ac 768" for better performance
11
  ./command -m ./models/ggml-tiny.en.bin -ac 768 -t 3 -c 0
 
 
 
 
 
 
 
12
 
 
 
 
 
 
13
  # Run in guided mode, the list of allowed commands is in commands.txt
14
  ./command -m ./models/ggml-base.en.bin -cmd ./examples/command/commands.txt
15
 
@@ -17,9 +29,8 @@ More info is available in [issue #171](https://github.com/ggerganov/whisper.cpp/
17
  ./command -m ./models/ggml-tiny.en.bin -cmd ./examples/command/commands.txt -ac 128 -t 3 -c 0
18
  ```
19
 
20
- https://user-images.githubusercontent.com/1991296/204038393-2f846eae-c255-4099-a76d-5735c25c49da.mp4
21
 
22
- Web version: [examples/command.wasm](/examples/command.wasm)
23
 
24
  ## Building
25
 
 
9
 
10
  # On Raspberry Pi, use tiny or base models + "-ac 768" for better performance
11
  ./command -m ./models/ggml-tiny.en.bin -ac 768 -t 3 -c 0
12
+ ```
13
+
14
+ https://user-images.githubusercontent.com/1991296/204038393-2f846eae-c255-4099-a76d-5735c25c49da.mp4
15
+
16
+ Web version: [examples/command.wasm](/examples/command.wasm)
17
+
18
+ ## Guided mode
19
 
20
+ "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.
21
+
22
+ 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.
23
+
24
+ ```bash
25
  # Run in guided mode, the list of allowed commands is in commands.txt
26
  ./command -m ./models/ggml-base.en.bin -cmd ./examples/command/commands.txt
27
 
 
29
  ./command -m ./models/ggml-tiny.en.bin -cmd ./examples/command/commands.txt -ac 128 -t 3 -c 0
30
  ```
31
 
32
+ https://user-images.githubusercontent.com/1991296/207435352-8fc4ed3f-bde5-4555-9b8b-aeeb76bee969.mp4
33
 
 
34
 
35
  ## Building
36