Skip to content

Commit e843749

Browse files
committed
update readme with android info
1 parent 2e0fc05 commit e843749

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ but we are continuing to invest in Android and now welcome contributions from th
2121
- [Installation](#installation)
2222
- [Getting Started](#getting-started)
2323
- [CLI Run and Test](#cli-run-and-test)
24+
- [Running Android app](#running-android-app)
2425
- [Contributing \& Roadmap](#contributing--roadmap)
2526
- [License](#license)
2627
- [Citation](#citation)
@@ -153,6 +154,22 @@ Transcription: And so, my fellow Americans, ask not what your country can do f
153154
```
154155
</details>
155156

157+
# Running Android App
158+
159+
<details>
160+
<summary> (Click to expand) </summary>
161+
162+
1. Move model to assets folder
163+
Download the models if you haven't done so as specified in the Installation section. Move specifically the "whisper_tiny" folder into the assets folder of the app.
164+
165+
2. Run the app with Android Studio
166+
167+
3. Things to consider.
168+
QNN will only work if the SoC of your device is among the supported ones listed in the C++ code. The model may take a couple minutes to load when using QNN delegate.
169+
After recording with the microphone, the input is saved into the MicInput.wav file, you can select it to transcribe your audio.
170+
171+
</details>
172+
156173
## Contributing
157174

158175
WhisperKit Android is currently in the v0.1 Beta stage. We are actively developing the project and welcome contributions from the community.

0 commit comments

Comments
 (0)