Metadata-Version: 2.1
Name: VoPho
Version: 0.0.11
Summary: An easy to use Multilingual phonemization meta-library
Author: ShoukanLabs.
Project-URL: homepage, https://github.com/ShoukanLabs/VoPho
Keywords: Phonemization,TTS,Multilingual
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ruphon
Requires-Dist: ruaccent==1.5.8
Requires-Dist: cn2an==0.5.22
Requires-Dist: colorama==0.4.6
Requires-Dist: termcolor==2.4.0
Requires-Dist: openphonemizer==0.1.2
Requires-Dist: unidic-lite==1.0.8
Requires-Dist: mecab-python3==1.0.9
Requires-Dist: cutlet==0.4.0
Requires-Dist: jieba==0.42.1
Requires-Dist: pypinyin==0.52.0
Requires-Dist: pythainlp==5.0.4
Requires-Dist: torch==2.2.0
Requires-Dist: langdetect==1.0.9
Requires-Dist: lingua-language-detector==2.0.2

# VoPho

VoPho is a phonemization meta-library designed to make multilingual phonemization fast, accessible, multilingual, and accurate!

## Installation

You can install VoPho via pip:

```bash
pip install VoPho
```

# Quick Start
Here's a quick example of how to use VoPho to phonemize multilingual text:

```python
from VoPho.engine import Phonemizer
from time import time

# Example input text in multiple languages
input_text = "hello, 你好は中国語でこんにちはと言う意味をしています。 Привет!"

# Instantiate the Phonemizer
engine = Phonemizer()

# Measure the time taken to phonemize
start = time()
output = engine.phonemize(input_text, output_dict=True)
end = time()
print(input_text)
engine.pretty_print(output)
print(f"Took - First: {end - start}")

# Measure the time taken for subsequent calls
start = time()
output = engine.phonemize(input_text, output_dict=True)
end = time()
print(input_text)
engine.pretty_print(output)
print(f"Took - Instantiated: {end - start}")

```

```
>>> OUTPUT: həlˈoʊ, ni˨˩˦hɑʊ˨˩˦ wa tɕɯɯgokɯ go de konnitɕiha to iɯ imi o ɕite imasɯ. prʲɪvʲ'et!
```

# Features
- Fast: Optimized for performance.
- Accessible: Easy to integrate and use.
- Multilingual: Supports a wide range of languages.
- Accurate: Provides precise phonemization.

# Supported Languages
| Language   | Supported | Verified Accuracy | Notes                          |
|------------|-----------|-------------------|--------------------------------|
| English    | Yes       | Yes               | Fully supported and verified   |
| Russian    | Yes       | Yes               | Fully supported and verified   |
| French     | Planned   | N/A               | Planned for future support     |
| German     | Planned   | N/A               | Planned for future support     |
| Spanish    | Planned   | N/A               | Planned for future support     |
| Italian    | Planned   | N/A               | Planned for future support     |
| Mandarin   | Yes       | Yes               | Fully supported and verified   |
| Japanese   | Yes       | Yes               | Fully supported and verified   |
| Korean     | Planned   | N/A               | Planned for future support     |
| Thai       | Yes       | No                | Supported, accuracy unverified |
| Arabic     | Planned   | N/A               | Planned for future support     |
| Persian    | Planned   | N/A               | Planned for future support     |


# License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/ShoukanLabs/VoPho/blob/main/LICENSE) file for details.
