sj-zetic commited on
Commit
0132642
Β·
verified Β·
1 Parent(s): 01ea445

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +194 -0
README.md ADDED
@@ -0,0 +1,194 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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-small
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-small-decoder?
49
+
50
+ ZETIC-ai/whisper-small-decoder is a highly optimized version of **[Whisper Small by OpenAI](https://huggingface.co/openai/whisper-small)**, built to run **on-device** (Android, iOS) with **Melange SDK**.
51
+ <br>
52
+ For the encoder model that runs locally: [Check model card](https://huggingface.co/ZETIC-ai/whisper-small-encoder)
53
+
54
+ **Key Details:**
55
+ - 🎯 **Task**: Object Detection
56
+ - πŸš€ **Engine**: ZETIC Melange Runtime
57
+ - πŸ’‘ **Best For**: Object detection, tracking, instance segmentation, image classification, and pose estimation
58
+
59
+ 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.
60
+
61
+ ---
62
+
63
+ ## πŸš€ How to Use
64
+
65
+ Deploy in seconds. The Melange SDK handles model fetching, NPU delegation, and hardware acceleration automatically.
66
+
67
+ ### Android (Kotlin)
68
+ ```kotlin
69
+ val model = ZeticMLangeModel(context, "[MODEL_ID]")
70
+ model.load()
71
+ val output = model.run(inputData)
72
+ ```
73
+
74
+
75
+ ### iOS (Swift)
76
+ ```swift
77
+ let model = try ZeticMLangeModel(id: "[MODEL_ID]")
78
+ try model.load()
79
+ let result = try model.run(inputData)
80
+ ```
81
+
82
+ πŸ’‘ **Looking for Java, React Native, or Flutter?** Visit [Melange Dashboard](https://mlange.zetic.ai).
83
+
84
+ **Installation**: [View docs](https://docs.zetic.ai)
85
+
86
+ ---
87
+
88
+ ## πŸ“Š Benchmarks & Compatibility
89
+
90
+ **Optimized for Flagships.** This model release is specifically tuned for the latest flagship smartphones.
91
+
92
+ | Device | Chipset | FPS |
93
+ | :--- | :--- | :--- |
94
+ | **Samsung Galaxy S25 Ultra** | Snapdragon 8 Elite | TBD |
95
+ | **Samsung Galaxy S25** | Snapdragon 8 Elite | [VAL] t/s |
96
+ | **iPhone 16 Pro** | A18 Pro | 532 FPS |
97
+ | **iPhone 16** | A18 | [VAL] t/s |
98
+
99
+ πŸš€ **Beyond the Flagships:** Melange supports a vast ecosystem of **100+ devices**. <br><br>
100
+
101
+ Melange SDK automatically handles optimization and fallback for the wider ecosystem, including budget & legacy smartphones. <br>
102
+ **[Explore the full ecosystem optimization on Melange Dashboard]([mlange.zetic.ai])**
103
+
104
+ ---
105
+
106
+ ## πŸ€” Why Melange?
107
+
108
+ <div>
109
+
110
+ ### **1. The Old Way (Slow & Manual)**
111
+ Separate iOS/Android Workflows | Manual Updates Require Full Re-Deployment
112
+
113
+ ![Frame 3](https://cdn-uploads.huggingface.co/production/uploads/68c8c30d7c55656282d829fe/eN64F5MEEaGyCVisF-4R_.png)
114
+
115
+ ### **2. Semi-Auto SDKs (Hardware-Locked)**
116
+ Hardware-Locked Model Cards | Manual File Management (Drag & Drop)
117
+
118
+ ![Frame 8](https://cdn-uploads.huggingface.co/production/uploads/68c8c30d7c55656282d829fe/_vTeGpdv4K11lxwmf1VD5.png)
119
+
120
+
121
+ ### **3. The Melange Way (Fast & Automatic)**
122
+ Device-Aware Auto-Routing | Hardware-Agnostic NPU API | Small App Size
123
+
124
+ ![Frame 10](https://cdn-uploads.huggingface.co/production/uploads/68c8c30d7c55656282d829fe/IHH9UqRaXvawZATZ1A9PN.png)
125
+
126
+ </div>
127
+
128
+ βœ… **Zero Asset Management**: We host the model & the complexity. Your app calls '[MODEL_ID]', and we deliver. <br/>
129
+ βœ… **Automatic Fetching**: The SDK streams the model at initialization, no manual file uploads.<br/>
130
+ βœ… **Device-Aware Auto-Routing**: The SDK auto-detects and routes the best-fit runtime variant for that device.<br/>
131
+ βœ… **Unified Workflow**: Maintain a single, identical deployment path for both iOS and Android. <br/>
132
+ βœ… **Instant Updates**: Push model updates instantly without waiting for App Store approvals. <br/>
133
+ βœ… **Global Scale**: Optimized paths for mid-range and low-end chips, not just flagships.<br/>
134
+ <br/>
135
+
136
+ ---
137
+
138
+ ## πŸš€ Unlock Full Performance
139
+
140
+ **Advanced Benchmark Reports β€’ Extended Model Catalog β€’ 100+ Optimized Devices**
141
+
142
+ <a href="https://mlange.zetic.ai">
143
+ <img src="https://img.shields.io/badge/πŸš€_Open_Dashboard-34A9A3?style=for-the-badge" alt="MeLange Dashboard" height="30" />
144
+ </a>
145
+
146
+ ---
147
+
148
+ ## πŸ“„ License & Terms
149
+
150
+ **Base Model**
151
+ Model weights are licensed under the original license provided by the model author.
152
+ See the upstream model card for full terms.
153
+
154
+ **ZETIC Hugging Face Runtime Bundle**
155
+ This release includes a pre-optimized runtime + model bundle enabling local, on-device inference across compatible devices.
156
+
157
+ The runtime is optimized and benchmarked for a limited set of flagship devices.
158
+ On other compatible devices, the model may still run, but performance may vary.
159
+
160
+ Advanced device coverage and performance guarantees are available via the **Melange Dashboard (Pro)**.
161
+
162
+ **You may**
163
+ - Run the model locally on compatible devices
164
+ - Embed it in applications distributed to end users
165
+ - Use it in accordance with the base model license
166
+
167
+ **You may not**
168
+ - Extract or reuse the runtime outside this package
169
+ - Reverse engineer the optimization format
170
+ - Redistribute the runtime as a standalone SDK or service
171
+ - Bypass license verification or telemetry (if/when enabled)
172
+
173
+ **More devices, custom models, and performance guarantees**
174
+ Get started at the **Melange Dashboard**: https://mlange.zetic.ai
175
+
176
+ Enterprise or custom licensing: contact@zetic.ai
177
+
178
+ ---
179
+ ## πŸ“ž Support & Community
180
+
181
+ - **πŸ“š Documentation**: [https://docs.zetic.ai](https://docs.zetic.ai)
182
+ - **πŸ› Melange Apps Repo**: [https://github.com/zetic-ai/ZETIC_Melange_apps/](https://github.com/zetic-ai/ZETIC_Melange_apps/)
183
+ - **πŸ’¬ Discord**: [https://discord.gg/q6vW4UscRY](https://discord.gg/q6vW4UscRY)
184
+
185
+ ---
186
+
187
+ <div align="center">
188
+
189
+ **By ZETIC.ai**
190
+ *On-Device AI for Everything β€” for any model, on any device, in any framework*
191
+
192
+ [⭐ 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)
193
+
194
+ </div>](https://www.notion.so/Melange-Dashboard-2-0-Release-Checklist-2fe933a34b9880bd9494c31ea06d4f08?source=copy_link)