docs: full model card (ownership, usage, datasets)

README.md

@@ -1,9 +1,77 @@
 ---
-datasets:
-- TigreGotico/tts_vc_LaFrescat-ca-ES-central_miro
 language:
 - ca
+license: cc-by-nc-nd-4.0
+pipeline_tag: text-to-speech
+datasets:
+- TigreGotico/tts_vc_LaFrescat-ca-ES-central_miro
 base_model:
 - OpenVoiceOS/phoonnx_an_miro_unicode
-pipeline_tag: text-to-speech
----
+tags:
+- phoonnx
+- onnx
+- vits
+- text-to-speech
+- ca
+---
+
+# phoonnx_ca_miro_espeak
+
+This is a text-to-speech voice model for **Catalan**. The voice is **Miro**, a male voice. It uses the phoonnx VITS architecture with espeak-ng for phonemization, exported to ONNX for CPU inference. It was built by voice conversion from the base voice `phoonnx_an_miro_unicode`.
+
+## How to use
+
+Install [phoonnx](https://github.com/TigreGotico/phoonnx) and run:
+
+```python
+import wave
+from phoonnx.config import SynthesisConfig
+from phoonnx.voice import TTSVoice
+
+voice = TTSVoice.from_hf("OpenVoiceOS/phoonnx_ca_miro_espeak")
+
+synthesis_config = SynthesisConfig(noise_scale=0.667, length_scale=1.0, noise_w_scale=0.8)
+
+with wave.open("output.wav", "wb") as wav_file:
+    voice.synthesize_wav("Bon dia, com estàs?", wav_file, synthesis_config)
+```
+
+You can also use this model in OVOS with
+[ovos-tts-plugin-phoonnx](https://github.com/OpenVoiceOS/ovos-tts-plugin-phoonnx):
+
+```json
+{
+  "tts": {
+    "module": "ovos-tts-plugin-phoonnx",
+    "ovos-tts-plugin-phoonnx": {
+      "voice": "OpenVoiceOS/phoonnx_ca_miro_espeak"
+    }
+  }
+}
+```
+
+## Training data
+
+Trained on [TigreGotico/tts_vc_LaFrescat-ca-ES-central_miro](https://huggingface.co/datasets/TigreGotico/tts_vc_LaFrescat-ca-ES-central_miro).
+
+## Related links
+
+- Training-data collection: https://huggingface.co/collections/TigreGotico/synthetic-tts-datasets
+- phoonnx: https://github.com/TigreGotico/phoonnx
+- voiceclonnx: https://github.com/TigreGotico/voiceclonnx
+- TigreGotico: https://tigregotico.pt
+
+## Ownership and licensing
+
+Miro and Dii are the recorded voices of two real people. The voices, the
+training data, and this model belong to TigreGotico Lda
+(https://tigregotico.pt).
+
+This model is licensed under Creative Commons
+Attribution-NonCommercial-NoDerivatives 4.0 (CC BY-NC-ND 4.0). You may use
+and share this model for non-commercial purposes only. Give attribution to
+TigreGotico Lda. Do not modify, adapt, or build new models from this model.
+Do not use the voice identity to create derivative voices.
+
+For commercial use, for derivative models, or for any other license of the
+Miro or Dii voice identity, contact TigreGotico Lda.