Spaces:
Sleeping
Sleeping
Jonno
commited on
whisper.swiftui : update README.md (#682)
Browse files- Slight tweaks to README for improved comprehension.
examples/whisper.swiftui/README.md
CHANGED
|
@@ -1,15 +1,18 @@
|
|
| 1 |
A sample SwiftUI app using [whisper.cpp](https://github.com/ggerganov/whisper.cpp/) to do voice-to-text transcriptions.
|
| 2 |
See also: [whisper.objc](https://github.com/ggerganov/whisper.cpp/tree/master/examples/whisper.objc).
|
| 3 |
|
| 4 |
-
|
| 5 |
|
| 6 |
1. Select a model from the [whisper.cpp repository](https://github.com/ggerganov/whisper.cpp/tree/master/models).[^1]
|
| 7 |
-
2. Add the model to
|
| 8 |
3. Select a sample audio file (for example, [jfk.wav](https://github.com/ggerganov/whisper.cpp/raw/master/samples/jfk.wav)).
|
| 9 |
-
4. Add the
|
| 10 |
5. Select the "Release" [^2] build configuration under "Run", then deploy and run to your device.
|
| 11 |
|
|
|
|
|
|
|
| 12 |
[^1]: I recommend the tiny, base or small models for running on an iOS device.
|
|
|
|
| 13 |
[^2]: The `Release` build can boost performance of transcription. In this project, it also added `-O3 -DNDEBUG` to `Other C Flags`, but adding flags to app proj is not ideal in real world (applies to all C/C++ files), consider splitting xcodeproj in workspace in your own project.
|
| 14 |
|
| 15 |

|
|
|
|
| 1 |
A sample SwiftUI app using [whisper.cpp](https://github.com/ggerganov/whisper.cpp/) to do voice-to-text transcriptions.
|
| 2 |
See also: [whisper.objc](https://github.com/ggerganov/whisper.cpp/tree/master/examples/whisper.objc).
|
| 3 |
|
| 4 |
+
**Usage**:
|
| 5 |
|
| 6 |
1. Select a model from the [whisper.cpp repository](https://github.com/ggerganov/whisper.cpp/tree/master/models).[^1]
|
| 7 |
+
2. Add the model to `whisper.swiftui.demo/Resources/models` **via Xcode**.
|
| 8 |
3. Select a sample audio file (for example, [jfk.wav](https://github.com/ggerganov/whisper.cpp/raw/master/samples/jfk.wav)).
|
| 9 |
+
4. Add the sample audio file to `whisper.swiftui.demo/Resources/samples` **via Xcode**.
|
| 10 |
5. Select the "Release" [^2] build configuration under "Run", then deploy and run to your device.
|
| 11 |
|
| 12 |
+
**Note:** Pay attention to the folder path: `whisper.swiftui.demo/Resources/models` is the appropriate directory to place resources whilst `whisper.swiftui.demo/Models` is related to actual code.
|
| 13 |
+
|
| 14 |
[^1]: I recommend the tiny, base or small models for running on an iOS device.
|
| 15 |
+
|
| 16 |
[^2]: The `Release` build can boost performance of transcription. In this project, it also added `-O3 -DNDEBUG` to `Other C Flags`, but adding flags to app proj is not ideal in real world (applies to all C/C++ files), consider splitting xcodeproj in workspace in your own project.
|
| 17 |
|
| 18 |

|