sj-zetic commited on
Commit
6e334c2
Β·
verified Β·
1 Parent(s): 8eacce7

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +195 -0
README.md ADDED
@@ -0,0 +1,195 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ language:
4
+ - en
5
+ tags:
6
+ - on-device
7
+ - mobile
8
+ - android
9
+ - ios
10
+ - melange
11
+ - zetic
12
+ - whisper
13
+ pipeline_tag: automatic-speech-recognition
14
+ base_model:
15
+ - openai/whisper-base
16
+ ---
17
+
18
+ <!-- ============================================== -->
19
+ <!-- FILL THIS IN BEFORE PUBLISHING -->
20
+ <!-- ============================================== -->
21
+ <!--
22
+
23
+ 🚨 Model License Rule (One Rule Applies to All)
24
+
25
+ **Never claim or imply commercial usage rights unless the base model license explicitly allows commercial use.**
26
+
27
+ - If the base model license allows commercial use β†’ you may state β€œcommercial use allowed (subject to the base model license)”.
28
+ - If the base model license restricts commercial use, is AGPL/GPL, research-only, or dual-licensed β†’ **do NOT mention commercial use**. Always defer to the base model license.
29
+
30
+ ZETIC licenses only the runtime and optimization artifacts.
31
+ Model licensing responsibility always remains with the original model owner.
32
+
33
+ --->
34
+
35
+ ---
36
+
37
+ ![LinkedIn Banner](https://cdn-uploads.huggingface.co/production/uploads/68c8c30d7c55656282d829fe/_l5ZggH1LMGTw0lFGgN_l.png)
38
+
39
+ ## Melange: On-device AI for Mobile β€” *Select. Benchmark. Deploy.*
40
+ <div align="center">
41
+
42
+ [**🌐 Website**](https://zetic.ai) | [**πŸ“š Docs**](https://docs.zetic.ai) | [**🎯 Melange Dashboard**](https://mlange.zetic.ai) | [**πŸ’» GitHub Apps Repo**](https://github.com/zetic-ai/ZETIC_Melange_apps/issues) | [**πŸ’¬ Discord**](https://discord.gg/q6vW4UscRY)
43
+
44
+ </div>
45
+
46
+ ---
47
+
48
+ ## ⚑️ What is ZETIC-ai/whisper-tiny-decoder?
49
+
50
+ ZETIC-ai/whisper-tiny-encoder is a highly optimized version of **[Whisper Tiny by OpenAI](https://huggingface.co/openai/whisper-tiny)**, built to run **on-device** (Android, iOS) with **Melange SDK**.
51
+ <br>
52
+ <br>
53
+ For the encoder model that runs locally: [Check model card](https://huggingface.co/ZETIC-ai/whisper-tiny-encoder)
54
+
55
+ **Key Details:**
56
+ - 🎯 **Task**: Automatic Speech Recognition
57
+ - πŸš€ **Engine**: ZETIC Melange Runtime
58
+ - πŸ’‘ **Best For**: Speech to Text, Speech Translation
59
+
60
+ Unlike standard GGUF or ONNX exports where you manually download `.tflite` or `.gguf` files and bundle them into your APK/IPA, **this model is fetched automatically** by the Melange SDK at runtime: no asset management, no file hosting, no bloated app sizes.
61
+
62
+ ---
63
+
64
+ ## πŸš€ How to Use
65
+
66
+ Deploy in seconds. The Melange SDK handles model fetching, NPU delegation, and hardware acceleration automatically.
67
+
68
+ ### Android (Kotlin)
69
+ ```kotlin
70
+ val model = ZeticMLangeModel(context, "[MODEL_ID]")
71
+ model.load()
72
+ val output = model.run(inputData)
73
+ ```
74
+
75
+
76
+ ### iOS (Swift)
77
+ ```swift
78
+ let model = try ZeticMLangeModel(id: "[MODEL_ID]")
79
+ try model.load()
80
+ let result = try model.run(inputData)
81
+ ```
82
+
83
+ πŸ’‘ **Looking for Java, React Native, or Flutter?** Visit [Melange Dashboard](https://mlange.zetic.ai).
84
+
85
+ **Installation**: [View docs](https://docs.zetic.ai)
86
+
87
+ ---
88
+
89
+ ## πŸ“Š Benchmarks & Compatibility
90
+
91
+ **Optimized for Flagships.** This model release is specifically tuned for the latest flagship smartphones.
92
+
93
+ | Device | Chipset | Inference Time (ms) |
94
+ | :--- | :--- | :--- |
95
+ | **Samsung Galaxy S25 Ultra** | Snapdragon 8 Elite | TBD |
96
+ | **Samsung Galaxy S25** | Snapdragon 8 Elite | TBD |
97
+ | **iPhone 16 Pro** | A18 Pro | TBD |
98
+ | **iPhone 16** | A18 | TBD |
99
+
100
+ πŸš€ **Beyond the Flagships:** Melange supports a vast ecosystem of **100+ devices**. <br><br>
101
+
102
+ Melange SDK automatically handles optimization and fallback for the wider ecosystem, including budget & legacy smartphones. <br>
103
+ **[Explore the full ecosystem optimization on Melange Dashboard]([mlange.zetic.ai])**
104
+
105
+ ---
106
+
107
+ ## πŸ€” Why Melange?
108
+
109
+ <div>
110
+
111
+ ### **1. The Old Way (Slow & Manual)**
112
+ Separate iOS/Android Workflows | Manual Updates Require Full Re-Deployment
113
+
114
+ ![Frame 3](https://cdn-uploads.huggingface.co/production/uploads/68c8c30d7c55656282d829fe/eN64F5MEEaGyCVisF-4R_.png)
115
+
116
+ ### **2. Semi-Auto SDKs (Hardware-Locked)**
117
+ Hardware-Locked Model Cards | Manual File Management (Drag & Drop)
118
+
119
+ ![Frame 8](https://cdn-uploads.huggingface.co/production/uploads/68c8c30d7c55656282d829fe/_vTeGpdv4K11lxwmf1VD5.png)
120
+
121
+
122
+ ### **3. The Melange Way (Fast & Automatic)**
123
+ Device-Aware Auto-Routing | Hardware-Agnostic NPU API | Small App Size
124
+
125
+ ![Frame 10](https://cdn-uploads.huggingface.co/production/uploads/68c8c30d7c55656282d829fe/IHH9UqRaXvawZATZ1A9PN.png)
126
+
127
+ </div>
128
+
129
+ βœ… **Zero Asset Management**: We host the model & the complexity. Your app calls '[MODEL_ID]', and we deliver. <br/>
130
+ βœ… **Automatic Fetching**: The SDK streams the model at initialization, no manual file uploads.<br/>
131
+ βœ… **Device-Aware Auto-Routing**: The SDK auto-detects and routes the best-fit runtime variant for that device.<br/>
132
+ βœ… **Unified Workflow**: Maintain a single, identical deployment path for both iOS and Android. <br/>
133
+ βœ… **Instant Updates**: Push model updates instantly without waiting for App Store approvals. <br/>
134
+ βœ… **Global Scale**: Optimized paths for mid-range and low-end chips, not just flagships.<br/>
135
+ <br/>
136
+
137
+ ---
138
+
139
+ ## πŸš€ Unlock Full Performance
140
+
141
+ **Advanced Benchmark Reports β€’ Extended Model Catalog β€’ 100+ Optimized Devices**
142
+
143
+ <a href="https://mlange.zetic.ai">
144
+ <img src="https://img.shields.io/badge/πŸš€_Open_Dashboard-34A9A3?style=for-the-badge" alt="MeLange Dashboard" height="30" />
145
+ </a>
146
+
147
+ ---
148
+
149
+ ## πŸ“„ License & Terms
150
+
151
+ **Base Model**
152
+ Model weights are licensed under the original license provided by the model author.
153
+ See the upstream model card for full terms.
154
+
155
+ **ZETIC Hugging Face Runtime Bundle**
156
+ This release includes a pre-optimized runtime + model bundle enabling local, on-device inference across compatible devices.
157
+
158
+ The runtime is optimized and benchmarked for a limited set of flagship devices.
159
+ On other compatible devices, the model may still run, but performance may vary.
160
+
161
+ Advanced device coverage and performance guarantees are available via the **Melange Dashboard (Pro)**.
162
+
163
+ **You may**
164
+ - Run the model locally on compatible devices
165
+ - Embed it in applications distributed to end users
166
+ - Use it in accordance with the base model license
167
+
168
+ **You may not**
169
+ - Extract or reuse the runtime outside this package
170
+ - Reverse engineer the optimization format
171
+ - Redistribute the runtime as a standalone SDK or service
172
+ - Bypass license verification or telemetry (if/when enabled)
173
+
174
+ **More devices, custom models, and performance guarantees**
175
+ Get started at the **Melange Dashboard**: https://mlange.zetic.ai
176
+
177
+ Enterprise or custom licensing: contact@zetic.ai
178
+
179
+ ---
180
+ ## πŸ“ž Support & Community
181
+
182
+ - **πŸ“š Documentation**: [https://docs.zetic.ai](https://docs.zetic.ai)
183
+ - **πŸ› Melange Apps Repo**: [https://github.com/zetic-ai/ZETIC_Melange_apps/](https://github.com/zetic-ai/ZETIC_Melange_apps/)
184
+ - **πŸ’¬ Discord**: [https://discord.gg/q6vW4UscRY](https://discord.gg/q6vW4UscRY)
185
+
186
+ ---
187
+
188
+ <div align="center">
189
+
190
+ **By ZETIC.ai**
191
+ *On-Device AI for Everything β€” for any model, on any device, in any framework*
192
+
193
+ [⭐ Star us on GitHub](https://github.com/zetic-ai/ZETIC_Melange_apps) β€’ [πŸ‘Ύ Discord](https://discord.gg/q6vW4UscRY) β€’ [πŸš€ Try Melange](https://mlange.zetic.ai) β€’ [πŸ“– Documentation](https://docs.zetic.ai)
194
+
195
+ </div>](https://www.notion.so/Melange-Dashboard-2-0-Release-Checklist-2fe933a34b9880bd9494c31ea06d4f08?source=copy_link)