loudr-1: add LoudKit branding

#3
by jer3mi - opened
Files changed (5) hide show
  1. .gitattributes +1 -0
  2. README.md +21 -13
  3. SHA256SUMS +3 -2
  4. logo.png +3 -0
  5. release.json +7 -2
.gitattributes CHANGED
@@ -53,3 +53,4 @@ voices/refs/selma.wav filter=lfs diff=lfs merge=lfs -text
53
  voices/refs/soren.wav filter=lfs diff=lfs merge=lfs -text
54
  voices/refs/thorsten.wav filter=lfs diff=lfs merge=lfs -text
55
  voices/refs/tugao.wav filter=lfs diff=lfs merge=lfs -text
 
 
53
  voices/refs/soren.wav filter=lfs diff=lfs merge=lfs -text
54
  voices/refs/thorsten.wav filter=lfs diff=lfs merge=lfs -text
55
  voices/refs/tugao.wav filter=lfs diff=lfs merge=lfs -text
56
+ logo.png filter=lfs diff=lfs merge=lfs -text
README.md CHANGED
@@ -20,19 +20,23 @@ language:
20
  - da
21
  ---
22
 
 
 
 
 
23
  # loudr-1
24
 
25
  **Natural-sounding text-to-speech with twenty voices, ten languages and voice
26
  cloning.**
27
 
28
  loudr-1 runs on your own hardware through
