]> git.djapps.eu Git - pkg/ggml/sources/whisper.cpp/commitdiff
examples : clarify Core ML encoder model usage [no ci] (#2987)
authorDaniel Bevenius <redacted>
Wed, 2 Apr 2025 06:32:14 +0000 (08:32 +0200)
committerGitHub <redacted>
Wed, 2 Apr 2025 06:32:14 +0000 (08:32 +0200)
This commit clarifies the usage of the Core ML encoder model in the
whisper.obj and whisper.swiftui examples.

Refs: https://github.com/ggerganov/whisper.cpp/issues/2783

examples/whisper.objc/README.md
examples/whisper.swiftui/README.md

index 609b9603d7c5b5cbfb900f143e53d43a2f1cc874..7e790dbc684e5e5824a4e831dd507f022154f2f7 100644 (file)
@@ -30,4 +30,6 @@ mkdir models/ggml-base.en-encoder.mlmodelc
 
 Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the model.
 That is all the needs to be done to use the Core ML model in the app. The converted model is a
-resource in the project and will be used if it is available.
+resource in the project and will be used if it is available. Note that the Core ML model is only
+used for the encoder, the decoder which is in the ggml model is still required so both need to
+be available.
index 88e1c9ecb8f31d527fa28d995d1c577bdc133f7e..5b0b29188dcb2f15525a5b5a83d1e03da8dbbd62 100644 (file)
@@ -34,7 +34,9 @@ sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
 **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.
 
 ### Core ML support
-1. Follow all the steps in the `Usage` section, including adding the ggml model file.
+1. Follow all the steps in the `Usage` section, including adding the ggml model file.  
+The ggml model file is required as the Core ML model is only used for the encoder. The
+decoder which is in the ggml model is still required.
 2. Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the
 model.
 3. Add the Core ML model (`models/ggml-base.en-encoder.mlmodelc/`) to `whisper.swiftui.demo/Resources/models` **via Xcode**.