You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-8Lines changed: 36 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,36 @@ If you’re looking for a hosted desktop recording API, consider checking out [R
12
12
[](https://github.com/locaal-ai/obs-localvocal/releases)
*While variants for specific versions of MacOS _may_ work better on that version of MacOS, the Generic variant is likely the best option. See [MacOS Variants](#mac-os-variants) below for more details
42
+
43
+
Check out the [latest releases](https://github.com/locaal-ai/obs-localvocal/releases) for downloads and install instructions.
44
+
22
45
## Introduction
23
46
24
47
LocalVocal lets you transcribe, locally on your machine, speech into text and simultaneously translate to any language. ✅ No GPU required, ✅ no cloud costs, ✅ no network and ✅ no downtime! Privacy first - all data stays on your machine.
@@ -67,9 +90,6 @@ Current Features:
67
90
- Partial transcriptions for a streaming-captions experience
68
91
- 100s of fine-tuned Whisper models for dozens of languages from HuggingFace
69
92
70
-
## Download
71
-
Check out the [latest releases](https://github.com/locaal-ai/obs-localvocal/releases) for downloads and install instructions.
72
-
73
93
### Available Versions
74
94
75
95
LocalVocal is available in multiple versions to cater to different hardware configurations and operating systems. Below is a brief explanation of the different versions you can download:
@@ -139,6 +159,14 @@ These variants come with the following backends available:
139
159
* Metal - Uses the system's GPU for accelerated processing
140
160
* CoreML - Special backend that uses Apple's CoreML instead of Whisper's normal model processing, running on either the Metal or CPU backends
141
161
162
+
The Generic MacOS version embeds the Metal shaders into whisper.cpp as intermediate bytecode, which is compiled at runtime for the computer and GPU being used. This is probably the best version to use unless you have a reason to use the others, and may be able to take advantage of newer features in Metal 4 in MacOS Tahoe
163
+
164
+
Variants with Metal shaders pre-compiled for specific [Metal API versions](https://support.apple.com/en-gb/102894) which may or may not work slightly better on the appropriate version of MacOS:
165
+
* MacOS 12 - Metal 2.4
166
+
* MacOS 13 - Metal 3.0
167
+
* MacOS 14 - Metal 3.1
168
+
* MacOS 15 - Metal 3.2
169
+
142
170
### Models
143
171
The plugin ships with the Tiny.en model, and will autonomously download other Whisper models through a dropdown.
144
172
There's also an option to select an external GGML Whisper model file if you have it on disk.
0 commit comments