Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
csukuangfj committed Aug 17, 2024
1 parent 5c20252 commit 860a1ab
Showing 1 changed file with 79 additions and 11 deletions.
90 changes: 79 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,60 @@
# Introduction
### Supported functions

You can use `sherpa-ncnn` for **real-time** speech recognition (i.e., speech-to-text)
and voice activity detection (VAD) on the following platforms
|Real-time Speech recognition| Voice activity detection |
|----------------------------|--------------------------|
| ✔️ | ✔️ |

- Linux
- macOS
- Windows
- Embedded Linux (32-bit arm and 64-bit aarch64)
- Android
- etc ...
### Supported platforms

It runs on locally CPU without accessing the network.
|Architecture| Android | iOS | Windows | macOS | linux |
|------------|------------------|---------------|------------|-------|-------|
| x64 | ✔️ | | ✔️ | ✔️ | ✔️ |
| x86 | ✔️ | | ✔️ | | |
| arm64 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| arm32 | ✔️ | | | | ✔️ |
| riscv64 | | | | | ✔️ |

### Supported programming languages

| 1. C++ | 2. C | 3. Python | 4. JavaScript |
|--------|-------|-----------|---------------|
| ✔️ | ✔️ | ✔️ | ✔️ |

|5. Go | 6. C# | 7. Kotlin | 8. Swift |
|--------|-------|-----------|----------|
| ✔️ | ✔️ | ✔️ | ✔️ |


It also supports WebAssembly.

## Introduction

This repository supports running the following functions **locally**

- Streaming speech-to-text (i.e., real-time speech recognition)
- VAD (e.g., [silero-vad](https://github.com/snakers4/silero-vad))

on the following platforms and operating systems:

- x86, ``x86_64``, 32-bit ARM, 64-bit ARM (arm64, aarch64), RISC-V (riscv64)
- Linux, macOS, Windows, openKylin
- Android, WearOS
- iOS
- NodeJS
- WebAssembly
- [Raspberry Pi](https://www.raspberrypi.com/)
- [RV1126](https://www.rock-chips.com/uploads/pdf/2022.8.26/191/RV1126%20Brief%20Datasheet.pdf)
- [LicheePi4A](https://sipeed.com/licheepi4a)
- [VisionFive 2](https://www.starfivetech.com/en/site/boards)
- [旭日X3派](https://developer.horizon.ai/api/v1/fileData/documents_pi/index.html)
- etc

with the following APIs

- C++, C, Python, Go, ``C#``
- Kotlin
- JavaScript
- Swift

We support all platforms that [ncnn](https://github.com/tencent/ncnn) supports.

Expand Down Expand Up @@ -42,5 +86,29 @@ with `sherpa-ncnn` using a microphone:
- `Chinese` Android demo : <https://www.bilibili.com/video/BV1744y1Z76H>
- `Chinese poem with background music` Android demo : <https://www.bilibili.com/video/BV1vR4y1k7eo>

### Links for pre-built Android APKs

| Description | URL |
|--------------------------------|-----------------------------------------------------------|
| Streaming speech recognition | [Address](https://github.com/k2-fsa/sherpa-ncnn/releases) |

### Links for pre-trained models

https://github.com/k2-fsa/sherpa-ncnn/releases/tag/models

### Useful links

- Documentation: https://k2-fsa.github.io/sherpa/onnx/
- Bilibili 演示视频: https://search.bilibili.com/all?keyword=%E6%96%B0%E4%B8%80%E4%BB%A3Kaldi

### How to reach us

Please see
https://k2-fsa.github.io/sherpa/social-groups.html
for 新一代 Kaldi **微信交流群** and **QQ 交流群**.


## See also

See also <https://github.com/k2-fsa/sherpa>
- <https://github.com/k2-fsa/sherpa-onnx>
- <https://github.com/k2-fsa/sherpa>

0 comments on commit 860a1ab

Please sign in to comment.