ggerganov commited on
Commit
7fa6853
·
1 Parent(s): 7a4a7a1

Update README.md

Browse files
Files changed (1) hide show
  1. examples/main/README.md +26 -0
examples/main/README.md CHANGED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # main
2
+
3
+ This is the main example demonstrating most of the functionality of the Whisper model.
4
+ It can be used as a reference for using the `whisper.cpp` library in other projects.
5
+
6
+ ```
7
+ ./main -h
8
+
9
+ usage: ./main [options] file0.wav file1.wav ...
10
+
11
+ options:
12
+ -h, --help show this help message and exit
13
+ -s SEED, --seed SEED RNG seed (default: -1)
14
+ -t N, --threads N number of threads to use during computation (default: 4)
15
+ -o N, --offset N offset in milliseconds (default: 0)
16
+ -v, --verbose verbose output
17
+ --translate translate from source language to english
18
+ -otxt, --output-txt output result in a text file
19
+ -ovtt, --output-vtt output result in a vtt file
20
+ -osrt, --output-srt output result in a srt file
21
+ -ps, --print_special print special tokens
22
+ -nt, --no_timestamps do not print timestamps
23
+ -l LANG, --language LANG spoken language (default: en)
24
+ -m FNAME, --model FNAME model path (default: models/ggml-base.en.bin)
25
+ -f FNAME, --file FNAME input WAV file path
26
+ ```