Skip to content

Commit 07859ea

Browse files
committed
Add README for unified ASR app
1 parent 5f69beb commit 07859ea

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

asr/android/AsrApp/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# ASR Demo App
2+
3+
This app demonstrates running speech recognition models on Android using ExecuTorch. It supports both **Whisper** and **Parakeet** model families.
4+
5+
## Supported Models
6+
7+
| Model | Type | Details |
8+
|-------|------|---------|
9+
| Whisper Tiny/Small/Medium (INT8/INT4) | Streaming | Requires model, tokenizer, and preprocessor |
10+
| Whisper Tiny/Small/Medium (FP32) | Streaming | Requires model, tokenizer, and preprocessor |
11+
| Parakeet TDT 0.6B (INT4) | Synchronous | Requires model and tokenizer |
12+
13+
## Export Model Files
14+
15+
- **Whisper**: Follow the instructions at https://github.com/pytorch/executorch/tree/main/examples/models/whisper
16+
- **Parakeet**: Follow the instructions at https://github.com/pytorch/executorch/tree/main/examples/models/parakeet
17+
18+
## Run the App
19+
20+
1. Open AsrApp in Android Studio
21+
2. Copy the `executorch.aar` library (with ASR and Parakeet JNI bindings) into `app/libs/`
22+
3. Build and run on device
23+
24+
## Download Models
25+
26+
The app includes a built-in download screen to fetch models from HuggingFace. Alternatively, push files manually:
27+
28+
```bash
29+
adb push model.pte /data/local/tmp/asr/
30+
adb push tokenizer.json /data/local/tmp/asr/
31+
adb push whisper_preprocessor.pte /data/local/tmp/asr/ # Whisper only
32+
```
33+
34+
## Recording Behavior
35+
36+
- **Whisper**: Click to start recording; automatically stops after 30 seconds
37+
- **Parakeet**: Click to start recording; click again to stop (no time limit)

0 commit comments

Comments
 (0)