Upload README.md with huggingface_hub

README.md

@@ -1,10 +1,70 @@
----
-license: creativeml-openrail-m
-language:
-- nl
-base_model:
-- nari-labs/Dia-1.6B-0626
-pipeline_tag: text-to-speech
-tags:
-- code
----
+# Parkiet: Dutch Text-to-Speech (TTS)
+
+![Parkiet](images/parkiet.png)
+
+Open-weights Dutch TTS based on the [Parakeet](https://jordandarefsky.com/blog/2024/parakeet/) architecture, ported from [Dia](https://github.com/nari-labs/dia) to JAX for scalable training. A full walkthrough to train the model for your language on Google Cloud TPUs, can be found in the [TRAINING.md](TRAINING.md) doc.
+
+**Parkiet creates highly realistic voices from text**. You can guide the audio output to control emotion and tone. The model also supports nonverbal sounds (currently only laughter), and up to four different speakers per prompt. Voice cloning is also supported. Here are some samples.
+
+| Text | File |
+|---|---|
+| [S1] denk je dat je een open source model kan trainen met weinig geld en middelen? [S2] ja ik denk het wel. [S1] oh ja, hoe dan? [S2] nou kijk maar in de repo (laughs). | <video src="https://github.com/user-attachments/assets/3fd64933-1434-4a8c-924b-b0c55831df1f">
+| [S1] hoeveel stemmen worden er ondersteund? [S2] nou, uhm, ik denk toch wel meer dan twee. [S3] ja, ja, d dat is het mooie aan dit model. [S4] ja klopt, het ondersteund tot vier verschillende stemmen per prompt. | <video src="https://github.com/user-attachments/assets/6e428840-ca65-4b24-a63d-b6358d08b2f8"> 
+| [S1] h h et is dus ook mogelijk, om eh ... uhm, heel veel t te st stotteren in een prompt. | <video src="https://github.com/user-attachments/assets/0217d156-3729-4f2d-b6ec-5f7e8ce3f050"> |
+| [S1] je hebt maar weinig audio nodig om een stem te clonen de rest van deze tekst is uitgesproken door een computer. [S2] wauw, dat klinkt wel erg goed. [S1] ja, ik hoop dat je er wat aan hebt. | <video src="https://github.com/user-attachments/assets/f80d6b27-0719-4044-89cc-ae19230505ee">
+
+
+
+
+## Generation Guidelines
+
+* Use `[S1]`, `[S2]`, `[S3]`, `[S4]` to indicate the different speakers. Always start with `[S1]` and always alternate between [S1] and [S2] (i.e. [S1]... [S1]... is not good).
+* Prefer lower capital text prompts with punctuation. Write out digits as words. Even though the model should be able to handle some variety, it is better to stick close to the output of [WhisperD-NL](https://huggingface.co/pevers/whisperd-nl).
+* Slowing down can be encouraged by using `...` in the prompt.
+* Stuttering and disfluencies can be encouraged by using `eh`, `ehm`, `uh` or `uhm`.
+* Laughter can be added with the `(laughs)` tag. However, use it sparingly because the model quickly derails for too many events.
+
+## Quickstart
+
+```bash
+uv sync # For CPU
+uv sync --extra tpu # For TPU
+uv sync --extra cuda # For CUDA
+
+# Download the checkpoint
+wget https://huggingface.co/pevers/parkiet/blob/main/dia-nl-v1.zip -O weights/dia-nl-v1.zip
+
+# Create the checkpoint folder and unzip
+mkdir -p weights
+unzip weights/dia-nl-v1.zip -d weights
+
+# Run the inference demo
+# NOTE: Inference can take a while because of JAX compilation. Subsequent calls will be cached and much faster. I'm working on some performance improvements.
+uv run python src/parkiet/jax/inference.py
+```
+
+Notes:
+- We use the JAX model by default. The model is also ported back to PyTorch. However, I suspect that due to small differences in the attention kernel between PyTorch and JAX, the PyTorch model hallucinates more and generates strange artifacts more than the JAX model. You can download the PyTorch model from [HuggingFace](https://huggingface.co/pevers/parkiet/blob/main/dia-nl-v1.pth) and use it in the [Dia](https://github.com/nari-labs/dia) pipeline.
+
+## ⚠️ Disclaimer
+This project offers a high-fidelity speech generation model intended for research and educational use. The following uses are strictly forbidden:
+
+* Identity Misuse: Do not produce audio resembling real individuals without permission.
+* Deceptive Content: Do not use this model to generate misleading content (e.g. fake news).
+* Illegal or Malicious Use: Do not use this model for activities that are illegal or intended to cause harm.
+By using this model, you agree to uphold relevant legal standards and ethical responsibilities. We are not responsible for any misuse and firmly oppose any unethical usage of this technology.
+
+## Training
+
+For a full guide on data preparation, model conversion and the TPU setup to train this model for any language, see [TRAINING.md](https://github.com/pevers/parkiet/blob/main/TRAINING.md).
+
+## Acknowledgements
+
+* Darefsky for the excellent blog post on [Parakeet](https://jordandarefsky.com/blog/2024/parakeet/).
+* [Dia](https://github.com/nari-labs/) for open-sourcing the PyTorch model.
+* [Bas Büller](http://github.com/basbuller) for the endless discussions until it finally worked 🙌.
+* [Google Cloud TPU Research Cloud Program](https://sites.research.google/trc/about/) for providing the computation resources.
+
+## License
+
+Repository code is licensed under the [MIT License](LICENSE). The TTS model itself is licensed as [RAIL-M](MODEL_LICENSE).