Upload README.md with huggingface_hub

README.md

@@ -1,43 +1,21 @@
 # lylyreader-tts-models
 
 Modelos de TTS neural local para o **LylyReader** (app Android de audiobooks, repo
-`JonJonesBR/LylyReader-Android`). Infraestrutura de modelo do projeto num lugar só: o mesmo
-repositório hospeda o bundle do motor Kokoro (Base do PLANO_MELHORIAS_V6) e, futuramente, os
-bundles de vozes VITS da Parte A (ex.: MMS-TTS pt-BR convertido).
+`JonJonesBR/LylyReader-Android`). Infraestrutura de modelo do projeto num lugar só.
 
-## Arquivos
+## Bundle ATIVO — Kokoro FP32 (usado pelo app)
 
-| Arquivo | Tamanho | sha256 | Descrição |
-|---|---|---|---|
-| `kokoro-int8-multi-lang-v1_0.zip` | 131.770.328 bytes | `dd1ce371e7d1e42e73e03a171e713e1274d2c10a73f090fe93a294f00c4242e8` | Bundle do Kokoro-82M int8 (mesmo conteúdo do tarball oficial da k2-fsa, re-empacotado como ZIP porque o Android extrai zip com stdlib e o `.tar.bz2` exigiria dependência nova) |
-| `kokoro-int8-multi-lang-v1_0.zip.sha256` | — | — | Sidecar de checksum: o app baixa o zip, baixa o sidecar e valida o sha256 REAL antes de extrair (download corrompido/trocado nunca vira bundle) |
+| Arquivo | sha256 | Descrição |
+|---|---|---|
+| `kokoro-multi-lang-v1_0.zip` | ver `kokoro-multi-lang-v1_0.zip.sha256` | Bundle **FP32** do Kokoro-82M (sherpa-onnx v1.0): `model.onnx` (~310MB), voices.bin (53 vozes; pt-BR pf_dora/pm_alex/pm_santa = sids 42/43/44), tokens/lexicons en+zh, espeak-ng-data completo |
 
-### Conteúdo do zip (entradas na raiz, sem pasta-topo — extração direta em `filesDir/kokoro/`)
+**Por que FP32 (2026-09-03)**: o bundle INT8 (`kokoro-int8-multi-lang-v1_0.zip`, ainda hospedado
+como fallback/arquivo) tem artefato auditivo de **sibilo/chiado agudo** (ressalto ~9,6kHz +
+ruído de quantização — validado por ouvido contra o FP32, que é limpo). O app baixa o FP32.
 
-- `model.int8.onnx` (114,3MB) — Kokoro-82M quantizado int8 (exportação k2-fsa com metadata
-  `n_speakers`/`style_dim`/`has_espeak` própria do sherpa-onnx)
-- `voices.bin` (27,7MB) — 53 vozes (incl. pt-BR: pf_dora/pm_alex/pm_santa, sids 42/43/44)
-- `tokens.txt`, `lexicon-us-en.txt`, `lexicon-gb-en.txt`, `lexicon-zh.txt`
-- `espeak-ng-data/` — dados completos do espeak-ng (fonemização; contém `pt` e `pt-BR`)
-- `dict/` + FSTs (zh), `LICENSE`, `README.md`
-
-Fonte original: https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/kokoro-int8-multi-lang-v1_0.tar.bz2
-(release `tts-models` do k2-fsa/sherpa-onnx). Licença: Apache-2.0 (engine sherpa-onnx e pesos).
-
-## Uso no app
-
-Download sob demanda (nunca forçado): o usuário escolhe a voz Kokoro → confirma o download
-(~132MB; aviso quando fora de WiFi) → o app baixa o zip com resume, valida o sha256 do
-sidecar, extrai para `filesDir/kokoro/` e grava o marker `.ready`. O mecanismo (núcleo
-compartilhado de download com resume) é o mesmo que a Parte A do V6 usará para os bundles
-VITS (MMS pt-BR).
-
-## Por que hospedar aqui (e não só no GitHub da k2-fsa)
-
-Controle do ciclo de vida do bundle (não depende do release de terceiros permanecer estável),
-um único mecanismo de download no app, e consistência com a hospedagem da Parte A.
+Download sob demanda: zip + validação do sha256 do sidecar antes de extrair em
+`filesDir/kokoro/` (mesmo mecanismo para os bundles da Parte A). Fonte original: release
+`tts-models` do k2-fsa/sherpa-onnx. Licença Apache-2.0.
 
 ## Futuro (Parte A do V6)
-
-`vits-mms-por.zip` (MMS-TTS pt-BR no formato sherpa, conversão pela pipeline da k2-fsa)
-entrará neste mesmo repositório, com o mesmo esquema de zip + sidecar.
+`vits-mms-por.zip` (MMS-TTS pt-BR no formato sherpa) entrará neste mesmo repositório.