Notes on Outetts Compatibility changes

README.md

@@ -26,12 +26,23 @@ This is a text-to-speech (TTS) model for Moroccan Darija, fine-tuned from [OuteA
 - **Demo:** [Try it here](https://huggingface.co/spaces/Lyte/DarijaTTS-test)
 
 ## Usage
+
+> [!IMPORTANT]
+> **Compatibility Note**
+> Recent updates to `outetts` have introduced breaking changes. If you encounter the error:
+> `AttributeError: module 'outetts' has no attribute 'GGUFModelConfig_v2'`
+>
+> **Solution:** Please install a compatible version (0.3.3 or 0.3.2) to resolve this:
+> ```bash
+> pip install outetts==0.3.3
+> ```
+
 You can run the model using `outetts` as follows:
 
-install `outetts` and `llama-cpp-python`
+Install `outetts` and `llama-cpp-python`:
 ```bash
-pip install outetts llama-cpp-python huggingface_hub
-```
+pip install outetts==0.3.3 llama-cpp-python huggingface_hub
+````
 
 ```python
 import outetts
@@ -66,11 +77,13 @@ print(f"Generated audio saved at: {audio_path}")
 ```
 
 ## Training
+
 The model was fine-tuned using `Unsloth`'s `SFTTrainer`. The dataset was preprocessed following the [OuteTTS training guide](https://github.com/edwko/OuteTTS/blob/main/examples/training/OuteTTS-0.3/train.md). LoRA-based fine-tuning was applied to improve efficiency.
 
 # Support Me
 
-[![Buy Me A Coffee](https://img.shields.io/badge/Ko--fi-Support%20My%20Work-FF5E5B?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/lyte)
+[](https://ko-fi.com/lyte)
 
----
-For any issues or improvements, feel free to open a discussion or PR!
+-----
+
+For any issues or improvements, feel free to open a discussion or PR\!