OpenASR Release commited on
Commit
63d2bb6
Β·
unverified Β·
0 Parent(s):

publish xasr-zh-en OpenASR packs

Browse files
.gitattributes ADDED
@@ -0,0 +1 @@
 
 
1
+ *.oasr filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,117 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ base_model: GilgameshWind/X-ASR-zh-en
4
+ pipeline_tag: automatic-speech-recognition
5
+ library_name: openasr
6
+ tags:
7
+ - automatic-speech-recognition
8
+ - speech-to-text
9
+ - openasr
10
+ - oasr
11
+ - xasr
12
+ ---
13
+
14
+ <div align="center">
15
+
16
+ # X-ASR zh-en Β· OpenASR
17
+
18
+ **Bilingual Chinese + English streaming speech recognition β€” a compact icefall Zipformer2 transducer**
19
+
20
+ [![License](https://img.shields.io/badge/license-Apache--2.0-2563eb.svg)](https://huggingface.co/GilgameshWind/X-ASR-zh-en/blob/main/README.md)
21
+ [![Format](https://img.shields.io/badge/format-.oasr-7c3aed.svg)](https://github.com/QuintinShaw/OpenASR)
22
+ [![Runtime](https://img.shields.io/badge/runtime-OpenASR-111827.svg)](https://openasr.org)
23
+ [![Base model](https://img.shields.io/badge/base-X--ASR--zh--en-f59e0b.svg)](https://huggingface.co/GilgameshWind/X-ASR-zh-en)
24
+
25
+ Native speech-to-text in the **[OpenASR](https://github.com/QuintinShaw/OpenASR)** runtime β€”
26
+ engineered for peak performance on CPU & GPU, **no Python at inference time**.
27
+
28
+ </div>
29
+
30
+ ---
31
+
32
+ ## ✨ Highlights
33
+
34
+ - πŸ‡¨πŸ‡³πŸ‡¬πŸ‡§ **Chinese + English** β€” one bilingual checkpoint for zh/en speech, including code-switched audio
35
+ - ⚑ **Streaming-first, offline-capable** β€” a cache-aware streaming Zipformer2 transducer for low-latency captions that also runs full-file offline transcription
36
+ - πŸͺΆ **Compact ~0.16B** β€” a 6-stack Zipformer2 encoder + stateless RNN-T decoder + tanh joiner over a 5000-token BPE vocab, light enough for on-device CPU
37
+ - πŸ¦€ **Native in OpenASR** β€” `.oasr` packs run with no Python at inference, engineered for peak performance on CPU & GPU
38
+
39
+ ## πŸš€ Quickstart
40
+
41
+ ```bash
42
+ # 1. Install the OpenASR CLI Β· https://openasr.org
43
+ # 2. Pull a build (pick a quant β€” see the table below)
44
+ openasr pull xasr-zh-en:q8
45
+
46
+ # 3. Transcribe
47
+ openasr transcribe audio.wav --model xasr-zh-en
48
+ ```
49
+
50
+ All builds for this model:
51
+
52
+ ```bash
53
+ openasr pull xasr-zh-en:fp16
54
+ openasr pull xasr-zh-en:q8
55
+ openasr pull xasr-zh-en:q4
56
+ ```
57
+
58
+ ## πŸ“¦ Available builds
59
+
60
+ | Quant | File (`.oasr`) | Size | RAM peak | RTF Β· M1 CPU | RTF Β· M1 GPU | JFK Ξ”WER vs fp16 |
61
+ |:------|:---------------|-----:|---------:|-------------:|-------------:|-----------------:|
62
+ | fp16 | `xasr-zh-en-fp16.oasr` | 315 MB | 1.36 GB | 0.09Γ— | 0.09Γ— | 0.0% |
63
+ | q8_0 | `xasr-zh-en-q8_0.oasr` | 176 MB | 1.36 GB | 0.09Γ— | 0.09Γ— | 0.0% |
64
+ | q4_k | `xasr-zh-en-q4_k.oasr` | 112 MB | 1.36 GB | 0.09Γ— | 0.10Γ— | 0.0% |
65
+
66
+ <sub>RTF = real-time factor on the fixed 11s JFK clip (**lower is faster**); RAM peak measured per pack
67
+ in an isolated subprocess. JFK Ξ”WER compares each quantized build's JFK transcript to this model's
68
+ fp16 JFK transcript, so it measures quantization drift rather than absolute recognition accuracy.
69
+ **q8_0** is the recommended default β€” near-reference quality at a fraction of the
70
+ footprint.</sub>
71
+
72
+ ## 🧠 About X-ASR zh-en
73
+
74
+ X-ASR-zh-en is a compact **bilingual (Chinese + English)** streaming speech-recognition model from
75
+ **GilgameshWind**, built with the **icefall / k2** recipe as a cache-aware **Zipformer2 RNN-T
76
+ transducer** (a 6-stack, 19-layer Zipformer2 encoder, a stateless RNN-T decoder, and a tanh joiner
77
+ over a 5000-token BPE vocabulary, ~0.16B parameters). The same checkpoint serves both low-latency
78
+ **streaming** captions and full-file **offline** transcription, making it a good fit for on-device
79
+ Chinese/English dictation and real-time subtitles. This OpenASR repo repackages the weights as
80
+ `.oasr` packs that run natively in the OpenASR runtime β€” no Python at inference time, all decoding
81
+ local. The **q8_0** build is the recommended default (it matched the fp16 transcript bit-for-bit in
82
+ OpenASR's verification); **q4_k** is the smallest build for tight-memory devices and **fp16** is for
83
+ maximum fidelity or verification.
84
+
85
+ ## βš™οΈ How these packs were made
86
+
87
+ Converted from [GilgameshWind/X-ASR-zh-en](https://huggingface.co/GilgameshWind/X-ASR-zh-en) with the OpenASR importer:
88
+
89
+ ```bash
90
+ openasr model-pack import-xasr-zipformer-local <src> <out>.oasr \
91
+ --package-id xasr-zh-en --quantization {fp16,q8-0,q4-k}
92
+ ```
93
+
94
+ The `.oasr` container is GGUF-backed; packs use zero-copy mmap weight binding and graph
95
+ buffer reuse to keep peak memory low.
96
+
97
+ ## βš–οΈ License
98
+
99
+ These packs **inherit the upstream model's license: Apache-2.0**
100
+ ([source](https://huggingface.co/GilgameshWind/X-ASR-zh-en/blob/main/README.md)). OpenASR packaging retains the upstream copyright and
101
+ NOTICE; the only modifications are format conversion and quantization.
102
+
103
+ ## πŸ™ Acknowledgements
104
+
105
+ This pack is a redistribution of **X-ASR-zh-en**, created and open-sourced by **GilgameshWind**
106
+ ([GilgameshWind/X-ASR-zh-en](https://huggingface.co/GilgameshWind/X-ASR-zh-en)). All credit for the
107
+ original architecture, training, and weights belongs to the author; the license is inherited from and
108
+ identical to the upstream model (Apache-2.0). The model is built on the **icefall** /
109
+ **k2 / Next-gen Kaldi** Zipformer2 transducer recipe β€” thank you to the icefall team and to
110
+ GilgameshWind for releasing their work openly. OpenASR only performs format conversion, quantization,
111
+ runtime verification, and local-inference adaptation.
112
+
113
+ ## πŸ”— Links
114
+
115
+ - πŸ¦€ **OpenASR** β€” <https://github.com/QuintinShaw/OpenASR>
116
+ - 🌐 **Website** β€” <https://openasr.org>
117
+ - πŸ€— **Upstream model** β€” [GilgameshWind/X-ASR-zh-en](https://huggingface.co/GilgameshWind/X-ASR-zh-en)
xasr-zh-en-fp16.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:89316b6e912aa474121fa6b8b7738514b64c9ba144f26702cbb36313b69a2e95
3
+ size 314918720
xasr-zh-en-q4_k.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:f4bea03a10333ee2c31f797a1abbadb885a85e63327b419b83b99d8bd2823106
3
+ size 112003904
xasr-zh-en-q8_0.oasr ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a0201070212ceff3a37d8dafd21455209ea48721d1b53b31e8eff328fc573fdb
3
+ size 175711040