Skip to content

Commit 65ade2b

Browse files
SWividSWivid
committed
v0.0.1 init commit, basic gui infer support
0 parents  commit 65ade2b

17 files changed

Lines changed: 1226 additions & 0 deletions

File tree

‎.github/workflows/publish-pypi.yaml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# GitHub recommends pinning actions to a commit SHA.
7+
# To get a newer version, you will need to update the SHA.
8+
# You can also reference a tag or branch, but the action may change without warning.
9+
10+
name: Upload Python Package
11+
12+
on:
13+
release:
14+
types: [published]
15+
16+
permissions:
17+
contents: read
18+
19+
jobs:
20+
release-build:
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- uses: actions/checkout@v4
25+
26+
- uses: actions/setup-python@v5
27+
with:
28+
python-version: "3.x"
29+
30+
- name: Build release distributions
31+
run: |
32+
# NOTE: put your own distribution build steps here.
33+
python -m pip install build
34+
python -m build
35+
36+
- name: Upload distributions
37+
uses: actions/upload-artifact@v4
38+
with:
39+
name: release-dists
40+
path: dist/
41+
42+
pypi-publish:
43+
runs-on: ubuntu-latest
44+
45+
needs:
46+
- release-build
47+
48+
permissions:
49+
# IMPORTANT: this permission is mandatory for trusted publishing
50+
id-token: write
51+
52+
# Dedicated environments with protections for publishing are strongly recommended.
53+
environment:
54+
name: pypi
55+
# OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
56+
# url: https://pypi.org/p/YOURPROJECT
57+
58+
steps:
59+
- name: Retrieve release distributions
60+
uses: actions/download-artifact@v4
61+
with:
62+
name: release-dists
63+
path: dist/
64+
65+
- name: Publish release distributions to PyPI
66+
uses: pypa/gh-action-pypi-publish@release/v1

