Skip to content

Commit 988dcd4

Browse files
authored
docs : Update cli documentation (#3102)
* docs : Update cli documentation This updates the documentation of cli based on the actual output In the longterm this should ideally be auto generated to prevent mismatch * docs : Update cli documentation This updates the documentation of cli based on the actual output In the longterm this should ideally be auto generated to prevent mismatch
1 parent 9f540ad commit 988dcd4

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

examples/cli/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ It can be used as a reference for using the `whisper.cpp` library in other proje
66
```
77
./build/bin/whisper-cli -h
88
9-
usage: ./build-pkg/bin/whisper-cli [options] file0.wav file1.wav ...
9+
usage: ./build/bin/whisper-cli [options] file0 file1 ...
10+
supported audio formats: flac, mp3, ogg, wav
1011
1112
options:
1213
-h, --help [default] show this help message and exit
@@ -24,6 +25,7 @@ options:
2425
-wt N, --word-thold N [0.01 ] word timestamp probability threshold
2526
-et N, --entropy-thold N [2.40 ] entropy threshold for decoder fail
2627
-lpt N, --logprob-thold N [-1.00 ] log probability threshold for decoder fail
28+
-nth N, --no-speech-thold N [0.60 ] no speech threshold
2729
-tp, --temperature N [0.00 ] The sampling temperature, between 0 and 1
2830
-tpi, --temperature-inc N [0.20 ] The increment of temperature, between 0 and 1
2931
-debug, --debug-mode [false ] enable debug mode (eg. dump log_mel)
@@ -50,12 +52,13 @@ options:
5052
-dl, --detect-language [false ] exit after automatically detecting language
5153
--prompt PROMPT [ ] initial prompt (max n_text_ctx/2 tokens)
5254
-m FNAME, --model FNAME [models/ggml-base.en.bin] model path
53-
-f FNAME, --file FNAME [ ] input WAV file path
55+
-f FNAME, --file FNAME [ ] input audio file path
5456
-oved D, --ov-e-device DNAME [CPU ] the OpenVINO device used for encode inference
5557
-dtw MODEL --dtw MODEL [ ] compute token-level timestamps
5658
-ls, --log-score [false ] log best decoder scores of tokens
5759
-ng, --no-gpu [false ] disable GPU
5860
-fa, --flash-attn [false ] flash attention
61+
-sns, --suppress-nst [false ] suppress non-speech tokens
5962
--suppress-regex REGEX [ ] regular expression matching tokens to suppress
6063
--grammar GRAMMAR [ ] GBNF grammar to guide decoding
6164
--grammar-rule RULE [ ] top-level GBNF grammar rule name

0 commit comments

Comments
 (0)