Softmaximalist commited on
Commit
07be031
·
1 Parent(s): f362dd7

Update license

Browse files
Files changed (2) hide show
  1. LICENSE +11 -0
  2. README.md +21 -15
LICENSE CHANGED
@@ -199,3 +199,14 @@
199
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
  See the License for the specific language governing permissions and
201
  limitations under the License.
 
 
 
 
 
 
 
 
 
 
 
 
199
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
  See the License for the specific language governing permissions and
201
  limitations under the License.
202
+
203
+ ------------------------------------------------------------------------
204
+
205
+ ADDITIONAL TERM
206
+
207
+ In addition to the terms of the Apache License, Version 2.0 above: any
208
+ use, distribution, or integration of this model, whether unmodified or
209
+ as part of a derivative work or product, must continue to identify it
210
+ by its original name, "S1-mini" by "Superwhisper", using that exact
211
+ capitalization, regardless of any other name under which the model or
212
+ a product incorporating it is marketed or distributed.
README.md CHANGED
@@ -1,5 +1,7 @@
1
  ---
2
- license: apache-2.0
 
 
3
  base_model: Qwen/Qwen3-0.6B
4
  base_model_relation: finetune
5
  library_name: transformers
@@ -18,10 +20,10 @@ tags:
18
  - qwen3
19
  ---
20
 
21
- # s1-mini — by [Superwhisper](https://superwhisper.com)
22
 
23
  <div align="center">
24
- <img src="./banner.jpg" alt="s1-mini banner" width="100%">
25
 
