Skip to content

Commit 854c051

Browse files
authored
examples : clarify Core ML encoder model usage [no ci] (#2987)
This commit clarifies the usage of the Core ML encoder model in the whisper.obj and whisper.swiftui examples. Refs: #2783
1 parent c8e3968 commit 854c051

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

examples/whisper.objc/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,6 @@ mkdir models/ggml-base.en-encoder.mlmodelc
3030

3131
Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the model.
3232
That is all the needs to be done to use the Core ML model in the app. The converted model is a
33-
resource in the project and will be used if it is available.
33+
resource in the project and will be used if it is available. Note that the Core ML model is only
34+
used for the encoder, the decoder which is in the ggml model is still required so both need to
35+
be available.

examples/whisper.swiftui/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
3434
**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.
3535

3636
### Core ML support
37-
1. Follow all the steps in the `Usage` section, including adding the ggml model file.
37+
1. Follow all the steps in the `Usage` section, including adding the ggml model file.
38+
The ggml model file is required as the Core ML model is only used for the encoder. The
39+
decoder which is in the ggml model is still required.
3840
2. Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the
3941
model.
4042
3. Add the Core ML model (`models/ggml-base.en-encoder.mlmodelc/`) to `whisper.swiftui.demo/Resources/models` **via Xcode**.

0 commit comments

Comments
 (0)