‎.gitignore‎

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
# Customed
2+
results/
3+
4+
# Byte-compiled / optimized / DLL files
5+
__pycache__/
6+
*.py[codz]
7+
*$py.class
8+
9+
# C extensions
10+
*.so
11+
12+
# Distribution / packaging
13+
.Python
14+
build/
15+
develop-eggs/
16+
dist/
17+
downloads/
18+
eggs/
19+
.eggs/
20+
lib/
21+
lib64/
22+
parts/
23+
sdist/
24+
var/
25+
wheels/
26+
share/python-wheels/
27+
*.egg-info/
28+
.installed.cfg
29+
*.egg
30+
MANIFEST
31+
32+
# PyInstaller
33+
# Usually these files are written by a python script from a template
34+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
35+
*.manifest
36+
*.spec
37+
38+
# Installer logs
39+
pip-log.txt
40+
pip-delete-this-directory.txt
41+
42+
# Unit test / coverage reports
43+
htmlcov/
44+
.tox/
45+
.nox/
46+
.coverage
47+
.coverage.*
48+
.cache
49+
nosetests.xml
50+
coverage.xml
51+
*.cover
52+
*.py.cover
53+
.hypothesis/
54+
.pytest_cache/
55+
cover/
56+
57+
# Translations
58+
*.mo
59+
*.pot
60+
61+
# Django stuff:
62+
*.log
63+
local_settings.py
64+
db.sqlite3
65+
db.sqlite3-journal
66+
67+
# Flask stuff:
68+
instance/
69+
.webassets-cache
70+
71+
# Scrapy stuff:
72+
.scrapy
73+
74+
# Sphinx documentation
75+
docs/_build/
76+
77+
# PyBuilder
78+
.pybuilder/
79+
target/
80+
81+
# Jupyter Notebook
82+
.ipynb_checkpoints
83+
84+
# IPython
85+
profile_default/
86+
ipython_config.py
87+
88+
# pyenv
89+
# For a library or package, you might want to ignore these files since the code is
90+
# intended to run in multiple environments; otherwise, check them in:
91+
# .python-version
92+
93+
# pipenv
94+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
95+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
96+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
97+
# install all needed dependencies.
98+
#Pipfile.lock
99+
100+
# UV
101+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
102+
# This is especially recommended for binary packages to ensure reproducibility, and is more
103+
# commonly ignored for libraries.
104+
#uv.lock
105+
106+
# poetry
107+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
108+
# This is especially recommended for binary packages to ensure reproducibility, and is more
109+
# commonly ignored for libraries.
110+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
111+
#poetry.lock
112+
#poetry.toml
113+
114+
# pdm
115+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
116+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
117+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
118+
#pdm.lock
119+
#pdm.toml
120+
.pdm-python
121+
.pdm-build/
122+
123+
# pixi
124+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
125+
#pixi.lock
126+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
127+
# in the .venv directory. It is recommended not to include this directory in version control.
128+
.pixi
129+
130+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
131+
__pypackages__/
132+
133+
# Celery stuff
134+
celerybeat-schedule
135+
celerybeat.pid
136+
137+
# SageMath parsed files
138+
*.sage.py
139+
140+
# Environments
141+
.env
142+
.envrc
143+
.venv
144+
env/
145+
venv/
146+
ENV/
147+
env.bak/
148+
venv.bak/
149+
150+
# Spyder project settings
151+
.spyderproject
152+
.spyproject
153+
154+
# Rope project settings
155+
.ropeproject
156+
157+
# mkdocs documentation
158+
/site
159+
160+
# mypy
161+
.mypy_cache/
162+
.dmypy.json
163+
dmypy.json
164+
165+
# Pyre type checker
166+
.pyre/
167+
168+
# pytype static type analyzer
169+
.pytype/
170+
171+
# Cython debug symbols
172+
cython_debug/
173+
174+
# PyCharm
175+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
176+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
177+
# and can be added to the global gitignore or merged into this file. For a more nuclear
178+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
179+
#.idea/
180+
181+
# Abstra
182+
# Abstra is an AI-powered process automation framework.
183+
# Ignore directories containing user credentials, local state, and settings.
184+
# Learn more at https://abstra.io/docs
185+
.abstra/
186+
187+
# Visual Studio Code
188+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
189+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
190+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
191+
# you could uncomment the following to ignore the entire vscode folder
192+
# .vscode/
193+
194+
# Ruff stuff:
195+
.ruff_cache/
196+
197+
# PyPI configuration file
198+
.pypirc
199+
200+
# Cursor
201+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
202+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
203+
# refer to https://docs.cursor.com/context/ignore-files
204+
.cursorignore
205+
.cursorindexingignore
206+
207+
# Marimo
208+
marimo/_static/
209+
marimo/_lsp/
210+
__marimo__/

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Yushen CHEN
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Habibi-TTS
2+
3+
> Official code for "Habibi: Laying the Open-Source Foundation of Unified-Dialectal Arabic Speech Synthesis"
4+
5+
[![arXiv](https://img.shields.io/badge/Paper-2601.13802-b31b1b.svg?logo=arXiv&style=for-the-badge)](https://arxiv.org/abs/2601.13802)
6+
[![demo](https://img.shields.io/badge/Demo-Samples-orange.svg?logo=Github&style=for-the-badge)](https://swivid.github.io/Habibi/)
7+
![Python](https://img.shields.io/badge/Python-3.10%2B-3776AB?style=for-the-badge&logo=python&logoColor=white)
8+
[![lab](https://img.shields.io/badge/-X--LANCE-lightgrey?labelColor=grey&logo=leanpub&style=for-the-badge)](https://x-lance.sjtu.edu.cn/)
9+
[![lab](https://img.shields.io/badge/-SII-lightgrey?labelColor=grey&logo=leanpub&style=for-the-badge)](https://www.sii.edu.cn/)
10+
11+
[![hfspace](https://img.shields.io/badge/-Online%20Experience-yellow?labelColor=grey&logo=huggingface&style=for-the-badge)](https://huggingface.co/spaces/chenxie95/Habibi-TTS)
12+
[![hfspace](https://img.shields.io/badge/-Benchmark-lightgrey?labelColor=grey&logo=huggingface&style=for-the-badge)](https://huggingface.co/datasets/SWivid/Habibi)
13+
[![hfspace](https://img.shields.io/badge/-Model%20Suite-lightgrey?labelColor=grey&logo=huggingface&style=for-the-badge)](https://huggingface.co/SWivid/Habibi-TTS)
14+
15+
<div align=left>
16+
<img src="docs/assets/main.png" width="75%">
17+
</div>
18+
19+
20+
## Quick Start
21+
```bash
22+
# Install
23+
pip install habibi-tts
24+
25+
# Launch the GUI TTS interface
26+
habibi-tts_infer-gradio
27+
```
28+
29+
> [!IMPORTANT]
30+
> Read the F5-TTS documentation for (1) [Detailed installation guidance](https://github.com/SWivid/F5-TTS?tab=readme-ov-file#installation); (2) [Best practice for inference](https://github.com/SWivid/F5-TTS/tree/main/src/f5_tts/infer#inference); etc.
31+
32+
33+
## CLI Usage
34+
```bash
35+
# Single test with CLI
36+
# TODO
37+
```
38+
39+
40+
## Benchmarking
41+
```bash
42+
# TODO
43+
```
44+
45+
46+
## License
47+
All code is released under MIT License.
48+
The unified, SAU, and UAE models are licensed under CC-BY-NC-SA-4.0, restricted by [SADA](https://www.kaggle.com/datasets/sdaiancai/sada2022) and [Mixat](https://huggingface.co/datasets/sqrk/mixat-tri).
49+
The rest specialized models (ALG, EGY, IRQ, MAR, MSA) are released under Apache 2.0 license.

‎docs/assets/main.png‎

913 KB
Loading

‎pyproject.toml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[build-system]
2+
requires = ["setuptools >= 61.0", "setuptools-scm>=8.0"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "habibi-tts"
7+
version = "0.0.1"
8+
description = "Habibi: Laying the Open-Source Foundation of Unified-Dialectal Arabic Speech Synthesis"
9+
readme = "README.md"
10+
license = {text = "MIT License"}
11+
classifiers = [
12+
"License :: OSI Approved :: MIT License",
13+
"Operating System :: OS Independent",
14+
"Programming Language :: Python :: 3",
15+
]
16+
dependencies = [
17+
"f5-tts",
18+
"torch>=2.4.0, <2.9.0",
19+
]
20+
21+
[project.urls]
22+
Homepage = "https://github.com/SWivid/Habibi-TTS"
23+
24+
[project.scripts]
25+
"habibi-tts_infer-gradio" = "habibi_tts.infer.infer_gradio:main"

‎src/habibi_tts/assets/ALG.wav‎

287 KB
Binary file not shown.

‎src/habibi_tts/assets/EGY.mp3‎

122 KB
Binary file not shown.

‎src/habibi_tts/assets/Gulf.wav‎

189 KB
Binary file not shown.

‎src/habibi_tts/assets/Hijazi.wav‎

172 KB
Binary file not shown.

0 commit comments

Comments
 (0)