ggerganov commited on
Commit
974e0d1
·
unverified ·
1 Parent(s): f4bcbaa

Update README.md (#46)

Browse files

Add references to the new Android app

Files changed (2) hide show
  1. README.md +2 -1
  2. examples/whisper.android/README.md +3 -1
README.md CHANGED
@@ -19,11 +19,11 @@ Supported platforms:
19
 
20
  - [x] Mac OS (Intel and Arm)
21
  - [x] [iOS](examples/whisper.objc)
 
22
  - [x] Linux / [FreeBSD](https://github.com/ggerganov/whisper.cpp/issues/56#issuecomment-1350920264)
23
  - [x] [WebAssembly](examples/whisper.wasm)
24
  - [x] Windows ([MSVC](https://github.com/ggerganov/whisper.cpp/blob/master/.github/workflows/build.yml#L117-L144) and [MinGW](https://github.com/ggerganov/whisper.cpp/issues/168)]
25
  - [x] [Raspberry Pi](https://github.com/ggerganov/whisper.cpp/discussions/166)
26
- - [x] [Android](https://github.com/ggerganov/whisper.cpp/issues/30)
27
 
28
  The entire implementation of the model is contained in 2 source files:
29
 
@@ -465,6 +465,7 @@ Some of the examples are even ported to run in the browser using WebAssembly. Ch
465
  | [command](examples/command) | [command.wasm](examples/command.wasm) | Basic voice assistant example for receiving voice commands from the mic |
466
  | [talk](examples/talk) | [talk.wasm](examples/talk.wasm) | Talk with a GPT-2 bot |
467
  | [whisper.objc](examples/whisper.objc) | | iOS mobile application using whisper.cpp |
 
468
  | [whisper.nvim](examples/whisper.nvim) | | Speech-to-text plugin for Neovim |
469
  | [generate-karaoke.sh](examples/generate-karaoke.sh) | | Helper script to easily [generate a karaoke video](https://youtu.be/uj7hVta4blM) of raw audio capture |
470
  | [livestream.sh](examples/livestream.sh) | | [Livestream audio transcription](https://github.com/ggerganov/whisper.cpp/issues/185) |
 
19
 
20
  - [x] Mac OS (Intel and Arm)
21
  - [x] [iOS](examples/whisper.objc)
22
+ - [x] [Android](examples/whisper.android)
23
  - [x] Linux / [FreeBSD](https://github.com/ggerganov/whisper.cpp/issues/56#issuecomment-1350920264)
24
  - [x] [WebAssembly](examples/whisper.wasm)
25
  - [x] Windows ([MSVC](https://github.com/ggerganov/whisper.cpp/blob/master/.github/workflows/build.yml#L117-L144) and [MinGW](https://github.com/ggerganov/whisper.cpp/issues/168)]
26
  - [x] [Raspberry Pi](https://github.com/ggerganov/whisper.cpp/discussions/166)
 
27
 
28
  The entire implementation of the model is contained in 2 source files:
29
 
 
465
  | [command](examples/command) | [command.wasm](examples/command.wasm) | Basic voice assistant example for receiving voice commands from the mic |
466
  | [talk](examples/talk) | [talk.wasm](examples/talk.wasm) | Talk with a GPT-2 bot |
467
  | [whisper.objc](examples/whisper.objc) | | iOS mobile application using whisper.cpp |
468
+ | [whisper.android](examples/whisper.android) | | Android mobile application using whisper.cpp |
469
  | [whisper.nvim](examples/whisper.nvim) | | Speech-to-text plugin for Neovim |
470
  | [generate-karaoke.sh](examples/generate-karaoke.sh) | | Helper script to easily [generate a karaoke video](https://youtu.be/uj7hVta4blM) of raw audio capture |
471
  | [livestream.sh](examples/livestream.sh) | | [Livestream audio transcription](https://github.com/ggerganov/whisper.cpp/issues/185) |
examples/whisper.android/README.md CHANGED
@@ -7,4 +7,6 @@ To use:
7
  3. Select a sample audio file (for example, [jfk.wav](https://github.com/ggerganov/whisper.cpp/raw/master/samples/jfk.wav)).
8
  4. Copy the sample to the "app/src/main/assets/samples" folder.
9
  5. Select the "release" active build variant, and use Android Studio to run and deploy to your device.
10
- [^1]: I recommend the tiny or base models for running on an Android device.
 
 
 
7
  3. Select a sample audio file (for example, [jfk.wav](https://github.com/ggerganov/whisper.cpp/raw/master/samples/jfk.wav)).
8
  4. Copy the sample to the "app/src/main/assets/samples" folder.
9
  5. Select the "release" active build variant, and use Android Studio to run and deploy to your device.
10
+ [^1]: I recommend the tiny or base models for running on an Android device.
11
+
12
+ <img width="300" alt="image" src="https://user-images.githubusercontent.com/1991296/208154256-82d972dc-221b-48c4-bfcb-36ce68602f93.png">