goruut

README

Goruut

A tokenizer, text cleaner, and IPA phonemizer/dephonemizer/transphonemizer for several human languages.

Try it online

It is possible to try this software live at hashtron.cloud or at hugging face.

Features

• Phone set: IPA
• Supported languages: 139
• Processing speed: fast
• Phone tokens: yes
• Syllable tokens: no
• Word tokens: yes
• Punctuation preservation: yes
• Stressed phones: yes
• Tonal phones: yes, 5 tones (˥ ˦ ˧ ˨ ˩)
• Tie: no

Installation

go install github.com/neurlang/goruut/cmd/goruut@latest

Docker Compose installation

Clone the repo and then run in root directory this command:

sudo docker compose up -d --force-recreate --build

Supported Languages

• Afrikaans
• Albanian
• Amharic
• Arabic
• Aragonese
• Armenian
• Assamese
• Azerbaijani
• Bashkir
• Basque
• Belarusian
• Bengali
• Bengali Dhaka
• Bengali Rahr
• Bishnupriya Manipuri
• Bosnian
• Bulgarian
• Burmese
• Cantonese
• Catalan
• Cebuano
• Chechen
• Cherokee
• Chichewa
• Chinese Mandarin
• Chuvash
• Croatian
• Czech
• Danish
• Dutch
• Dzongkha
• English
• English American
• English British
• Esperanto
• Estonian
• Farsi
• Finnish
• French
• Gaelic Irish
• Gaelic Scottish
• Galician
• Georgian
• German
• Greek
• Greenlandic
• Guarani
• Gujarati
• Haitian Creole
• Hausa
• Hawaiian
• Hebrew
• Hindi
• Hungarian
• Icelandic
• Ido
• Indonesian
• Interlingua
• Isan
• Italian
• Jamaican
• Japanese
• Javanese
• Kannada
• Kazakh
• Khmer Central
• Kiche
• Konkani
• Korean
• Kurdish
• Kyrgyz
• Lang Belta
• Lao
• Latgalian
• Latin Classical
• Latin Ecclesiastical
• Latvian
• Lingua Franca Nova
• Lithuanian
• Lojban
• Lule Saami
• Luxembourgish
• Macedonian
• Malayalam
• Malay Arab
• Malay Latin
• Maltese
• Maori
• Marathi
• Minnan Hokkien
• Minnan Taiwanese
• Mongolian
• Nahuatl Central
• Nahuatl Classical
• Nahuatl Mecayapan
• Nahuatl Tetelcingo
• Nepali
• Nogai
• Norwegian
• Oromo
• Papiamento
• Pashto
• Polish
• Portuguese
• Punjabi
• Quechua
• Quenya
• Romanian
• Russian
• Serbian
• Setswana
• Shan Tai Yai
• Sindarin
• Sindhi
• Sinhala
• Slovak
• Slovenian
• Spanish
• Swahili
• Swedish
• Tagalog
• Tamil
• Tatar
• Telugu
• Thai
• Tibetan
• Turkish
• Turkmen
• Ukrainian
• Urdu
• Uyghur
• Uzbek
• Vietnamese Central
• Vietnamese Northern
• Vietnamese Southern
• Welsh North
• Welsh South
• Yoruba
• Zulu

The goal to support all of voice2json's languages has been met. However, please add a language if you have the necessary data.

Listening to the generated speech

There are currently 3 target languages (IPA flavors). They are:

• IPA - Copy the output into ipa-reader.xyz and pick a correct language voice
• Espeak - Copy the output into espeak. For example czech: espeak -v cs "[[ru:Zovi: ku:n^]]"
• Antvaset - Copy the output into antvaset.com and pick a correct language voice

Dependencies

See go.mod file for an up-to-date list of depended-on projects. Minimum supported version of golang is go 1.19 (project uses type parameters).

Numbers, Dates, and More

Unsupported. Please write them using words.

Command-Line Usage

To start, launch the server using the example config (in configs dir):

./goruut -configfile configs/config.json

This will launch the server at a specific http port. You should see the port which you specified in the config file:

INFO[0000] Binding port: 18080

Then you can run queries:

POST http://127.0.0.1:18080/tts/phonemize/sentence

{
	"Language": "Czech",
	"Sentence": "jsem supr"	
}

Output should be:

{
	"Words": [
		{
			"Linguistic": "jsem",
			"Phonetic": "jsɛm"
		},
		{
			"Linguistic": "supr",
			"Phonetic": "supr"
		}
	]
}

Intended Audience

goruut is useful for transforming raw text into phonetic pronunciations, similar to phonemizer. Unlike phonemizer, goruut looks up words in a pre-built lexicon (pronunciation dictionary) or guesses word pronunciations with a pre-trained transformer-based grapheme-to-phoneme model.

Discord Invite

https://discord.gg/HWZ47pCBaH