ggerganov commited on
Commit
5db8087
·
1 Parent(s): 0c70188

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +11 -5
README.md CHANGED
@@ -59,9 +59,9 @@ For a quick demo, simply run `make base.en`:
59
  ```java
60
  $ make base.en
61
 
62
- cc -O3 -std=c11 -Wall -Wextra -Wno-unused-parameter -Wno-unused-function -pthread -DGGML_USE_ACCELERATE -c ggml.c
63
- c++ -O3 -std=c++11 -Wall -Wextra -Wno-unused-parameter -Wno-unused-function -pthread -c whisper.cpp
64
- c++ -O3 -std=c++11 -Wall -Wextra -Wno-unused-parameter -Wno-unused-function -pthread main.cpp whisper.o ggml.o -o main -framework Accelerate
65
  ./main -h
66
 
67
  usage: ./main [options] file0.wav file1.wav ...
@@ -70,13 +70,15 @@ options:
70
  -h, --help show this help message and exit
71
  -s SEED, --seed SEED RNG seed (default: -1)
72
  -t N, --threads N number of threads to use during computation (default: 4)
73
- -o N, --offset N offset in milliseconds (default: 0)
 
74
  -v, --verbose verbose output
75
  --translate translate from source language to english
76
  -otxt, --output-txt output result in a text file
77
  -ovtt, --output-vtt output result in a vtt file
78
  -osrt, --output-srt output result in a srt file
79
  -ps, --print_special print special tokens
 
80
  -nt, --no_timestamps do not print timestamps
81
  -l LANG, --language LANG spoken language (default: en)
82
  -m FNAME, --model FNAME model path (default: models/ggml-base.en.bin)
@@ -84,7 +86,7 @@ options:
84
 
85
  bash ./models/download-ggml-model.sh base.en
86
  Downloading ggml model base.en ...
87
- models/ggml-base.en.bin 100%[=============================================>] 141.11M 3.13MB/s in 79s
88
  Done! Model 'base.en' saved in 'models/ggml-base.en.bin'
89
  You can now use it like this:
90
 
@@ -326,3 +328,7 @@ For more details, see the conversion script [models/convert-pt-to-ggml.py](model
326
  - [X] Rust: [tazz4843/whisper-rs](https://github.com/tazz4843/whisper-rs)
327
  - [ ] Python:
328
  - [ ] Java:
 
 
 
 
 
59
  ```java
60
  $ make base.en
61
 
62
+ cc -I. -O3 -std=c11 -pthread -DGGML_USE_ACCELERATE -c ggml.c
63
+ c++ -I. -I./examples -O3 -std=c++11 -pthread -c whisper.cpp
64
+ c++ -I. -I./examples -O3 -std=c++11 -pthread examples/main/main.cpp whisper.o ggml.o -o main -framework Accelerate
65
  ./main -h
66
 
67
  usage: ./main [options] file0.wav file1.wav ...
 
70
  -h, --help show this help message and exit
71
  -s SEED, --seed SEED RNG seed (default: -1)
72
  -t N, --threads N number of threads to use during computation (default: 4)
73
+ -ot N, --offset-t N time offset in milliseconds (default: 0)
74
+ -on N, --offset-n N segment index offset (default: 0)
75
  -v, --verbose verbose output
76
  --translate translate from source language to english
77
  -otxt, --output-txt output result in a text file
78
  -ovtt, --output-vtt output result in a vtt file
79
  -osrt, --output-srt output result in a srt file
80
  -ps, --print_special print special tokens
81
+ -pc, --print_colors print colors
82
  -nt, --no_timestamps do not print timestamps
83
  -l LANG, --language LANG spoken language (default: en)
84
  -m FNAME, --model FNAME model path (default: models/ggml-base.en.bin)
 
86
 
87
  bash ./models/download-ggml-model.sh base.en
88
  Downloading ggml model base.en ...
89
+ ggml-base.en.bin 100%[========================>] 141.11M 6.34MB/s in 24s
90
  Done! Model 'base.en' saved in 'models/ggml-base.en.bin'
91
  You can now use it like this:
92
 
 
328
  - [X] Rust: [tazz4843/whisper-rs](https://github.com/tazz4843/whisper-rs)
329
  - [ ] Python:
330
  - [ ] Java:
331
+
332
+ ## Examples
333
+
334
+ There are various examples of using the library for different projects in the [examples](examples) folder. Check them out!