Skip to content

Distribute and run LLMs with a single file.

Add README to whisperfile

Justine Tunney05493179b704
diff --git a/whisper.cpp/LICENSE b/whisper.cpp/LICENSE
new file mode 100644
index 00000000..acb96ce7
--- /dev/null
+++ b/whisper.cpp/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-2024 The ggml authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/whisper.cpp/README.md b/whisper.cpp/README.md
new file mode 100644
index 00000000..499ea1c9
--- /dev/null
+++ b/whisper.cpp/README.md
@@ -0,0 +1,35 @@
+# whisperfile
+
+whisperfile lets you turn .wav files into .txt files,
+using a single file.
+
+## Getting Started
+
+You can use the tiny model. Here's JFK talking.
+
+```
+wget -O whisper-tiny.en-q5_1.bin https://huggingface.co/ggerganov/whisper.cpp/resolve/main/ggml-tiny.en-q5_1.bin
+make -j o//whisper.cpp
+o//whisper.cpp/main -m whisper-tiny.en-q5_1.bin -f whisper.cpp/jfk.wav --no-prints
+```
+
+Here's how you turn an Edgar Allen Poe MP3 into a WAV file.
+
+```
+sudo apt install sox libsox-fmt-all
+wget https://archive.org/download/raven/raven_poe_64kb.mp3
+sox raven_poe_64kb.mp3 -r 16k raven_poe_64kb.wav
+```
+
+Then you can use the large model, which is the best.
+
+```
+wget -O whisper-large-v3.bin https://huggingface.co/ggerganov/whisper.cpp/resolve/main/ggml-large-v3.bin
+o//whisper.cpp/main -m whisper-large-v3.bin -f raven_poe_64kb.wav --no-prints
+```
+
+## GPU Support
+
+Pass the `--gpu auto` flag to use GPU mode. This is currently
+experimental. It appears to be working with `whisper-tiny.en-q5_1.bin`
+but isn't reliable yet for the F16 models.
diff --git a/whisper.cpp/jfk.wav b/whisper.cpp/jfk.wav
new file mode 100644
index 00000000..3184d372
Binary files /dev/null and b/whisper.cpp/jfk.wav differ