README.md

---
title: Kashmiri Streaming ASR Zipformer
emoji: 💻
colorFrom: purple
colorTo: gray
sdk: docker
pinned: false
short_description: 'Online Streaming ASR System for Kashmiri Language'
license: apache-2.0
---

# 🎙️ Real-Time Kashmiri Streaming ASR  (FastAPI + Sherpa-ONNX)

This project demonstrates a real-time speech-to-text (ASR) web application with:
* 🎛️ Hugging Face Deployment taken from [Luigi](https://huggingface.co/spaces/Luigi/Streaming-Zipformer)
* 🧠 [Sherpa-ONNX](https://github.com/k2-fsa/sherpa-onnx) streaming Zipformer model
* 🚀 FastAPI backend with WebSocket support
* ☁️ Docker-compatible deployment (CPU-only) on Hugging Face Spaces


## 🤖 Training
* Model: [Zipformer Small](https://github.com/k2-fsa/icefall)
* Dataset: [IndicVoices](https://huggingface.co/datasets/ai4bharat/IndicVoices)
* WER: 36%
  
## 🧪 Local Development

1. **Install dependencies**

```bash
pip install -r requirements.txt
```

2. **Run the app locally**

```bash
uvicorn app.main:app --reload --host 0.0.0.0 --port 8501
```

Open [http://localhost:8501](http://localhost:8501) in your browser.

[https://k2-fsa.github.io/sherpa/ncnn/endpoint.html](https://k2-fsa.github.io/sherpa/ncnn/endpoint.html)

## 📁 Project Structure

```
.
├── app
│   ├── main.py
│   ├── asr.py
│   └── model parts
        └── All Model parts here (encoder, decoder, joiner, tokens)
    ├── index.html
├── requirements.txt
├── Dockerfile
└── README.md
```

## 🔧 Credits

* [Sherpa-ONNX](https://github.com/k2-fsa/sherpa-onnx)
* [OpenCC](https://github.com/BYVoid/OpenCC)
* [FastAPI](https://fastapi.tiangolo.com/)
* [Hugging Face Spaces](https://huggingface.co/docs/hub/spaces)
* [AI4Bharat](https://ai4bharat.iitm.ac.in/)
* [Icefall-K2](https://github.com/k2-fsa/icefall)


Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference