Spaces:
Running
Running
docs : Update cli documentation (#3102)
Browse files* 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
- examples/cli/README.md +5 -2
examples/cli/README.md
CHANGED
|
@@ -6,7 +6,8 @@ It can be used as a reference for using the `whisper.cpp` library in other proje
|
|
| 6 |
```
|
| 7 |
./build/bin/whisper-cli -h
|
| 8 |
|
| 9 |
-
usage: ./build
|
|
|
|
| 10 |
|
| 11 |
options:
|
| 12 |
-h, --help [default] show this help message and exit
|
|
@@ -24,6 +25,7 @@ options:
|
|
| 24 |
-wt N, --word-thold N [0.01 ] word timestamp probability threshold
|
| 25 |
-et N, --entropy-thold N [2.40 ] entropy threshold for decoder fail
|
| 26 |
-lpt N, --logprob-thold N [-1.00 ] log probability threshold for decoder fail
|
|
|
|
| 27 |
-tp, --temperature N [0.00 ] The sampling temperature, between 0 and 1
|
| 28 |
-tpi, --temperature-inc N [0.20 ] The increment of temperature, between 0 and 1
|
| 29 |
-debug, --debug-mode [false ] enable debug mode (eg. dump log_mel)
|
|
@@ -50,12 +52,13 @@ options:
|
|
| 50 |
-dl, --detect-language [false ] exit after automatically detecting language
|
| 51 |
--prompt PROMPT [ ] initial prompt (max n_text_ctx/2 tokens)
|
| 52 |
-m FNAME, --model FNAME [models/ggml-base.en.bin] model path
|
| 53 |
-
-f FNAME, --file FNAME [ ] input
|
| 54 |
-oved D, --ov-e-device DNAME [CPU ] the OpenVINO device used for encode inference
|
| 55 |
-dtw MODEL --dtw MODEL [ ] compute token-level timestamps
|
| 56 |
-ls, --log-score [false ] log best decoder scores of tokens
|
| 57 |
-ng, --no-gpu [false ] disable GPU
|
| 58 |
-fa, --flash-attn [false ] flash attention
|
|
|
|
| 59 |
--suppress-regex REGEX [ ] regular expression matching tokens to suppress
|
| 60 |
--grammar GRAMMAR [ ] GBNF grammar to guide decoding
|
| 61 |
--grammar-rule RULE [ ] top-level GBNF grammar rule name
|
|
|
|
| 6 |
```
|
| 7 |
./build/bin/whisper-cli -h
|
| 8 |
|
| 9 |
+
usage: ./build/bin/whisper-cli [options] file0 file1 ...
|
| 10 |
+
supported audio formats: flac, mp3, ogg, wav
|
| 11 |
|
| 12 |
options:
|
| 13 |
-h, --help [default] show this help message and exit
|
|
|
|
| 25 |
-wt N, --word-thold N [0.01 ] word timestamp probability threshold
|
| 26 |
-et N, --entropy-thold N [2.40 ] entropy threshold for decoder fail
|
| 27 |
-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
|
| 29 |
-tp, --temperature N [0.00 ] The sampling temperature, between 0 and 1
|
| 30 |
-tpi, --temperature-inc N [0.20 ] The increment of temperature, between 0 and 1
|
| 31 |
-debug, --debug-mode [false ] enable debug mode (eg. dump log_mel)
|
|
|
|
| 52 |
-dl, --detect-language [false ] exit after automatically detecting language
|
| 53 |
--prompt PROMPT [ ] initial prompt (max n_text_ctx/2 tokens)
|
| 54 |
-m FNAME, --model FNAME [models/ggml-base.en.bin] model path
|
| 55 |
+
-f FNAME, --file FNAME [ ] input audio file path
|
| 56 |
-oved D, --ov-e-device DNAME [CPU ] the OpenVINO device used for encode inference
|
| 57 |
-dtw MODEL --dtw MODEL [ ] compute token-level timestamps
|
| 58 |
-ls, --log-score [false ] log best decoder scores of tokens
|
| 59 |
-ng, --no-gpu [false ] disable GPU
|
| 60 |
-fa, --flash-attn [false ] flash attention
|
| 61 |
+
-sns, --suppress-nst [false ] suppress non-speech tokens
|
| 62 |
--suppress-regex REGEX [ ] regular expression matching tokens to suppress
|
| 63 |
--grammar GRAMMAR [ ] GBNF grammar to guide decoding
|
| 64 |
--grammar-rule RULE [ ] top-level GBNF grammar rule name
|