Create README.md

README.md

@@ -0,0 +1,62 @@
+---
+license: apache-2.0
+base_model:
+- m-a-p/YuE-s1-7B-anneal-zh-icl
+tags:
+- yue
+- music
+- suno
+---
+
+
+# YuE Quantized Models
+
+Welcome to the repository for **YuE Quantized Models**! These models are quantized versions of the original YuE models, optimized for efficient inference while maintaining high-quality music generation capabilities. You can use these models directly or through the **YuE Interface**, a user-friendly Docker-based solution for generating music.
+
+## 🚀 YuE Interface
+
+To easily interact with these models, check out the **[YuE Interface](https://github.com/alisson-anjos/YuE-Interface)**, a robust and intuitive Docker-based interface that leverages Gradio for a seamless music generation experience. The interface supports both local deployment and cloud-based solutions like RunPod.
+
+### Key Features of the YuE Interface:
+- **Docker Image**: Pre-configured for easy setup.
+- **Web UI (Gradio)**: Intuitive interface for configuring and executing music generation tasks.
+- **NVIDIA GPU Support**: Accelerated processing for faster results.
+- **Model Management**: Download and manage specific YuE models.
+- **Real-time Logging**: Monitor generation logs directly from the interface.
+- **Audio Playback and Download**: Listen to and download generated audio files.
+
+For detailed instructions on how to use these models with the YuE Interface, please refer to the **[YuE Interface README](https://github.com/alisson-anjos/YuE-Interface)**.
+
+## Available Quantized Models
+
+Below is the list of quantized models available in this repository:
+
+| Model Name                          | Quantization | Hugging Face Link                                                                 |
+|-------------------------------------|--------------|-----------------------------------------------------------------------------------|
+| `YuE-s1-7B-anneal-en-cot-int8`      | INT8         | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-en-cot-int8)     |
+| `YuE-s1-7B-anneal-en-icl-int8`      | INT8         | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-en-icl-int8)     |
+| `YuE-s1-7B-anneal-jp-kr-cot-int8`   | INT8         | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-jp-kr-cot-int8)  |
+| `YuE-s1-7B-anneal-jp-kr-icl-int8`   | INT8         | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-jp-kr-icl-int8)  |
+| `YuE-s1-7B-anneal-zh-cot-int8`      | INT8         | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-zh-cot-int8)     |
+| `YuE-s1-7B-anneal-zh-icl-int8`      | INT8         | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-zh-icl-int8)     |
+| `YuE-s2-1B-general-int8`            | INT8         | [Model Link](https://huggingface.co/Alissonerdx/YuE-s2-1B-general-int8)           |
+| `YuE-s1-7B-anneal-en-cot-nf4`       | NF4          | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-en-cot-nf4)      |
+| `YuE-s1-7B-anneal-en-icl-nf4`       | NF4          | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-en-icl-nf4)      |
+| `YuE-s1-7B-anneal-jp-kr-cot-nf4`    | NF4          | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-jp-kr-cot-nf4)   |
+| `YuE-s1-7B-anneal-jp-kr-icl-nf4`    | NF4          | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-jp-kr-icl-nf4)   |
+| `YuE-s1-7B-anneal-zh-cot-nf4`       | NF4          | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-zh-cot-nf4)      |
+| `YuE-s1-7B-anneal-zh-icl-nf4`       | NF4          | [Model Link](https://huggingface.co/Alissonerdx/YuE-s1-7B-anneal-zh-icl-nf4)      |
+
+## 💬 Support
+
+If you encounter any issues or have questions, feel free to open an issue on the **[YuE Interface GitHub repository](https://github.com/alisson-anjos/YuE-Interface)** or contact me via my [CivitAI profile](https://civitai.com/user/alissonerdx).
+
+## 🙏 Acknowledgements
+
+A special thanks to the developers of the official **[YuE repository](https://github.com/multimodal-art-projection/YuE)** for their incredible work and for making this project possible.
+
+---
+
+**Happy Music Generating! 🎶**
+
+---