29
- [loudkit](https://github.com/pepinu/loudkit). Download it once and work offline
30
  from Python, Swift, Go, Rust or TypeScript with PyTorch, ONNX Runtime or CoreML.
31
 
32
- [**Hear all 20 voices**](https://pepinu.github.io/loudkit/demo/) |
33
- [**Open in Colab**](https://colab.research.google.com/github/pepinu/loudkit/blob/main/notebooks/loudkit_quickstart.ipynb) |
34
- [**GitHub**](https://github.com/pepinu/loudkit) |
35
- [**Documentation**](https://pepinu.github.io/loudkit/)
36
 
37
  ## Listen
38
 
@@ -45,7 +49,7 @@ from Python, Swift, Go, Rust or TypeScript with PyTorch, ONNX Runtime or CoreML.
45
  <audio controls src="https://huggingface.co/loudreader/loudr-1/resolve/main/samples/kathleen.opus"></audio>
46
 
47
  Both voices read the same passage from *Alice's Adventures in Wonderland*.
48
- [Open the gallery](https://pepinu.github.io/loudkit/demo/) to compare every
49
  shipped voice with the enrollment reference used to create its profile.
50
 
51
  > English is the only language we could evaluate ourselves by ear. We do not
@@ -111,10 +115,14 @@ shared cache. The synthesis checkpoint will be at
111
  |---|---|---:|
112
  | PyTorch with CUDA graphs | RTX 3090 | 7.47x |
113
  | PyTorch with CUDA graphs | Jetson Orin Nano | 1.83x |
114
- | split PyTorch engine | Apple M3 Pro | 3.43x |
115
  | ONNX Runtime, CPU provider | Apple M3 Pro | 1.21x |
116
  | PyTorch CPU reference | Apple M3 Pro | 0.33x |
117
 
 
 
 
 
118
  Higher is faster, and 1.0x means real time. ONNX Runtime on the measured M3 Pro
119
  CPU is faster than real time. The PyTorch CPU reference path on the same machine
120
  is not.
@@ -123,7 +131,7 @@ For batched workloads, the token generator reaches 20.1x aggregate throughput
123
  at batch 1 and 153.1x at batch 64 on the RTX 3090. The highest measured result
124
  is 170.8x on an A100 at batch 64. These are generator-only throughput numbers,
125
  not single-request latency or end-to-end RTF. See the
126
- [benchmark report](https://pepinu.github.io/loudkit/benchmarks/) for commands,
127
  hardware and caveats.
128
 
129
  ## What ships
@@ -151,15 +159,15 @@ Spanish, French, German, Italian, Polish, Portuguese, Dutch, Swedish and Danish.
151
 
152
  The profiles were built from recordings donated for speech technology or from
153
  CC0 and CC-BY speech corpora. No scraped celebrity voices ship with the model.
154
- [The full roster](https://github.com/pepinu/loudkit/blob/main/VOICES.md) records
155
  the source, licence and consent basis for every profile. The
156
- [voice gallery](https://pepinu.github.io/loudkit/demo/) provides a generated
157
  sample and enrollment preview for all twenty.
158
 
159
  The source enrollment WAVs are not redistributed in the model repository. Their
160
  digests, construction notes and the digests of every shipped profile and sample
161
  are recorded in
162
- [provenance.json](https://github.com/pepinu/loudkit/blob/main/docs/voices/roster/provenance.json).
163
 
164
  ## Model lineage
165
 
@@ -183,8 +191,8 @@ execution means that waveforms are not promised to be byte-identical across
183
  different runtimes.
184
 
185
  The exact contract and current measurements are in the
186
- [identity contract](https://github.com/pepinu/loudkit/blob/main/docs/reference/IDENTITY-CONTRACT.md)
187
- and [measured parity report](https://pepinu.github.io/loudkit/parity-measured/).
188
 
189
  ## Before you ship
190
 
 
20
  - da
21
  ---
22
 
23
+ <p align="center">
24
+ <img src="https://huggingface.co/loudreader/loudr-1/resolve/main/logo.png" alt="LoudKit" width="640">
25
+ </p>
26
+
27
  # loudr-1
28
 
29
  **Natural-sounding text-to-speech with twenty voices, ten languages and voice
30
  cloning.**
31
 
32
  loudr-1 runs on your own hardware through
33
+ [loudkit](https://github.com/loudreader/loudkit). Download it once and work offline
34
  from Python, Swift, Go, Rust or TypeScript with PyTorch, ONNX Runtime or CoreML.
35
 
36
+ [**Hear all 20 voices**](https://loudreader.github.io/loudkit/demo/) |
37
+ [**Open in Colab**](https://colab.research.google.com/github/loudreader/loudkit/blob/main/notebooks/loudkit_quickstart.ipynb) |
38
+ [**GitHub**](https://github.com/loudreader/loudkit) |
39
+ [**Documentation**](https://loudreader.github.io/loudkit/)
40
 
41
  ## Listen
42
 
 
49
  <audio controls src="https://huggingface.co/loudreader/loudr-1/resolve/main/samples/kathleen.opus"></audio>
50
 
51
  Both voices read the same passage from *Alice's Adventures in Wonderland*.
52
+ [Open the gallery](https://loudreader.github.io/loudkit/demo/) to compare every
53
  shipped voice with the enrollment reference used to create its profile.
54
 
55
  > English is the only language we could evaluate ourselves by ear. We do not
 
115
  |---|---|---:|
116
  | PyTorch with CUDA graphs | RTX 3090 | 7.47x |
117
  | PyTorch with CUDA graphs | Jetson Orin Nano | 1.83x |
118
+ | split PyTorch engine\* | Apple M3 Pro | 3.43x |
119
  | ONNX Runtime, CPU provider | Apple M3 Pro | 1.21x |
120
  | PyTorch CPU reference | Apple M3 Pro | 0.33x |
121
 
122
+ \* "Split" describes device placement, not a different model or checkpoint.
123
+ The token generator runs on the CPU while the mel and vocoder renderer runs on
124
+ the Apple GPU through MPS. Adjacent windows can overlap across the two devices.
125
+
126
  Higher is faster, and 1.0x means real time. ONNX Runtime on the measured M3 Pro
127
  CPU is faster than real time. The PyTorch CPU reference path on the same machine
128
  is not.
 
131
  at batch 1 and 153.1x at batch 64 on the RTX 3090. The highest measured result
132
  is 170.8x on an A100 at batch 64. These are generator-only throughput numbers,
133
  not single-request latency or end-to-end RTF. See the
134
+ [benchmark report](https://loudreader.github.io/loudkit/benchmarks/) for commands,
135
  hardware and caveats.
136
 
137
  ## What ships
 
159
 
160
  The profiles were built from recordings donated for speech technology or from
161
  CC0 and CC-BY speech corpora. No scraped celebrity voices ship with the model.
162
+ [The full roster](https://github.com/loudreader/loudkit/blob/main/VOICES.md) records
163
  the source, licence and consent basis for every profile. The
164
+ [voice gallery](https://loudreader.github.io/loudkit/demo/) provides a generated
165
  sample and enrollment preview for all twenty.
166
 
167
  The source enrollment WAVs are not redistributed in the model repository. Their
168
  digests, construction notes and the digests of every shipped profile and sample
169
  are recorded in
170
+ [provenance.json](https://github.com/loudreader/loudkit/blob/main/docs/voices/roster/provenance.json).
171
 
172
  ## Model lineage
173
 
 
191
  different runtimes.
192
 
193
  The exact contract and current measurements are in the
194
+ [identity contract](https://github.com/loudreader/loudkit/blob/main/docs/reference/IDENTITY-CONTRACT.md)
195
+ and [measured parity report](https://loudreader.github.io/loudkit/parity-measured/).
196
 
197
  ## Before you ship
198
 
SHA256SUMS CHANGED
@@ -50,10 +50,11 @@ e7f2f756511fe047d0cd1997cdf2d42ba5c0c9fc8273c4450d25587e9e7aa77e coreml/camp.ml
50
  759103649d9bf8d388b523b915e1eb9b285fb81e58fdef6d420d4c7e21053765 coreml/voice_encoder.mlpackage/Data/com.apple.CoreML/model.mlmodel
51
  95b1a8b8c6b558fafee4a1c784076c8e099070c45958526c9a187c15de55d2d3 coreml/voice_encoder.mlpackage/Data/com.apple.CoreML/weights/weight.bin
52
  fbd810d98add4c3349f01891e1b7c6dc975070bfa83e78f8f8a115f5dcea3c55 coreml/voice_encoder.mlpackage/Manifest.json
53
- dac906a2310982bb236b258db60f81141224087d54a3a66259332a74cb786c4a README.md
54
  5d5671b95e9797856175dd08d5d2f20d21d72e8785aba077ee38eb378d432528 LICENSE
55
  fda3657fa4d457f9dc379c1ca8550d665eb972ac1c7a260fbe94821ef418ff28 NOTICE
56
  87c35454a03b026a5a13093566ace245c339dc6af68c7f794f6ed322a731f753 RESPONSIBLE_USE.md
 
57
  83e0bf0a1f6b03e047de66871536c3ff77291041d0a3f2907b6990e580519fea samples/joe.opus
58
  48615517c1d1d2d55dbb7f74f37982918236e33f079947459d56c116cd70b7a3 samples/kathleen.opus
59
- 4058b467cd4a585bc1f39f1d236793181fef0b2e31dacdfb4cc8e31fb22f0aff release.json
 
50
  759103649d9bf8d388b523b915e1eb9b285fb81e58fdef6d420d4c7e21053765 coreml/voice_encoder.mlpackage/Data/com.apple.CoreML/model.mlmodel
51
  95b1a8b8c6b558fafee4a1c784076c8e099070c45958526c9a187c15de55d2d3 coreml/voice_encoder.mlpackage/Data/com.apple.CoreML/weights/weight.bin
52
  fbd810d98add4c3349f01891e1b7c6dc975070bfa83e78f8f8a115f5dcea3c55 coreml/voice_encoder.mlpackage/Manifest.json
53
+ 8a75580837b18451c432b17e5f4769507a222cbe770b0591b1707b94c0e57622 README.md
54
  5d5671b95e9797856175dd08d5d2f20d21d72e8785aba077ee38eb378d432528 LICENSE
55
  fda3657fa4d457f9dc379c1ca8550d665eb972ac1c7a260fbe94821ef418ff28 NOTICE
56
  87c35454a03b026a5a13093566ace245c339dc6af68c7f794f6ed322a731f753 RESPONSIBLE_USE.md
57
+ f90d7077925cb35277579c93e57c701e3198df09b21830ccfb14f56c4c4507ea logo.png
58
  83e0bf0a1f6b03e047de66871536c3ff77291041d0a3f2907b6990e580519fea samples/joe.opus
59
  48615517c1d1d2d55dbb7f74f37982918236e33f079947459d56c116cd70b7a3 samples/kathleen.opus
60
+ fb7ed0196f3175e3a4880085ca876c7e76d0f82a020a0e30c3966d292c68adf7 release.json
logo.png ADDED

Git LFS Details

  • SHA256: f90d7077925cb35277579c93e57c701e3198df09b21830ccfb14f56c4c4507ea
  • Pointer size: 131 Bytes
  • Size of remote file: 957 kB
release.json CHANGED
@@ -268,8 +268,8 @@
268
  ],
269
  "readme": {
270
  "path": "README.md",
271
- "sha256": "dac906a2310982bb236b258db60f81141224087d54a3a66259332a74cb786c4a",
272
- "bytes": 8274
273
  },
274
  "license": {
275
  "path": "LICENSE",
@@ -286,6 +286,11 @@
286
  "sha256": "87c35454a03b026a5a13093566ace245c339dc6af68c7f794f6ed322a731f753",
287
  "bytes": 4022
288
  },
 
 
 
 
 
289
  "samples": [
290
  {
291
  "path": "samples/joe.opus",
 
268
  ],
269
  "readme": {
270
  "path": "README.md",
271
+ "sha256": "8a75580837b18451c432b17e5f4769507a222cbe770b0591b1707b94c0e57622",
272
+ "bytes": 8689
273
  },
274
  "license": {
275
  "path": "LICENSE",
 
286
  "sha256": "87c35454a03b026a5a13093566ace245c339dc6af68c7f794f6ed322a731f753",
287
  "bytes": 4022
288
  },
289
+ "logo": {
290
+ "path": "logo.png",
291
+ "sha256": "f90d7077925cb35277579c93e57c701e3198df09b21830ccfb14f56c4c4507ea",
292
+ "bytes": 957113
293
+ },
294
  "samples": [
295
  {
296
  "path": "samples/joe.opus",