Banafo commited on
Commit
afa5c74
·
verified ·
1 Parent(s): ecc0002

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -13
README.md CHANGED
@@ -17,23 +17,28 @@ pipeline_tag: text-to-speech
17
 
18
  <!-- Provide a quick summary of what the model is/does. -->
19
 
20
- Preview-release for Fosdem 2025 with current training epochs (Training is still ongoing)
21
 
22
- Demos: https://huggingface.co/spaces/Banafo/Kroko-Streaming-ASR-Wasm (running on CPU in the browser).
23
- Gradio / python: https://huggingface.co/spaces/Banafo/Kroko-Streaming-ASR-Python
 
24
 
 
25
 
26
- This is family of low-latency streaming models for use on edge devices.
27
- Goals:
28
- - Faster and or higher quality than similar sized Whisper and other models.
 
29
 
30
- The license is still under consideration (probably Coqui), it will be dual licenced:
31
- - free for non commercial use
32
- - Affordable license for commercial use.
 
33
 
34
- English, French, German available. Spanish and Portuguese by 14 feb.
 
 
35
 
36
- Training is done with modified k2/ Icefall.
37
- Inference can be done with standard Sherpa project.
38
 
39
- Big thanks and shoutout to the lhotse / Sherpa / k2 / Icefall team.
 
17
 
18
  <!-- Provide a quick summary of what the model is/does. -->
19
 
20
+ > **Preview-release for Fosdem 2025 with current training epochs (Training is still ongoing).**
21
 
22
+ ## Overview
23
+ This is a family of low-latency streaming models designed for use on edge devices.
24
+ **Goal**: Provide faster or higher-quality performance compared to similarly sized Whisper and other models.
25
 
26
+ - **Languages**: English, French, German (Spanish and Portuguese planned for release by **Feb 14**).
27
 
28
+ ## Demos
29
+ - [**Browser Demo (CPU)**](https://huggingface.co/spaces/Banafo/Kroko-Streaming-ASR-Wasm)
30
+ *(Runs entirely in the browser using CPU.)*
31
+ - [**Gradio / Python Demo**](https://huggingface.co/spaces/Banafo/Kroko-Streaming-ASR-Python)
32
 
33
+ ## License
34
+ The license is still under consideration (likely Coqui). The model is intended to be **dual-licensed**:
35
+ - **Free for non-commercial use**.
36
+ - **Affordable license for commercial use**.
37
 
38
+ ## Training
39
+ - Training is done with a modified k2/Icefall pipeline.
40
+ - Inference can be performed with the standard Sherpa project.
41
 
42
+ ## Acknowledgements
43
+ Special thanks to the [Lhotse](https://github.com/lhotse-speech/lhotse), [Sherpa](https://github.com/k2-fsa/sherpa), [k2](https://github.com/k2-fsa/k2), and [Icefall](https://github.com/k2-fsa/icefall) teams for their support and tools.
44