26
  [![Website](https://img.shields.io/badge/Website-blue?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjEwIi8+PGxpbmUgeDE9IjIiIHkxPSIxMiIgeDI9IjIyIiB5Mj0iMTIiLz48cGF0aCBkPSJNMTIgMmExNS4zIDE1LjMgMCAwIDEgNCAxMCAxNS4zIDE1LjMgMCAwIDEtNCAxMCAxNS4zIDE1LjMgMCAwIDEtNC0xMCAxNS4zIDE1LjMgMCAwIDEgNC0xMHoiLz48L3N2Zz4=)](https://superwhisper.com)
27
  [![Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/tF98XvJNvB)
@@ -37,7 +39,7 @@ email addresses rendered in written form.
37
  On a held-out set of 6,183 English cases it reaches 94.4% token accuracy, and
38
  the quantized build is a 462 MB file that runs comfortably on a laptop CPU.
39
 
40
- This is release v1, and it covers English only. s1-mini is not a chat model
41
  and will not follow general instructions; it does one job, and you steer it
42
  with a control line at the top of the input.
43
 
@@ -250,7 +252,7 @@ decoding, under `[Styling: semi-formal] [Structure: prose] [Context: general]`.
250
  ## Set `enable_thinking=False`
251
 
252
  The chat template comes from Qwen3 unchanged, and Qwen3 turns on thinking mode
253
- by default. s1-mini was trained with thinking off and has no reasoning traces
254
  in its training data.
255
 
256
  > [!WARNING]
@@ -347,9 +349,9 @@ output and synthetic stress sets for numbers, self-corrections, lists, email
347
  and adversarial inputs: 94.4% token accuracy, measured greedy on the Q4_K_M
348
  GGUF build. The BF16 weights here should do at least as well.
349
 
350
- ## Using s1-mini in your own app
351
 
352
- s1-mini is Apache 2.0, the same license it inherits from Qwen3-0.6B, so it can
353
  be embedded in open-source and commercial software alike: dictation apps,
354
  meeting-notes tools, live captioning, voice-driven editors, or any pipeline
355
  that has to turn raw ASR output into text a person will read.
@@ -357,7 +359,7 @@ that has to turn raw ASR output into text a person will read.
357
  It is a post-processing stage rather than a standalone system:
358
 
359
  ```
360
- audio ──▶ ASR (Whisper, Parakeet, …) ──▶ s1-mini ──▶ clean text
361
  ```
362
 
363
  The ASR's raw transcript becomes the transcript line, your app's settings
@@ -366,7 +368,7 @@ display. At 0.6B it is small enough to ship on-device, and the
366
  [GGUF builds](https://huggingface.co/superwhisper/s1-mini-GGUF) exist for
367
  exactly that.
368
 
369
- Nothing about the model is superwhisper-specific. The two things to get right
370
  in any integration are the input format documented above and the thinking
371
  flag; nearly every integration bug traces back to one of those.
372
 
@@ -374,20 +376,24 @@ flag; nearly every integration bug traces back to one of those.
374
  > Read the [LICENSE](LICENSE) before you ship. Apache 2.0 is permissive but
375
  > not obligation-free: you must retain the license text and attribution
376
  > notices, and state significant changes if you redistribute a modified
377
- > version. If you are bundling s1-mini into a commercial dictation app or
378
- > redistributing the weights yourself, confirm the terms cover your case
379
- > rather than assuming they do.
 
 
380
 
381
  ## License
382
 
383
- s1-mini is released under Apache 2.0, which it inherits from Qwen3-0.6B.
 
 
384
 
385
  ## Citation
386
 
387
  ```bibtex
388
  @misc{s1mini2026,
389
- title = {s1-mini: a small text normalizer for speech-to-text output},
390
- author = {superwhisper},
391
  year = {2026},
392
  url = {https://huggingface.co/superwhisper/s1-mini}
393
  }
 
1
  ---
2
+ license: other
3
+ license_name: s1-mini-license
4
+ license_link: LICENSE
5
  base_model: Qwen/Qwen3-0.6B
6
  base_model_relation: finetune
7
  library_name: transformers
 
20
  - qwen3
21
  ---
22
 
23
+ # S1-mini by [Superwhisper](https://superwhisper.com)
24
 
25
  <div align="center">
26
+ <img src="./banner.jpg" alt="S1-mini banner" width="100%">
27
 
28
  [![Website](https://img.shields.io/badge/Website-blue?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiPjxjaXJjbGUgY3g9IjEyIiBjeT0iMTIiIHI9IjEwIi8+PGxpbmUgeDE9IjIiIHkxPSIxMiIgeDI9IjIyIiB5Mj0iMTIiLz48cGF0aCBkPSJNMTIgMmExNS4zIDE1LjMgMCAwIDEgNCAxMCAxNS4zIDE1LjMgMCAwIDEtNCAxMCAxNS4zIDE1LjMgMCAwIDEtNC0xMCAxNS4zIDE1LjMgMCAwIDEgNC0xMHoiLz48L3N2Zz4=)](https://superwhisper.com)
29
  [![Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/tF98XvJNvB)
 
39
  On a held-out set of 6,183 English cases it reaches 94.4% token accuracy, and
40
  the quantized build is a 462 MB file that runs comfortably on a laptop CPU.
41
 
42
+ This is release v1, and it covers English only. S1-mini is not a chat model
43
  and will not follow general instructions; it does one job, and you steer it
44
  with a control line at the top of the input.
45
 
 
252
  ## Set `enable_thinking=False`
253
 
254
  The chat template comes from Qwen3 unchanged, and Qwen3 turns on thinking mode
255
+ by default. S1-mini was trained with thinking off and has no reasoning traces
256
  in its training data.
257
 
258
  > [!WARNING]
 
349
  and adversarial inputs: 94.4% token accuracy, measured greedy on the Q4_K_M
350
  GGUF build. The BF16 weights here should do at least as well.
351
 
352
+ ## Using S1-mini in your own app
353
 
354
+ S1-mini is Apache 2.0, the same license it inherits from Qwen3-0.6B, so it can
355
  be embedded in open-source and commercial software alike: dictation apps,
356
  meeting-notes tools, live captioning, voice-driven editors, or any pipeline
357
  that has to turn raw ASR output into text a person will read.
 
359
  It is a post-processing stage rather than a standalone system:
360
 
361
  ```
362
+ audio ──▶ ASR (Whisper, Parakeet, …) ──▶ S1-mini ──▶ clean text
363
  ```
364
 
365
  The ASR's raw transcript becomes the transcript line, your app's settings
 
368
  [GGUF builds](https://huggingface.co/superwhisper/s1-mini-GGUF) exist for
369
  exactly that.
370
 
371
+ Nothing about the model is Superwhisper-specific. The two things to get right
372
  in any integration are the input format documented above and the thinking
373
  flag; nearly every integration bug traces back to one of those.
374
 
 
376
  > Read the [LICENSE](LICENSE) before you ship. Apache 2.0 is permissive but
377
  > not obligation-free: you must retain the license text and attribution
378
  > notices, and state significant changes if you redistribute a modified
379
+ > version. It also carries one additional term: the model must keep its
380
+ > name, "S1-mini" by "Superwhisper", with that exact capitalization,
381
+ > wherever it's used. If you are bundling S1-mini into a commercial
382
+ > dictation app or redistributing the weights yourself, confirm the terms
383
+ > cover your case rather than assuming they do.
384
 
385
  ## License
386
 
387
+ S1-mini is released under Apache 2.0, which it inherits from Qwen3-0.6B, plus
388
+ one additional term: wherever it's used, it must keep its name, "S1-mini" by
389
+ "Superwhisper", with that exact capitalization. See [LICENSE](LICENSE).
390
 
391
  ## Citation
392
 
393
  ```bibtex
394
  @misc{s1mini2026,
395
+ title = {S1-mini: a small text normalizer for speech-to-text output},
396
+ author = {Superwhisper},
397
  year = {2026},
398
  url = {https://huggingface.co/superwhisper/s1-mini}
399
  }