Add SoulX-Podcast: TTS/SoulX-Podcast-1.7B/README.md

TTS/SoulX-Podcast-1.7B/README.md

@@ -0,0 +1,185 @@
+---
+license: apache-2.0
+language:
+  - en
+  - zh
+tags:
+  - text-to-speech
+---
+
+<div align="center">
+    <h1>
+    SoulX-Podcast
+    </h1>
+    <p>
+    Official inference code for <br>
+    <b><em>SoulX-Podcast: Towards Realistic Long-form Podcasts with Dialectal and Paralinguistic Diversity</em></b>
+    </p>
+    <p>
+    <!-- <img src="assets/XiaoHongShu_Logo.png" alt="Institution 4" style="width: 102px; height: 48px;"> -->
+    <img src="assets/SoulX-Podcast-log.jpg" alt="SoulX-Podcast_Logo" style="width: 200px; height: 68px;">
+    </p>
+    <p>
+    </p>
+    <a href="https://soul-ailab.github.io/soulx-podcast/"><img src="https://img.shields.io/badge/Demo-Page-lightgrey" alt="version"></a>
+    <a href="https://github.com/Soul-AILab/SoulX-Podcast"><img src='https://img.shields.io/badge/Github-Page-green' alt="Github"></a>
+    <a href="https://arxiv.org/pdf/2510.23541"><img src='https://img.shields.io/badge/Report-Github?label=Technical&color=red' alt="technical report"></a>
+    <a href="https://github.com/Soul-AILab/SoulX-Podcast"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Apache-2.0"></a>
+</div>
+
+
+<p align="center">
+   <h1>SoulX-Podcast: Towards Realistic Long-form Podcasts with Dialectal and Paralinguistic Diversity</h1>
+<p>
+
+##  Overview
+SoulX-Podcast is designed for podcast-style multi-turn, multi-speaker dialogic speech generation, while also achieving superior performance in the conventional monologue TTS task.
+
+To meet the higher naturalness demands of multi-turn spoken dialogue, SoulX-Podcast integrates a range of paralinguistic controls and supports both Mandarin and English, as well as several Chinese dialects, including Sichuanese, Henanese, and Cantonese, enabling more personalized podcast-style speech generation.
+
+
+## Key Features 🔥
+
+- **Long-form, multi-turn, multi-speaker dialogic speech generation**: SoulX-Podcast excels in generating high-quality, natural-sounding dialogic speech for multi-turn, multi-speaker scenarios.
+
+- **Cross-dialectal, zero-shot voice cloning**: SoulX-Podcast supports zero-shot voice cloning across different Chinese dialects, enabling the generation of high-quality, personalized speech in any of the supported dialects.
+
+- **Paralinguistic controls**: SoulX-Podcast supports a variety of paralinguistic events, as as ***laugher*** and ***sighs*** to enhance the realism of synthesized results.
+
+<table align="center">
+  <tr>
+    <td align="center"><br><img src="assets/performance_radar.png" width="80%" /></td>
+  </tr>
+</table>
+
+## Install
+
+### Clone and Install
+Here are instructions for installing on Linux.
+- Clone the repo
+```
+git clone git@github.com:Soul-AILab/SoulX-Podcast.git
+cd SoulX-Podcast
+```
+- Install Conda: please see https://docs.conda.io/en/latest/miniconda.html
+- Create Conda env:
+```
+conda create -n soulxpodcast -y python=3.11
+conda activate soulxpodcast
+pip install -r requirements.txt
+# If you are in mainland China, you can set the mirror as follows:
+pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/ --trusted-host=mirrors.aliyun.com
+```
+
+### Model Download
+
+```sh
+pip install -U huggingface_hub
+
+# base model
+huggingface-cli download --resume-download Soul-AILab/SoulX-Podcast-1.7B --local-dir pretrained_models/SoulX-Podcast-1.7B
+
+# dialectal model
+huggingface-cli download --resume-download Soul-AILab/SoulX-Podcast-1.7B-dialect --local-dir pretrained_models/SoulX-Podcast-1.7B-dialect
+```
+
+
+Download via python:
+```python
+from huggingface_hub import snapshot_download
+
+# base model
+snapshot_download("Soul-AILab/SoulX-Podcast-1.7B", local_dir="pretrained_models/SoulX-Podcast-1.7B") 
+
+# dialectal model
+snapshot_download("Soul-AILab/SoulX-Podcast-1.7B-dialect", local_dir="pretrained_models/SoulX-Podcast-1.7B-dialect") 
+
+```
+
+Download via git clone:
+```sh
+mkdir -p pretrained_models
+
+# Make sure you have git-lfs installed (https://git-lfs.com)
+git lfs install
+
+# base model
+git clone https://huggingface.co/Soul-AILab/SoulX-Podcast-1.7B pretrained_models/SoulX-Podcast-1.7B
+
+# dialectal model
+git clone https://huggingface.co/Soul-AILab/SoulX-Podcast-1.7B-dialect pretrained_models/SoulX-Podcast-1.7B-dialect
+```
+
+
+### Basic Usage
+
+You can simply run the demo with the following commands:
+``` sh
+# dialectal inference
+bash example/infer_dialogue.sh
+```
+
+## TODOs
+- [x] Add example scripts for monologue TTS.
+- [x] Publish the [technical report](https://arxiv.org/pdf/2510.23541).
+- [x] Develop a WebUI for easy inference.
+- [x] Deploy an online demo on Hugging Face Spaces.
+- [x] Dockerize the project with vLLM support.
+- [ ] Add support for streaming inference.
+
+## Citation
+
+```bibtex
+@misc{SoulXPodcast,
+  title        = {SoulX-Podcast: Towards Realistic Long-form Podcasts with Dialectal and Paralinguistic Diversity},
+  author       = {Hanke Xie and Haopeng Lin and Wenxiao Cao and Dake Guo and Wenjie Tian and Jun Wu and Hanlin Wen and Ruixuan Shang and Hongmei Liu and Zhiqi Jiang and Yuepeng Jiang and Wenxi Chen and Ruiqi Yan and Jiale Qian and Yichao Yan and Shunshun Yin and Ming Tao and Xie Chen and Lei Xie and Xinsheng Wang},
+  year         = {2025},
+  archivePrefix={arXiv},
+  url          = {https://arxiv.org/abs/2510.23541}
+}
+
+```
+
+## License
+
+We use the Apache 2.0 license. Researchers and developers are free to use the codes and model weights of our SoulX-Podcast. Check the license at [LICENSE](LICENSE) for more details.
+
+
+## Acknowledge
+- This repo benefits from [FlashCosyVoice](https://github.com/xingchensong/FlashCosyVoice/tree/main)
+
+
+##  Usage Disclaimer
+This project provides a speech synthesis model for podcast generation capable of zero-shot voice cloning, intended for academic research, educational purposes, and legitimate applications, such as personalized speech synthesis, assistive technologies, and linguistic research.
+
+Please note:
+
+Do not use this model for unauthorized voice cloning, impersonation, fraud, scams, deepfakes, or any illegal activities.
+
+Ensure compliance with local laws and regulations when using this model and uphold ethical standards.
+
+The developers assume no liability for any misuse of this model.
+
+We advocate for the responsible development and use of AI and encourage the community to uphold safety and ethical principles in AI research and applications. If you have any concerns regarding ethics or misuse, please contact us.
+
+
+## Contact Us
+If you are interested in leaving a message to our work, feel free to email hkxie@mail.nwpu.edu.cn or linhaopeng@soulapp.cn or lxie@nwpu.edu.cn or wangxinsheng@soulapp.cn
+
+You’re welcome to join our WeChat group for technical discussions, updates.
+<p align="center">
+  <!-- <em>Due to group limits, if you can't scan the QR code, please add my WeChat for group access  -->
+      <!-- : <strong>Tiamo James</strong></em> -->
+  <br>
+  <span style="display: inline-block; margin-right: 10px;">
+    <img src="assets/wechat2.jpg" width="300" alt="WeChat Group QR Code"/>
+  </span>
+  <!-- <span style="display: inline-block;">
+    <img src="assets/wechat_tiamo.jpg" width="300" alt="WeChat QR Code"/>
+  </span> -->
+</p>
+
+<!-- <p align="center">
+    <img src="src/figs/npu@aslp.jpeg" width="500"/>
+</p -->
+<!-- <img src="assets/wechat.jpg -->