mr-don88 commited on
Commit
5e82442
Β·
verified Β·
1 Parent(s): 6d67628

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -119
README.md CHANGED
@@ -1,126 +1,10 @@
1
  ---
2
- title: vansarah TTS
3
  emoji: πŸŽ™οΈ
4
  colorFrom: pink
5
  colorTo: purple
6
  sdk: gradio
7
- sdk_version: 5.42.0
8
  app_file: app.py
9
  pinned: false
10
- license: apache-2.0
11
- language:
12
- - en
13
- base_model:
14
- - yl4579/StyleTTS2-LJSpeech
15
- pipeline_tag: text-to-speech
16
- ---
17
-
18
- **vansarah** is an open-weight TTS model...
19
- ---
20
- **vansarah** is an open-weight TTS model with 82 million parameters. Despite its lightweight architecture, it delivers comparable quality to larger models while being significantly faster and more cost-efficient. With Apache-licensed weights, vansarah can be deployed anywhere from production environments to personal projects.
21
-
22
- <audio controls><source src="https://huggingface.co/mr-don88/vansarah-82M/resolve/main/samples/HEARME.wav" type="audio/wav"></audio>
23
-
24
- 🐈 **GitHub**: https://github.com/mr-don88/vansarah
25
-
26
- πŸš€ **Demo**: https://huggingface.co/spaces/MR-DON/vansarah-tts
27
-
28
- > [!NOTE]
29
- > As of April 2025, the market rate of vansarah served over API is **under $1 per million characters of text input**, or under $0.06 per hour of audio output. (On average, 1000 characters of input is about 1 minute of output.) Sources: [ArtificialAnalysis/Replicate at 65 cents per M chars](https://artificialanalysis.ai/text-to-speech/model-family/vansarah#price) and [DeepInfra at 80 cents per M chars](https://deepinfra.com/mr-don88/vansarah-82M).
30
- >
31
- > This is an Apache-licensed model, and vansarah has been deployed in numerous projects and commercial APIs. We welcome the deployment of the model in real use cases.
32
-
33
- > [!CAUTION]
34
- > Fake websites like vansarahttsai_com (snapshot: https://archive.ph/nRRnk) and vansarahtts_net (snapshot: https://archive.ph/60opa) are likely scams masquerading under the banner of a popular model.
35
- >
36
- > Any website containing "vansarah" in its root domain (e.g. vansarahttsai_com, vansarahtts_net) is **NOT owned by and NOT affiliated with this model page or its author**, and attempts to imply otherwise are red flags.
37
-
38
- - [Releases](#releases)
39
- - [Usage](#usage)
40
- - [EVAL.md](https://huggingface.co/mr-don88/vansarah-82M/blob/main/EVAL.md) ↗️
41
- - [SAMPLES.md](https://huggingface.co/mr-don88/vansarah-82M/blob/main/SAMPLES.md) ↗️
42
- - [VOICES.md](https://huggingface.co/mr-don88/vansarah-82M/blob/main/VOICES.md) ↗️
43
- - [Model Facts](#model-facts)
44
- - [Training Details](#training-details)
45
- - [Creative Commons Attribution](#creative-commons-attribution)
46
- - [Acknowledgements](#acknowledgements)
47
-
48
- ### Releases
49
-
50
- | Model | Published | Training Data | Langs & Voices | SHA256 |
51
- | ----- | --------- | ------------- | -------------- | ------ |
52
- | **v1.0** | **2025 Jan 27** | **Few hundred hrs** | [**8 & 54**](https://huggingface.co/mr-don88/vansarah-82M/blob/main/VOICES.md) | `496dba11` |
53
- | [v0.19](https://huggingface.co/mr-don88/kLegacy/tree/main/v0.19) | 2024 Dec 25 | <100 hrs | 1 & 10 | `3b0c392f` |
54
-
55
- | Training Costs | v0.19 | v1.0 | **Total** |
56
- | -------------- | ----- | ---- | ----- |
57
- | in A100 80GB GPU hours | 500 | 500 | **1000** |
58
- | average hourly rate | $0.80/h | $1.20/h | **$1/h** |
59
- | in USD | $400 | $600 | **$1000** |
60
-
61
- ### Usage
62
- You can run this basic cell on [Google Colab](https://colab.research.google.com/). [Listen to samples](https://huggingface.co/mr-don88/vansarah-82M/blob/main/SAMPLES.md). For more languages and details, see [Advanced Usage](https://github.com/mr-don88/vansarah?tab=readme-ov-file#advanced-usage).
63
- ```py
64
- !pip install -q vansarah>=0.9.2 soundfile
65
- !apt-get -qq -y install espeak-ng > /dev/null 2>&1
66
- from vansarah import KPipeline
67
- from IPython.display import display, Audio
68
- import soundfile as sf
69
- import torch
70
- pipeline = KPipeline(lang_code='a')
71
- text = '''
72
- [vansarah](/kˈOkΙ™ΙΉO/) is an open-weight TTS model with 82 million parameters. Despite its lightweight architecture, it delivers comparable quality to larger models while being significantly faster and more cost-efficient. With Apache-licensed weights, [vansarah](/kˈOkΙ™ΙΉO/) can be deployed anywhere from production environments to personal projects.
73
- '''
74
- generator = pipeline(text, voice='af_heart')
75
- for i, (gs, ps, audio) in enumerate(generator):
76
- print(i, gs, ps)
77
- display(Audio(data=audio, rate=24000, autoplay=i==0))
78
- sf.write(f'{i}.wav', audio, 24000)
79
- ```
80
- Under the hood, `vansarah` uses [`misaki`](https://pypi.org/project/misaki/), a G2P library at https://github.com/mr-don88/misaki
81
-
82
- ### Model Facts
83
-
84
- **Architecture:**
85
- - StyleTTS 2: https://arxiv.org/abs/2306.07691
86
- - ISTFTNet: https://arxiv.org/abs/2203.02395
87
- - Decoder only: no diffusion, no encoder release
88
-
89
- **Architected by:** Li et al @ https://github.com/yl4579/StyleTTS2
90
-
91
- **Trained by**: `@rzvzn` on Discord
92
-
93
- **Languages:** Multiple
94
-
95
- **Model SHA256 Hash:** `496dba118d1a58f5f3db2efc88dbdc216e0483fc89fe6e47ee1f2c53f18ad1e4`
96
-
97
- ### Training Details
98
-
99
- **Data:** vansarah was trained exclusively on **permissive/non-copyrighted audio data** and IPA phoneme labels. Examples of permissive/non-copyrighted audio include:
100
- - Public domain audio
101
- - Audio licensed under Apache, MIT, etc
102
- - Synthetic audio<sup>[1]</sup> generated by closed<sup>[2]</sup> TTS models from large providers<br/>
103
- [1] https://copyright.gov/ai/ai_policy_guidance.pdf<br/>
104
- [2] No synthetic audio from open TTS models or "custom voice clones"
105
-
106
- **Total Dataset Size:** A few hundred hours of audio
107
-
108
- **Total Training Cost:** About $1000 for 1000 hours of A100 80GB vRAM
109
-
110
- ### Creative Commons Attribution
111
-
112
- The following CC BY audio was part of the dataset used to train vansarah v1.0.
113
-
114
- | Audio Data | Duration Used | License | Added to Training Set After |
115
- | ---------- | ------------- | ------- | --------------------------- |
116
- | [Koniwa](https://github.com/koniwa/koniwa) `tnc` | <1h | [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/deed.ja) | v0.19 / 22 Nov 2024 |
117
- | [SIWIS](https://datashare.ed.ac.uk/handle/10283/2353) | <11h | [CC BY 4.0](https://datashare.ed.ac.uk/bitstream/handle/10283/2353/license_text) | v0.19 / 22 Nov 2024 |
118
-
119
- ### Acknowledgements
120
-
121
- - πŸ› οΈ [@yl4579](https://huggingface.co/yl4579) for architecting StyleTTS 2.
122
- - πŸ† [@Pendrokar](https://huggingface.co/Pendrokar) for adding vansarah as a contender in the TTS Spaces Arena.
123
- - πŸ“Š Thank you to everyone who contributed synthetic training data.
124
- - ❀️ Special thanks to all compute sponsors.
125
- - πŸ‘Ύ Discord server: https://discord.gg/QuGxSWBfQy
126
- - πŸͺ½ vansarah is a Japanese word that translates to "heart" or "spirit". It is also the name of an [AI in the Terminator franchise](https://terminator.fandom.com/wiki/vansarah).
 
1
  ---
2
+ title: vansarah TTS Demo
3
  emoji: πŸŽ™οΈ
4
  colorFrom: pink
5
  colorTo: purple
6
  sdk: gradio
7
+ sdk_version: 4.28.3
8
  app_file: app.py
9
  pinned: false
10
+ ---