danbev commited on
Commit
b332af9
·
unverified ·
1 Parent(s): 1526565

examples : clarify Core ML encoder model usage [no ci] (#2987)

Browse files

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 CHANGED
@@ -30,4 +30,6 @@ mkdir models/ggml-base.en-encoder.mlmodelc
30
 
31
  Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the model.
32
  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.
 
 
 
30
 
31
  Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the model.
32
  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. 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 CHANGED
@@ -34,7 +34,9 @@ sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
34
  **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.
35
 
36
  ### Core ML support
37
- 1. Follow all the steps in the `Usage` section, including adding the ggml model file.
 
 
38
  2. Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the
39
  model.
40
  3. Add the Core ML model (`models/ggml-base.en-encoder.mlmodelc/`) to `whisper.swiftui.demo/Resources/models` **via Xcode**.
 
34
  **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.
35
 
36
  ### Core ML support
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.
40
  2. Follow the [`Core ML support` section of readme](../../README.md#core-ml-support) to convert the
41
  model.
42
  3. Add the Core ML model (`models/ggml-base.en-encoder.mlmodelc/`) to `whisper.swiftui.demo/Resources/models` **via Xcode**.