Upload 2 files
Browse files
README.md
CHANGED
|
@@ -12,13 +12,13 @@ pipeline_tag: text-to-speech
|
|
| 12 |
|
| 13 |
**Kokoro** 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, Kokoro can be deployed anywhere from production environments to personal projects.
|
| 14 |
|
| 15 |
-
- [Releases](
|
| 16 |
-
- [Usage](
|
| 17 |
-
- [
|
| 18 |
-
- [Model Facts](
|
| 19 |
-
- [Training Details](
|
| 20 |
-
- [Creative Commons Attribution](
|
| 21 |
-
- [Acknowledgements](
|
| 22 |
|
| 23 |
### Releases
|
| 24 |
|
|
@@ -79,20 +79,6 @@ for i, (gs, ps, audio) in enumerate(generator):
|
|
| 79 |
|
| 80 |
Under the hood, `kokoro` uses [`misaki`](https://pypi.org/project/misaki/), a G2P library at https://github.com/hexgrad/misaki
|
| 81 |
|
| 82 |
-
### Voices and Languages
|
| 83 |
-
|
| 84 |
-
Voices are listed in [VOICES.md](https://huggingface.co/hexgrad/Kokoro-82M/blob/main/VOICES.md). Not all voices are created equal:
|
| 85 |
-
- Subjectively, voices will sound better or worse to different people.
|
| 86 |
-
- Less training data for a given voice (minutes instead of hours) => worse inference quality.
|
| 87 |
-
- Poor audio quality in training data (compression, sample rate, artifacts) => worse inference quality.
|
| 88 |
-
- Text-audio misalignment alignment (too much text i.e. hallucinations, or not enough text i.e. failed transcriptions) => worse inference quality.
|
| 89 |
-
|
| 90 |
-
Support for non-English languages may be absent or thin due to weak G2P and/or lack of training data. Some languages are only represented by a small handful or even just one voice (French).
|
| 91 |
-
|
| 92 |
-
Most voices perform best on a "goldilocks range" of 100-200 tokens out of ~500 possible. Voices may perform worse at the extremes:
|
| 93 |
-
- **Weakness** on short utterances, especially less than 10-20 tokens. Root cause could be lack of short-utterance training data and/or model architecture. One possible inference mitigation is to bundle shorter utterances together.
|
| 94 |
-
- **Rushing** on long utterances, especially over 400 tokens. You can chunk down to shorter utterances or adjust the `speed` parameter to mitigate this.
|
| 95 |
-
|
| 96 |
### Model Facts
|
| 97 |
|
| 98 |
**Architecture:**
|
|
|
|
| 12 |
|
| 13 |
**Kokoro** 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, Kokoro can be deployed anywhere from production environments to personal projects.
|
| 14 |
|
| 15 |
+
- [Releases](#releases)
|
| 16 |
+
- [Usage](#usage)
|
| 17 |
+
- [VOICES.md](https://huggingface.co/hexgrad/Kokoro-82M/blob/main/VOICES.md) โ๏ธ
|
| 18 |
+
- [Model Facts](#model-facts)
|
| 19 |
+
- [Training Details](#training-details)
|
| 20 |
+
- [Creative Commons Attribution](#creative-commons-attribution)
|
| 21 |
+
- [Acknowledgements](#acknowledgements)
|
| 22 |
|
| 23 |
### Releases
|
| 24 |
|
|
|
|
| 79 |
|
| 80 |
Under the hood, `kokoro` uses [`misaki`](https://pypi.org/project/misaki/), a G2P library at https://github.com/hexgrad/misaki
|
| 81 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 82 |
### Model Facts
|
| 83 |
|
| 84 |
**Architecture:**
|
VOICES.md
CHANGED
|
@@ -1,9 +1,23 @@
|
|
| 1 |
# Voices
|
| 2 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
For each voice, the given grades are intended to be estimates of the **quality and quantity** of its associated training data, both of which impact overall inference quality.
|
| 4 |
|
| 5 |
Subjectively, voices will sound better or worse to different people.
|
| 6 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
**Target Quality**
|
| 8 |
- How high quality is the reference voice? This grade may be impacted by audio quality, artifacts, compression, & sample rate.
|
| 9 |
- How well do the text labels match the audio? Text/audio misalignment (e.g. from hallucinations) will lower this grade.
|
|
@@ -15,10 +29,10 @@ Subjectively, voices will sound better or worse to different people.
|
|
| 15 |
- 10 minutes <= MM minutes < 100 minutes
|
| 16 |
- 1 minute <= _M minutes_ < 10 minutes ๐ค
|
| 17 |
|
| 18 |
-
### American English
|
| 19 |
|
| 20 |
-
|
| 21 |
-
|
| 22 |
|
| 23 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 24 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
|
@@ -42,10 +56,10 @@ Subjectively, voices will sound better or worse to different people.
|
|
| 42 |
| am_puck | ๐น | B | H hours | C+ | `dd1d8973` |
|
| 43 |
| am_santa | ๐น๐ค | C | _M minutes_ | D- | `7f2f7582` |
|
| 44 |
|
| 45 |
-
### British English
|
| 46 |
|
| 47 |
-
|
| 48 |
-
|
| 49 |
|
| 50 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 51 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
|
@@ -58,21 +72,21 @@ Subjectively, voices will sound better or worse to different people.
|
|
| 58 |
| bm_george | ๐น | B | MM minutes | C | `f1bc8122` |
|
| 59 |
| bm_lewis | ๐น | C | H hours | D+ | `b5204750` |
|
| 60 |
|
| 61 |
-
### French
|
| 62 |
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
|
| 67 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 | CC BY |
|
| 68 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ | ----- |
|
| 69 |
| ff_siwis | ๐บ | B | <11 hours | B- | `8073bf2d` | [SIWIS](https://datashare.ed.ac.uk/handle/10283/2353) |
|
| 70 |
|
| 71 |
-
### Hindi
|
| 72 |
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
|
| 77 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 78 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
|
@@ -81,21 +95,21 @@ Subjectively, voices will sound better or worse to different people.
|
|
| 81 |
| hm_omega | ๐น | B | MM minutes | C | `b55f02a8` |
|
| 82 |
| hm_psi | ๐น | B | MM minutes | C | `2f0f055c` |
|
| 83 |
|
| 84 |
-
### Italian
|
| 85 |
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
|
| 90 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 91 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
| 92 |
| if_sara | ๐บ | B | MM minutes | C | `6c0b253b` |
|
| 93 |
| im_nicola | ๐น | B | MM minutes | C | `234ed066` |
|
| 94 |
|
| 95 |
-
### Japanese
|
| 96 |
|
| 97 |
-
|
| 98 |
-
|
| 99 |
|
| 100 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 | CC BY |
|
| 101 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ | ----- |
|
|
@@ -105,10 +119,10 @@ Subjectively, voices will sound better or worse to different people.
|
|
| 105 |
| jf_tebukuro | ๐บ | B | MM minutes | C | `0d691790` | [tebukurowokaini](https://github.com/koniwa/koniwa/blob/master/source/tnc/tnc__tebukurowokaini.txt) |
|
| 106 |
| jm_kumo | ๐น๐ค | B | _M minutes_ | C- | `98340afd` | [kumonoito](https://github.com/koniwa/koniwa/blob/master/source/tnc/tnc__kumonoito.txt) |
|
| 107 |
|
| 108 |
-
### Mandarin Chinese
|
| 109 |
|
| 110 |
-
|
| 111 |
-
|
| 112 |
|
| 113 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 114 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
|
|
|
| 1 |
# Voices
|
| 2 |
|
| 3 |
+
๐บ๐ธ [American English](#american-english): 10F 9M
|
| 4 |
+
๐ฌ๐ง [British English](#british-english): 4F 4M
|
| 5 |
+
๐ซ๐ท [French](#french): 1F
|
| 6 |
+
๐ฎ๐ณ [Hindi](#hindi): 2F 2M
|
| 7 |
+
๐ฎ๐น [Italian](#italian): 1F 1M
|
| 8 |
+
๐ฏ๐ต [Japanese](#japanese): 4F 1M
|
| 9 |
+
๐จ๐ณ [Mandarin Chinese](#mandarin-chinese): 4F 4M
|
| 10 |
+
|
| 11 |
For each voice, the given grades are intended to be estimates of the **quality and quantity** of its associated training data, both of which impact overall inference quality.
|
| 12 |
|
| 13 |
Subjectively, voices will sound better or worse to different people.
|
| 14 |
|
| 15 |
+
Support for non-English languages may be absent or thin due to weak G2P and/or lack of training data. Some languages are only represented by a small handful or even just one voice (French).
|
| 16 |
+
|
| 17 |
+
Most voices perform best on a "goldilocks range" of 100-200 tokens out of ~500 possible. Voices may perform worse at the extremes:
|
| 18 |
+
- **Weakness** on short utterances, especially less than 10-20 tokens. Root cause could be lack of short-utterance training data and/or model architecture. One possible inference mitigation is to bundle shorter utterances together.
|
| 19 |
+
- **Rushing** on long utterances, especially over 400 tokens. You can chunk down to shorter utterances or adjust the `speed` parameter to mitigate this.
|
| 20 |
+
|
| 21 |
**Target Quality**
|
| 22 |
- How high quality is the reference voice? This grade may be impacted by audio quality, artifacts, compression, & sample rate.
|
| 23 |
- How well do the text labels match the audio? Text/audio misalignment (e.g. from hallucinations) will lower this grade.
|
|
|
|
| 29 |
- 10 minutes <= MM minutes < 100 minutes
|
| 30 |
- 1 minute <= _M minutes_ < 10 minutes ๐ค
|
| 31 |
|
| 32 |
+
### American English
|
| 33 |
|
| 34 |
+
๐บ๐ธ `lang_code='a'` in [`misaki[en]`](https://github.com/hexgrad/misaki)
|
| 35 |
+
๐บ๐ธ espeak-ng `en-us` fallback
|
| 36 |
|
| 37 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 38 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
|
|
|
| 56 |
| am_puck | ๐น | B | H hours | C+ | `dd1d8973` |
|
| 57 |
| am_santa | ๐น๐ค | C | _M minutes_ | D- | `7f2f7582` |
|
| 58 |
|
| 59 |
+
### British English
|
| 60 |
|
| 61 |
+
๐ฌ๐ง `lang_code='b'` in [`misaki[en]`](https://github.com/hexgrad/misaki)
|
| 62 |
+
๐ฌ๐ง espeak-ng `en-gb` fallback
|
| 63 |
|
| 64 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 65 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
|
|
|
| 72 |
| bm_george | ๐น | B | MM minutes | C | `f1bc8122` |
|
| 73 |
| bm_lewis | ๐น | C | H hours | D+ | `b5204750` |
|
| 74 |
|
| 75 |
+
### French
|
| 76 |
|
| 77 |
+
๐ซ๐ท `lang_code='f'` in [`misaki[en]`](https://github.com/hexgrad/misaki)
|
| 78 |
+
๐ซ๐ท espeak-ng `fr-fr`
|
| 79 |
+
๐ซ๐ท Total French training data: <11 hours
|
| 80 |
|
| 81 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 | CC BY |
|
| 82 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ | ----- |
|
| 83 |
| ff_siwis | ๐บ | B | <11 hours | B- | `8073bf2d` | [SIWIS](https://datashare.ed.ac.uk/handle/10283/2353) |
|
| 84 |
|
| 85 |
+
### Hindi
|
| 86 |
|
| 87 |
+
๐ฎ๐ณ `lang_code='h'` in [`misaki[en]`](https://github.com/hexgrad/misaki)
|
| 88 |
+
๐ฎ๐ณ espeak-ng `hi`
|
| 89 |
+
๐ฎ๐ณ Total Hindi training data: H hours
|
| 90 |
|
| 91 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 92 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
|
|
|
| 95 |
| hm_omega | ๐น | B | MM minutes | C | `b55f02a8` |
|
| 96 |
| hm_psi | ๐น | B | MM minutes | C | `2f0f055c` |
|
| 97 |
|
| 98 |
+
### Italian
|
| 99 |
|
| 100 |
+
๐ฎ๐น `lang_code='i'` in [`misaki[en]`](https://github.com/hexgrad/misaki)
|
| 101 |
+
๐ฎ๐น espeak-ng `it`
|
| 102 |
+
๐ฎ๐น Total Italian training data: H hours
|
| 103 |
|
| 104 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 105 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|
| 106 |
| if_sara | ๐บ | B | MM minutes | C | `6c0b253b` |
|
| 107 |
| im_nicola | ๐น | B | MM minutes | C | `234ed066` |
|
| 108 |
|
| 109 |
+
### Japanese
|
| 110 |
|
| 111 |
+
๐ฏ๐ต `lang_code='j'` in [`misaki[ja]`](https://github.com/hexgrad/misaki)
|
| 112 |
+
๐ฏ๐ต Total Japanese training data: H hours
|
| 113 |
|
| 114 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 | CC BY |
|
| 115 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ | ----- |
|
|
|
|
| 119 |
| jf_tebukuro | ๐บ | B | MM minutes | C | `0d691790` | [tebukurowokaini](https://github.com/koniwa/koniwa/blob/master/source/tnc/tnc__tebukurowokaini.txt) |
|
| 120 |
| jm_kumo | ๐น๐ค | B | _M minutes_ | C- | `98340afd` | [kumonoito](https://github.com/koniwa/koniwa/blob/master/source/tnc/tnc__kumonoito.txt) |
|
| 121 |
|
| 122 |
+
### Mandarin Chinese
|
| 123 |
|
| 124 |
+
๐จ๐ณ `lang_code='z'` in [`misaki[zh]`](https://github.com/hexgrad/misaki)
|
| 125 |
+
๐จ๐ณ Total Mandarin Chinese training data: H hours
|
| 126 |
|
| 127 |
| Name | Traits | Target Quality | Training Duration | Overall Grade | SHA256 |
|
| 128 |
| ---- | ------ | -------------- | ----------------- | ------------- | ------ |
|